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
|
package org.jetbrains.dokka.Formats
import com.google.inject.Inject
import com.google.inject.name.Named
import kotlinx.html.*
import org.jetbrains.dokka.*
import java.io.File
import kotlin.reflect.KClass
/**
* Data structure used for generating `data-reference-resources-wrapper`.
*/
val nodeToFamilyMap = HashMap<DocumentationNode, List<DocumentationNode>>()
/**
* On Devsite, certain headers and footers are needed for generating Devsite metadata.
*/
class DevsiteHtmlTemplateService @Inject constructor(
val uriProvider: JavaLayoutHtmlUriProvider, @Named("outputDir") val rootFile: File
) : JavaLayoutHtmlTemplateService {
override fun composePage(page: JavaLayoutHtmlFormatOutputBuilder.Page, tagConsumer: TagConsumer<Appendable>, headContent: HEAD.() -> Unit, bodyContent: BODY.() -> Unit) {
tagConsumer.html {
attributes["devsite"] = "true"
run {
val x = 0
}
head {
headContent()
meta(name = "top_category") { attributes["value"] = "develop" }
meta(name = "subcategory") { attributes["value"] = "reference" }
meta(name = "hide_page_heading") { attributes["value"] = "true" }
meta(name = "book_path") { attributes["value"] = "/$rootFile/_toc.yaml" }
meta(name = "project_path") { attributes["value"] = "/${rootFile.parent}/_project.yaml" }
}
body {
bodyContent()
// TODO Refactor appendDataReferenceResourceWrapper to use KotlinX.HTML
unsafe { raw(buildString { appendDataReferenceResourceWrapper(when(page) {
is JavaLayoutHtmlFormatOutputBuilder.Page.ClassIndex -> page.classes
is JavaLayoutHtmlFormatOutputBuilder.Page.ClassPage -> listOf(page.node)
is JavaLayoutHtmlFormatOutputBuilder.Page.PackageIndex -> page.packages
is JavaLayoutHtmlFormatOutputBuilder.Page.PackagePage -> listOf(page.node)
}) }) }
}
}
}
/**
* Appends `data-reference-resources-wrapper` data to the body of the page. This is required
* for highlighting the current page in the left nav of DAC.
*/
private fun Appendable.appendDataReferenceResourceWrapper(nodes: Iterable<DocumentationNode>) {
val node = nodes.first()
if (node.isPackage()) {
val children = node.getMembersOfKinds(NodeKind.Class, NodeKind.Interface, NodeKind.Enum,
NodeKind.AnnotationClass, NodeKind.Exception, NodeKind.Object)
for (child in children) {
nodeToFamilyMap.put(child, children)
}
} else if (node.hasOwnPage() || node.kind in NodeKind.memberLike) {
val pageOwner = node.pageOwner()
val family = nodeToFamilyMap[pageOwner]?.groupBy { it.kind }
if (family != null) {
appendln("<div class=\"data-reference-resources-wrapper\">")
appendln(" <ul data-reference-resources>")
val interfaceFamily = family[NodeKind.Interface]
if (interfaceFamily != null) {
appendln(" <li><h2>Interfaces</h2>")
appendFamily(pageOwner, interfaceFamily)
}
val classFamily = family[NodeKind.Class]
if (classFamily != null) {
appendln(" <li><h2>Classes</h2>")
appendFamily(pageOwner, classFamily)
}
val enumFamily = family[NodeKind.Enum]
if (enumFamily != null) {
appendln(" <li><h2>Enums</h2>")
appendFamily(pageOwner, enumFamily)
}
val annotationFamily = family[NodeKind.AnnotationClass]
if (annotationFamily != null) {
appendln(" <li><h2>Annotations</h2>")
appendFamily(pageOwner, annotationFamily)
}
val exceptionFamily = family[NodeKind.Exception]
if (exceptionFamily != null) {
appendln(" <li><h2>Exceptions</h2>")
appendFamily(pageOwner, exceptionFamily)
}
val objectFamily = family[NodeKind.Object]
if (objectFamily != null) {
appendln(" <li><h2>Objects</h2>")
appendFamily(pageOwner, objectFamily)
}
appendln(" </ul>")
appendln("</div>")
}
}
}
/**
* Formats the `family` of the node for the `data-reference-resources-wrapper`.
* TODO: investigate expressing apilevel.
*/
private fun Appendable.appendFamily(selectedNode: DocumentationNode, family: List<DocumentationNode>) {
appendln(" <ul>")
for (node in family) {
val selected = if (node == selectedNode) "selected " else ""
appendln(" <li class=\"${selected}api apilevel-\">" +
"<a href=\"/${uriProvider.mainUriOrWarn(node)}\">${node.nameWithOuterClass()}</a></li>")
}
appendln(" </ul>")
}
}
class DacFormatDescriptor : JavaLayoutHtmlFormatDescriptorBase(), DefaultAnalysisComponentServices by KotlinAsKotlin {
override val templateServiceClass: KClass<out JavaLayoutHtmlTemplateService> = DevsiteHtmlTemplateService::class
override val outlineFactoryClass = DacOutlineFormatter::class
override val languageServiceClass = KotlinLanguageService::class
override val packageListServiceClass: KClass<out PackageListService> = JavaLayoutHtmlPackageListService::class
override val outputBuilderFactoryClass: KClass<out JavaLayoutHtmlFormatOutputBuilderFactory> = JavaLayoutHtmlFormatOutputBuilderFactoryImpl::class
}
|
