diff options
Diffstat (limited to 'doc-tool/src/dotty/tools/dottydoc/staticsite')
3 files changed, 137 insertions, 121 deletions
diff --git a/doc-tool/src/dotty/tools/dottydoc/staticsite/LiquidTemplate.scala b/doc-tool/src/dotty/tools/dottydoc/staticsite/LiquidTemplate.scala index a92e5d48e..a86a5bb54 100644 --- a/doc-tool/src/dotty/tools/dottydoc/staticsite/LiquidTemplate.scala +++ b/doc-tool/src/dotty/tools/dottydoc/staticsite/LiquidTemplate.scala @@ -6,18 +6,15 @@ import dotc.config.Printers.dottydoc case class LiquidTemplate(contents: String) extends ResourceFinder { import scala.collection.JavaConverters._ - import liqp.{ Template, TemplateContext } - import liqp.nodes.LNode - import liqp.tags.Tag + import liqp.Template import liqp.filters.Filter import liqp.parser.Flavor.JEKYLL import java.util.{ HashMap, Map => JMap } import filters._ + import tags._ /** Register filters to static container */ Filter.registerFilter(new Reverse) - Filter.registerFilter(new RenderReference) - Filter.registerFilter(new RenderLink) // For some reason, liqp rejects a straight conversion using `.asJava` private def toJavaMap(map: Map[String, AnyRef]): HashMap[String, Object] = @@ -29,29 +26,6 @@ case class LiquidTemplate(contents: String) extends ResourceFinder { def render(params: Map[String, AnyRef], includes: Map[String, String]): String = Template.parse(contents, JEKYLL) .`with`(ResourceInclude(params, includes)) + .`with`(RenderReference(params)) .render(toJavaMap(params)) - - private case class ResourceInclude(params: Map[String, AnyRef], includes: Map[String, String]) - extends Tag("include") { - val DefaultExtension = ".html" - - override def render(ctx: TemplateContext, nodes: LNode*): AnyRef = { - val origInclude = asString(nodes(0).render(ctx)) - val incResource = origInclude match { - case fileWithExt if fileWithExt.indexOf('.') > 0 => fileWithExt - case file => file + DefaultExtension - } - - includes - .get(incResource) - .map { template => - if (nodes.length > 1) ctx.put(origInclude, nodes(1).render(ctx)) - LiquidTemplate(template).render(Map.empty ++ ctx.getVariables.asScala, includes) - } - .getOrElse { - /*dottydoc.*/println(s"couldn't find include file '$origInclude'") - "" - } - } - } } diff --git a/doc-tool/src/dotty/tools/dottydoc/staticsite/filters.scala b/doc-tool/src/dotty/tools/dottydoc/staticsite/filters.scala index a4662e735..2239f5a50 100644 --- a/doc-tool/src/dotty/tools/dottydoc/staticsite/filters.scala +++ b/doc-tool/src/dotty/tools/dottydoc/staticsite/filters.scala @@ -2,7 +2,6 @@ package dotty.tools package dottydoc package staticsite -import model.references._ import java.util.{ Map => JMap } import liqp.filters.Filter @@ -24,95 +23,4 @@ object filters { else array.reverse } } - - /** Renders a `Reference` as HTML. Example: - * - * ```html - * {{ ref | renderRef }} - * ``` - * - * where `ref` is: - * - * ```scala - * TypeReference("Seq", MaterializedLink("Seq", "../../scala/collection/Seq.html"), Nil) - * ``` - * - * will render: - * - * ```html - * <a href="../../scala/collection/Seq.html">Seq</a> - * <span class="no-left no-right">[</span> - * A - * <span class="no-left">]</span> - * ``` - */ - final class RenderReference extends Filter("renderRef") { - // might need to be rewritten to be stack safe - private def renderReference(ref: Reference): String = ref match { - case TypeReference(_, tpeLink, paramLinks) => { - if (paramLinks.nonEmpty) { - s"""|${renderLink(tpeLink)} - |<span class="no-left no-right">[</span> - |${ paramLinks.map(renderReference).mkString("""<span class="">, </span>""") } - |<span class="no-left">]</span>""".stripMargin - } - else renderLink(tpeLink) - } - - case AndOrTypeReference(left, sep, right) => - s"""${renderReference(left)}<span class="and-or-separator"> $sep </span>${renderReference(right)}""" - - case FunctionReference(args, returnValue) => { - val params = - if (args.isEmpty) "<span>() => </span>" - else if (args.tail.isEmpty) renderReference(args.head) + """<span class="right-arrow"> => </span>""" - else args.map(renderReference).mkString("<span>(</span>", "<span>, </span>", "<span>) => </span>") - - params + renderReference(returnValue) - } - - case TupleReference(args) => - s"""|<span class="no-right">(</span> - |${ args.map(renderReference).mkString("<span>, </span>") } - |<span class="no-left">)</span>""".stripMargin - - case BoundsReference(low, high) => - s"""${ renderReference(low) }<span class="bounds"> <: </span>${ renderReference(high) }""" - - case NamedReference(title, _, _, _) => - /*dottydoc.*/println(s"received illegal named reference in rendering: $ref") - title - - case ConstantReference(title) => title - } - - override def apply(value: Any, params: AnyRef*): AnyRef = value match { - case value: JMap[String, _] @unchecked => - val ref = value.get("scala").asInstanceOf[Reference] - if (ref ne null) renderReference(ref) - else null - case _ => - /*dottydoc.*/println(s"couldn't render: '$value'") - null - } - } - - /** Renders a `MaterializableLink` into a HTML anchor tag. If the link is - * `NoLink` it will just return a string with the link's title. - */ - final class RenderLink extends Filter("renderLink") { - override def apply(value: Any, params: AnyRef*): AnyRef = value match { - case value: JMap[String, _] @unchecked => - renderLink(value.get("scala").asInstanceOf[MaterializableLink]) - case _ => - /*dottydoc.*/println(s"couldn't render: '$value'") - null - } - } - - private[this] def renderLink(link: MaterializableLink): String = link match { - case MaterializedLink(title, target) => - s"""<a href="$target">$title</a>""" - case _ => link.title - } } diff --git a/doc-tool/src/dotty/tools/dottydoc/staticsite/tags.scala b/doc-tool/src/dotty/tools/dottydoc/staticsite/tags.scala new file mode 100644 index 000000000..868e28bce --- /dev/null +++ b/doc-tool/src/dotty/tools/dottydoc/staticsite/tags.scala @@ -0,0 +1,134 @@ +package dotty.tools +package dottydoc +package staticsite + +import model.references._ + +import liqp.tags.Tag +import liqp.TemplateContext +import liqp.nodes.LNode + +import java.util.{ Map => JMap } + +object tags { + + sealed trait ParamConverter { + def params: Map[String, AnyRef] + + val baseurl: String = + params.get("site").flatMap { + case map: JMap[String, String] @unchecked => + Some(map.get("baseurl")) + case _ => + None + } + .getOrElse { + /*dottydoc.*/println(s"missing `baseurl` in: $params") + "" + } + } + + /** Renders a `MaterializableLink` into a HTML anchor tag. If the link is + * `NoLink` it will just return a string with the link's title. + */ + final case class RenderLink(params: Map[String, AnyRef]) extends Tag("renderLink") with ParamConverter { + override def render(ctx: TemplateContext, nodes: LNode*): AnyRef = nodes(0).render(ctx) match { + case map: JMap[String, AnyRef] @unchecked => + val link = map.get("scala") + if (link.isInstanceOf[MaterializableLink] && (link ne null)) + renderLink(baseurl, link.asInstanceOf[MaterializableLink]) + else if (link eq null) + null // Option[Reference] was None + else { + /*dottydoc.*/println(s"illegal argument: $link, to `renderLink` function") + null + } + case _ => null + } + } + + + private[this] def renderLink(baseurl: String, link: MaterializableLink): String = link match { + case MaterializedLink(title, target) => + s"""<a href="$baseurl/api/$target">$title</a>""" + case _ => link.title + } + + final case class RenderReference(params: Map[String, AnyRef]) + extends Tag("renderRef") with ParamConverter { + + private def renderReference(ref: Reference): String = ref match { + case TypeReference(_, tpeLink, paramLinks) => { + if (paramLinks.nonEmpty) { + s"""|${renderLink(baseurl, tpeLink)} + |<span class="no-left no-right">[</span> + |${ paramLinks.map(renderReference).mkString("""<span class="">, </span>""") } + |<span class="no-left">]</span>""".stripMargin + } + else renderLink(baseurl, tpeLink) + } + + case AndOrTypeReference(left, sep, right) => + s"""${renderReference(left)}<span class="and-or-separator"> $sep </span>${renderReference(right)}""" + + case FunctionReference(args, returnValue) => { + val params = + if (args.isEmpty) "<span>() => </span>" + else if (args.tail.isEmpty) renderReference(args.head) + """<span class="right-arrow"> => </span>""" + else args.map(renderReference).mkString("<span>(</span>", "<span>, </span>", "<span>) => </span>") + + params + renderReference(returnValue) + } + + case TupleReference(args) => + s"""|<span class="no-right">(</span> + |${ args.map(renderReference).mkString("<span>, </span>") } + |<span class="no-left">)</span>""".stripMargin + + case BoundsReference(low, high) => + s"""${ renderReference(low) }<span class="bounds"> <: </span>${ renderReference(high) }""" + + case NamedReference(title, _, _, _) => + /*dottydoc.*/println(s"received illegal named reference in rendering: $ref") + title + + case ConstantReference(title) => title + } + override def render(ctx: TemplateContext, nodes: LNode*): AnyRef = nodes(0).render(ctx) match { + case map: JMap[String, AnyRef] @unchecked => + val ref = map.get("scala") + if (ref.isInstanceOf[Reference] && (ref ne null)) renderReference(ref.asInstanceOf[Reference]) + else if (ref eq null) null // Option[Reference] was None + else { + /*dottydoc.*/println(s"illegal argument: $ref, to `renderRef` function") + null + } + case _ => null + } + } + + case class ResourceInclude(params: Map[String, AnyRef], includes: Map[String, String]) + extends Tag("include") { + import scala.collection.JavaConverters._ + val DefaultExtension = ".html" + + override def render(ctx: TemplateContext, nodes: LNode*): AnyRef = { + val origInclude = asString(nodes(0).render(ctx)) + val incResource = origInclude match { + case fileWithExt if fileWithExt.indexOf('.') > 0 => fileWithExt + case file => file + DefaultExtension + } + + includes + .get(incResource) + .map { template => + if (nodes.length > 1) ctx.put(origInclude, nodes(1).render(ctx)) + LiquidTemplate(template).render(Map.empty ++ ctx.getVariables.asScala, includes) + } + .getOrElse { + /*dottydoc.*/println(s"couldn't find include file '$origInclude'") + "" + } + } + } +} |