pekko/project/ParadoxSupport.scala
Arnout Engelen abbbfb5b54
Use sbt-paradox-apidoc plugin (#26660)
Instead of using custom code here. Checked with 'meld' that the result
is the same, except for problems that were already there (filed #26659).
2019-04-03 13:14:27 +02:00

80 lines
3.3 KiB
Scala

/*
* Copyright (C) 2016-2019 Lightbend Inc. <https://www.lightbend.com>
*/
package akka
import java.io.{File, FileNotFoundException}
import com.lightbend.paradox.markdown._
import com.lightbend.paradox.sbt.ParadoxPlugin.autoImport._
import org.pegdown.Printer
import org.pegdown.ast._
import sbt.Keys._
import sbt._
import scala.io.{Codec, Source}
import scala.collection.JavaConverters._
object ParadoxSupport {
val paradoxWithCustomDirectives = Seq(
paradoxDirectives ++= Def.taskDyn {
val log = streams.value.log
val classpath = (fullClasspath in Compile).value.files.map(_.toURI.toURL).toArray
val classloader = new java.net.URLClassLoader(classpath, this.getClass().getClassLoader())
import _root_.io.github.classgraph.ClassGraph
lazy val scanner = new ClassGraph()
.whitelistPackages("akka")
.addClassLoader(classloader)
.scan()
val allClasses = scanner.getAllClasses.getNames.asScala.toVector
Def.task { Seq(
{ context: Writer.Context =>
new SignatureDirective(context.location.tree.label, context.properties, msg => log.warn(msg))
},
)}
}.value
)
class SignatureDirective(page: Page, variables: Map[String, String], logWarn: String => Unit) extends LeafBlockDirective("signature") {
def render(node: DirectiveNode, visitor: Visitor, printer: Printer): Unit =
try {
val labels = node.attributes.values("identifier").asScala.map(_.toLowerCase())
val source = node.source match {
case direct: DirectiveNode.Source.Direct => direct.value
case _ => sys.error("Source references are not supported")
}
val file =
if (source startsWith "/") {
// snip.build.base_dir defined by Paradox
val base = new File(PropertyUrl("snip.build.base_dir", variables.get).base.trim)
new File(base, source)
} else new File(page.file.getParentFile, source)
val Signature = """\s*((def|val|type) (\w+)(?=[:(\[]).*)(\s+\=.*)""".r // stupid approximation to match a signature
//println(s"Looking for signature regex '$Signature'")
val text =
Source.fromFile(file)(Codec.UTF8).getLines.collect {
case line@Signature(signature, kind, l, definition) if labels contains l.replaceAll("Mat$", "").toLowerCase() =>
//println(s"Found label '$l' with sig '$full' in line $line")
if (kind == "type") signature + definition
else signature
}.mkString("\n")
if (text.trim.isEmpty) {
logWarn(
s"Did not find any signatures with one of those names [${labels.mkString(", ")}] in ${node.source} " +
s"(was referenced from [${page.path}])")
new HtmlBlockNode(s"""<div style="color: red;">[Broken signature inclusion [${labels.mkString(", ")}] to [${node.source}]</div>""").accept(visitor)
} else {
val lang = Option(node.attributes.value("type")).getOrElse(Snippet.language(file))
new VerbatimNode(text, lang).accept(visitor)
}
} catch {
case e: FileNotFoundException =>
throw new SnipDirective.LinkException(s"Unknown snippet [${e.getMessage}] referenced from [${page.path}]")
}
}
}