/
KorteJavadocRenderer.kt
200 lines (178 loc) · 8.99 KB
/
KorteJavadocRenderer.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
package org.jetbrains.dokka.javadoc.renderer
import com.soywiz.korte.*
import org.jetbrains.dokka.javadoc.location.JavadocLocationProvider
import org.jetbrains.dokka.javadoc.pages.*
import org.jetbrains.dokka.javadoc.renderer.JavadocContentToHtmlTranslator.Companion.buildLink
import org.jetbrains.dokka.javadoc.toNormalized
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.renderers.OutputWriter
import org.jetbrains.dokka.base.resolvers.local.LocationProvider
import org.jetbrains.dokka.javadoc.JavadocPlugin
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.plugability.query
import org.jetbrains.dokka.plugability.querySingle
import org.jetbrains.dokka.renderers.Renderer
import org.jetbrains.kotlin.utils.addToStdlib.safeAs
import java.time.LocalDate
typealias TemplateMap = Map<String, Any?>
class KorteJavadocRenderer(val context: DokkaContext, resourceDir: String) :
Renderer {
private val outputWriter: OutputWriter = context.plugin<DokkaBase>().querySingle { outputWriter }
private lateinit var locationProvider: JavadocLocationProvider
private val registeredPreprocessors = context.plugin<JavadocPlugin>().query { javadocPreprocessors }
private val contentToHtmlTranslator by lazy {
JavadocContentToHtmlTranslator(locationProvider, context)
}
private val contentToTemplateMapTranslator by lazy {
JavadocContentToTemplateMapTranslator(locationProvider, context)
}
override fun render(root: RootPageNode) = root.let { registeredPreprocessors.fold(root) { r, t -> t.invoke(r) } }.let { newRoot ->
locationProvider = context.plugin<JavadocPlugin>().querySingle { locationProviderFactory }.getLocationProvider(newRoot) as JavadocLocationProvider
runBlocking(Dispatchers.IO) {
renderPage(newRoot)
SearchScriptsCreator(locationProvider).invoke(newRoot).forEach { renderSpecificPage(it, "") }
}
}
private fun templateForNode(node: JavadocPageNode) = when (node) {
is JavadocModulePageNode,
is JavadocPackagePageNode -> "tabPage.korte"
is JavadocClasslikePageNode -> "class.korte"
is AllClassesPage -> "listPage.korte"
is TreeViewPage -> "treePage.korte"
is IndexPage -> "indexPage.korte"
is DeprecatedPage -> "deprecated.korte"
else -> ""
}
private fun CoroutineScope.renderPage(node: PageNode, path: String = "") {
when(node){
is JavadocModulePageNode -> renderModulePageNode(node)
is JavadocPageNode -> renderJavadocPageNode(node)
is RendererSpecificPage -> renderSpecificPage(node, path)
}
}
private fun CoroutineScope.renderModulePageNode(node: JavadocModulePageNode) {
val link = "."
val name = "index"
val contentMap = contentToTemplateMapTranslator.templateMapForPageNode(node)
writeFromTemplate(outputWriter, "$link/$name".toNormalized(), "tabPage.korte", contentMap.toList())
node.children.forEach { renderPage(it, link) }
}
private fun CoroutineScope.renderJavadocPageNode(node: JavadocPageNode) {
val link = locationProvider.resolve(node, skipExtension = true)
val contentMap = contentToTemplateMapTranslator.templateMapForPageNode(node)
writeFromTemplate(outputWriter, link, templateForNode(node), contentMap.toList())
node.children.forEach { renderPage(it, link.toNormalized()) }
}
private fun CoroutineScope.renderSpecificPage(node: RendererSpecificPage, path: String) = launch {
when (val strategy = node.strategy) {
is RenderingStrategy.Copy -> outputWriter.writeResources(strategy.from, "")
is RenderingStrategy.Write -> outputWriter.writeHtml(node.name, strategy.text)
is RenderingStrategy.Callback -> outputWriter.writeResources(
path,
strategy.instructions(this@KorteJavadocRenderer, node)
)
RenderingStrategy.DoNothing -> Unit
}
node.children.forEach { renderPage(it, locationProvider.resolve(node, skipExtension = true).toNormalized()) }
}
private fun Pair<String, String>.pairToTag() =
"""<th class="colFirst" scope="row">${first}</th><td class="colLast">${second}</td>"""
private fun DRI.toLink(context: PageNode? = null) = locationProvider.resolve(this, emptySet(), context)
private suspend fun OutputWriter.writeHtml(path: String, text: String) = write(path, text, "")
private fun CoroutineScope.writeFromTemplate(
writer: OutputWriter,
path: String,
template: String,
args: List<Pair<String, *>>
) = launch {
val tmp = templateRenderer.render(template, *(args.toTypedArray()))
writer.writeHtml("$path.html", tmp)
}
private fun getTemplateConfig() = TemplateConfig().also { config ->
listOf(
TeFunction("curDate") { LocalDate.now() },
TeFunction("jQueryVersion") { "3.1" },
TeFunction("jQueryMigrateVersion") { "1.2.1" },
TeFunction("rowColor") { args -> if ((args.first() as Int) % 2 == 0) "altColor" else "rowColor" },
TeFunction("h1Title") { args -> if ((args.first() as? String) == "package") "title=\"Package\" " else "" },
TeFunction("createTabRow") { args ->
val (link, doc) = args.first() as RowJavadocListEntry
val contextRoot = args[1] as PageNode?
(buildLink(
locationProvider.resolve(link, contextRoot),
link.name
) to contentToHtmlTranslator.htmlForContentNodes(doc, contextRoot)).pairToTag().trim()
},
TeFunction("createListRow") { args ->
val link = args.first() as LinkJavadocListEntry
val contextRoot = args[1] as PageNode?
buildLink(
locationProvider.resolve(link, contextRoot),
link.name
)
},
TeFunction("createPackageHierarchy") { args ->
val list = args.first() as List<JavadocPackagePageNode>
list.mapIndexed { i, p ->
val content = if (i + 1 == list.size) "" else ", "
val name = p.name
"<li><a href=\"$name/package-tree.html\">$name</a>$content</li>"
}.joinToString("\n")
},
TeFunction("renderInheritanceGraph") { args ->
val rootNodes = args.first() as List<TreeViewPage.InheritanceNode>
fun drawRec(node: TreeViewPage.InheritanceNode): String =
"<li class=\"circle\">" + node.dri.let { dri ->
listOfNotNull(
dri.packageName,
dri.classNames
).joinToString(".") + node.interfaces.takeUnless { node.isInterface || it.isEmpty() }
?.let {
" implements " + it.joinToString(", ") { n ->
listOfNotNull(
n.packageName,
n.toLink()?.let{ buildLink(it, n.classNames.orEmpty()) } ?: n
).joinToString(".")
}
}.orEmpty()
} + node.children.filterNot { it.isInterface }.takeUnless { it.isEmpty() }?.let {
"<ul>" + it.joinToString("\n", transform = ::drawRec) + "</ul>"
}.orEmpty() + "</li>"
rootNodes.joinToString { drawRec(it) }
},
Filter("length") { subject.dynamicLength() },
TeFunction("hasAnyDescription") { args ->
args.first().safeAs<List<HashMap<String, String>>>()
?.any { it["description"]?.trim()?.isNotEmpty() ?: false }
}
).forEach {
when (it) {
is TeFunction -> config.register(it)
is Filter -> config.register(it)
is Tag -> config.register(it)
}
}
}
private val config = getTemplateConfig()
private val templateRenderer = Templates(
ResourceTemplateProvider(
resourceDir
), config = config, cache = true
)
private class ResourceTemplateProvider(val basePath: String) : TemplateProvider {
override suspend fun get(template: String): String =
javaClass.classLoader.getResourceAsStream("$basePath/$template")?.use { stream ->
stream.bufferedReader()
.lines()
.toArray()
.joinToString("\n")
} ?: throw IllegalStateException("Template not found: $basePath/$template")
}
}