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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
package org.jetbrains.dokka.pages
import org.jetbrains.dokka.utilities.DokkaLogger
import org.jetbrains.dokka.model.DocumentationNode
import org.jetbrains.dokka.model.Function
import org.jetbrains.dokka.model.Parameter
import org.jetbrains.dokka.model.TypeWrapper
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.markdown.parseMarkdown
class DefaultPageContentBuilder(
private val dri: DRI,
private val platformData: Set<PlatformData>,
private val kind: Kind,
private val markdownConverter: MarkdownToContentConverter,
val logger: DokkaLogger,
private val styles: Set<Style> = emptySet(),
private val extras: Set<Extra> = emptySet()
) : PageContentBuilder {
private val contents = mutableListOf<ContentNode>()
private fun createText(text: String, kind: Kind = ContentKind.Symbol) =
ContentText(text, DCI(dri, kind), platformData, styles, extras)
private fun build() = ContentGroup(
contents.toList(),
DCI(dri, kind),
platformData,
styles,
extras
)
override fun header(level: Int, block: PageContentBuilderFunction) {
contents += ContentHeader(level, group(ContentKind.Symbol, block))
}
override fun text(text: String, kind: Kind) {
contents += createText(text, kind)
}
private fun signature(f: Function, block: PageContentBuilderFunction) {
contents += group(f.dri, f.platformData, ContentKind.Symbol, block)
}
override fun signature(f: Function) = signature(f) {
text("fun ")
if (f.receiver is Parameter) {
type(f.receiver.type)
text(".")
}
link(f.name, f.dri)
text("(")
list(f.parameters) {
link(it.name!!, it.dri)
text(": ")
type(it.type)
}
text(")")
val returnType = f.returnType
if (!f.isConstructor && returnType != null &&
returnType.constructorFqName != Unit::class.qualifiedName) {
text(": ")
type(returnType)
}
}
override fun linkTable(elements: List<DRI>) {
contents += ContentTable(
emptyList(),
elements.map { group(dri, platformData, ContentKind.Classes) { link(it.classNames ?: "", it) } },
DCI(dri, kind),
platformData, styles, extras
)
}
override fun <T : DocumentationNode> block(
name: String,
level: Int,
kind: Kind,
elements: Iterable<T>,
platformData: Set<PlatformData>,
operation: PageContentBuilder.(T) -> Unit
) {
header(level) { text(name) }
contents += ContentTable(
emptyList(),
elements.map { group(it.dri, it.platformData, kind) { operation(it) } },
DCI(dri, kind),
platformData, styles, extras
)
}
override fun <T> list(
elements: List<T>,
prefix: String,
suffix: String,
separator: String,
operation: PageContentBuilder.(T) -> Unit
) {
if (elements.isNotEmpty()) {
if (prefix.isNotEmpty()) text(prefix)
elements.dropLast(1).forEach {
operation(it)
text(separator)
}
operation(elements.last())
if (suffix.isNotEmpty()) text(suffix)
}
}
override fun link(text: String, address: DRI, kind: Kind) {
contents += ContentDRILink(
listOf(createText(text)),
address,
DCI(dri, kind),
platformData
)
}
override fun link(address: DRI, kind: Kind, block: PageContentBuilderFunction) {
contents += ContentDRILink(
group(ContentKind.Main, block).children,
address,
DCI(dri, kind),
platformData
)
}
override fun comment(raw: String, links: Map<String, DRI>) {
contents += group(ContentKind.Comment) {
with(this as DefaultPageContentBuilder) {
contents += markdownConverter.buildContent(
parseMarkdown(raw),
DCI(dri, ContentKind.Comment),
platformData,
links
)
}
}
}
override fun markdown(raw: String, links: Map<String, DRI>) {
contents += markdownConverter.buildContent(
parseMarkdown(raw), DCI(dri, ContentKind.Sample),
platformData,
links
)
}
fun group(kind: Kind, block: PageContentBuilderFunction): ContentGroup =
group(dri, platformData, kind, block)
override fun group(
dri: DRI,
platformData: Set<PlatformData>,
kind: Kind,
block: PageContentBuilderFunction
): ContentGroup = group(dri, platformData, kind, markdownConverter, logger, block)
companion object {
fun group(
dri: DRI,
platformData: Set<PlatformData>,
kind: Kind,
markdownConverter: MarkdownToContentConverter,
logger: DokkaLogger,
block: PageContentBuilderFunction
): ContentGroup =
DefaultPageContentBuilder(dri, platformData, kind, markdownConverter, logger).apply(block).build()
}
}
private fun PageContentBuilder.type(t: TypeWrapper) {
if (t.constructorNamePathSegments.isNotEmpty() && t.dri != null)
link(t.constructorNamePathSegments.last(), t.dri!!)
else (this as? DefaultPageContentBuilder)?.let {
logger.error("type $t cannot be resolved")
text("???")
}
list(t.arguments, prefix = "<", suffix = ">") {
type(it)
}
}
typealias PageContentBuilderFunction = PageContentBuilder.() -> Unit
@DslMarker
annotation class ContentMarker
@ContentMarker
interface PageContentBuilder {
fun group(
dri: DRI,
platformData: Set<PlatformData>,
kind: Kind, block: PageContentBuilderFunction): ContentGroup
fun text(text: String, kind: Kind = ContentKind.Symbol)
fun signature(f: Function)
fun link(text: String, address: DRI, kind: Kind = ContentKind.Symbol)
fun link(address: DRI, kind: Kind = ContentKind.Symbol, block: PageContentBuilderFunction)
fun linkTable(elements: List<DRI>)
fun comment(raw: String, links: Map<String, DRI>)
fun markdown(raw: String, links: Map<String, DRI>)
fun header(level: Int, block: PageContentBuilderFunction)
fun <T> list(
elements: List<T>,
prefix: String = "",
suffix: String = "",
separator: String = ",",
operation: PageContentBuilder.(T) -> Unit
)
fun <T : DocumentationNode> block(
name: String,
level: Int,
kind: Kind,
elements: Iterable<T>,
platformData: Set<PlatformData>,
operation: PageContentBuilder.(T) -> Unit
)
}
|
