/
htmlPreprocessors.kt
184 lines (165 loc) · 7.93 KB
/
htmlPreprocessors.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
package org.jetbrains.dokka.javadoc.pages
import org.jetbrains.dokka.base.renderers.sourceSets
import org.jetbrains.dokka.base.transformers.documentables.deprecatedAnnotation
import org.jetbrains.dokka.base.transformers.documentables.isDeprecated
import org.jetbrains.dokka.base.transformers.documentables.isException
import org.jetbrains.dokka.model.BooleanValue
import org.jetbrains.dokka.model.Documentable
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.transformers.pages.PageTransformer
object ResourcesInstaller : PageTransformer {
override fun invoke(input: RootPageNode): RootPageNode = input.modified(
children = input.children +
RendererSpecificResourcePage(
"resourcePack",
emptyList(),
RenderingStrategy.Copy("/static_res")
)
)
}
object TreeViewInstaller : PageTransformer {
override fun invoke(input: RootPageNode): RootPageNode = install(input, input) as RootPageNode
private fun install(node: PageNode, root: RootPageNode): PageNode = when (node) {
is JavadocModulePageNode -> installOverviewTreeNode(node, root)
is JavadocPackagePageNode -> installPackageTreeNode(node, root)
else -> node
}
private fun installOverviewTreeNode(node: JavadocModulePageNode, root: RootPageNode): JavadocModulePageNode {
val overviewTree = TreeViewPage(
name = "Class Hierarchy",
packages = node.children<JavadocPackagePageNode>().map { installPackageTreeNode(it, root) },
classes = null,
dri = node.dri,
documentables = node.documentables,
root = root
)
val nodeChildren = node.children.map { childNode ->
install(
childNode,
root
)
}
return node.modified(children = nodeChildren + overviewTree) as JavadocModulePageNode
}
private fun installPackageTreeNode(node: JavadocPackagePageNode, root: RootPageNode): JavadocPackagePageNode {
val packageTree = TreeViewPage(
name = node.name,
packages = null,
classes = node.children.filterIsInstance<JavadocClasslikePageNode>(),
dri = node.dri,
documentables = node.documentables,
root = root
)
return node.modified(children = node.children + packageTree) as JavadocPackagePageNode
}
}
object AllClassesPageInstaller : PageTransformer {
override fun invoke(input: RootPageNode): RootPageNode {
val classes = (input as JavadocModulePageNode).children.filterIsInstance<JavadocPackagePageNode>().flatMap {
it.children.filterIsInstance<JavadocClasslikePageNode>()
}
return input.modified(children = input.children + AllClassesPage(classes))
}
}
object IndexGenerator : PageTransformer {
override fun invoke(input: RootPageNode): RootPageNode {
val elements = HashMap<Char, MutableSet<NavigableJavadocNode>>()
(input as JavadocModulePageNode).children.filterIsInstance<JavadocPackagePageNode>().forEach {
it.getAllNavigables().forEach { d ->
val name = when (d) {
is JavadocPageNode -> d.name
is AnchorableJavadocNode -> d.name
else -> null
}
if (name != null && name.isNotBlank()) {
elements.getOrPut(name[0].toUpperCase(), ::mutableSetOf).add(d)
}
}
elements.getOrPut(it.name[0].toUpperCase(), ::mutableSetOf).add(it)
}
val keys = elements.keys.sortedBy { it }
val sortedElements = elements.entries.sortedBy { (a, _) -> a }
val indexNodeComparator = compareBy<NavigableJavadocNode> { it.getId().toLowerCase() }
.thenBy { it.getFullComparatorKey() }
val indexPages = sortedElements.mapIndexed { idx, (_, set) ->
IndexPage(
id = idx + 1,
elements = set.sortedWith(indexNodeComparator),
keys = keys,
sourceSet = input.sourceSets()
)
}
return input.modified(children = input.children + indexPages)
}
private fun NavigableJavadocNode.getFullComparatorKey(): String {
return getDRI().let { dri ->
val packageName = dri.packageName.orEmpty()
val className = dri.classNames.orEmpty()
val callableName = dri.callable?.name.orEmpty()
val parameters = dri.callable?.signature().orEmpty()
"$packageName/$className/$callableName/$parameters"
}
}
}
object DeprecatedPageCreator : PageTransformer {
override fun invoke(input: RootPageNode): RootPageNode {
val elements = HashMap<DeprecatedPageSection, MutableSet<DeprecatedNode>>().apply {
fun <T> T.putAs(deprecatedPageSection: DeprecatedPageSection) where
T : NavigableJavadocNode,
T : WithJavadocExtra<out Documentable> {
val deprecatedNode = DeprecatedNode(
listOfNotNull(
getDRI().packageName?.takeUnless { it.isBlank() },
if (this is JavadocFunctionNode) getAnchor() else getId()
).joinToString("."),
getDRI(),
(this as? WithBrief)?.brief.orEmpty()
)
getOrPut(deprecatedPageSection) { mutableSetOf() }.add(deprecatedNode)
if (deprecatedAnnotation?.params?.get("forRemoval") == BooleanValue(true)) {
getOrPut(DeprecatedPageSection.DeprecatedForRemoval) { mutableSetOf() }.add(deprecatedNode)
}
}
fun verifyDeprecation(node: NavigableJavadocNode) {
when (node) {
is JavadocModulePageNode -> {
node.children.filterIsInstance<JavadocPackagePageNode>().forEach(::verifyDeprecation)
node.takeIf { it.isDeprecated() }?.putAs(DeprecatedPageSection.DeprecatedModules)
}
is JavadocPackagePageNode ->
node.children.filterIsInstance<NavigableJavadocNode>().forEach(::verifyDeprecation)
is JavadocClasslikePageNode -> {
node.classlikes.forEach(::verifyDeprecation)
node.methods.forEach {
it.takeIf { it.isDeprecated() }?.putAs(DeprecatedPageSection.DeprecatedMethods)
}
node.constructors.forEach {
it.takeIf { it.isDeprecated() }?.putAs(DeprecatedPageSection.DeprecatedConstructors)
}
node.properties.forEach {
it.takeIf { it.isDeprecated() }?.putAs(DeprecatedPageSection.DeprecatedFields)
}
node.entries.forEach {
it.takeIf { it.isDeprecated() }?.putAs(DeprecatedPageSection.DeprecatedEnumConstants)
}
node.takeIf { it.isDeprecated() }?.putAs(
if ((node as? WithJavadocExtra<out Documentable>)?.isException == true) DeprecatedPageSection.DeprecatedExceptions
else when (node.kind) {
"enum" -> DeprecatedPageSection.DeprecatedEnums
"interface" -> DeprecatedPageSection.DeprecatedInterfaces
else -> DeprecatedPageSection.DeprecatedClasses
}
)
}
}
}
verifyDeprecation(input as JavadocModulePageNode)
}
return input.modified(
children = input.children + DeprecatedPage(
elements,
(input as JavadocModulePageNode).sourceSets()
)
)
}
}