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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
package org.jetbrains.dokka.pages
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.SourceSetData
import org.jetbrains.dokka.model.properties.PropertyContainer
import org.jetbrains.dokka.model.properties.WithExtraProperties
data class DCI(val dri: Set<DRI>, val kind: Kind) {
override fun toString() = "$dri[$kind]"
}
interface ContentNode : WithExtraProperties<ContentNode> {
val dci: DCI
val sourceSets: Set<SourceSetData>
val style: Set<Style>
}
/** Simple text */
data class ContentText(
val text: String,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style> = emptySet(),
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentNode {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentNode = copy(extra = newExtras)
}
// TODO: Remove
data class ContentBreakLine(
override val sourceSets: Set<SourceSetData>,
override val dci: DCI = DCI(emptySet(), ContentKind.Empty),
override val style: Set<Style> = emptySet(),
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentNode {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentNode = copy(extra = newExtras)
}
/** Headers */
data class ContentHeader(
override val children: List<ContentNode>,
val level: Int,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style>,
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentComposite {
constructor(level: Int, c: ContentComposite) : this(c.children, level, c.dci, c.sourceSets, c.style, c.extra)
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentHeader = copy(extra = newExtras)
}
/** Code blocks */
data class ContentCode(
override val children: List<ContentNode>,
val language: String,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style>,
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentComposite {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentCode = copy(extra = newExtras)
}
/** Union type replacement */
interface ContentLink : ContentComposite
/** All links to classes, packages, etc. that have te be resolved */
data class ContentDRILink(
override val children: List<ContentNode>,
val address: DRI,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style> = emptySet(),
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentLink {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentDRILink = copy(extra = newExtras)
}
/** All links that do not need to be resolved */
data class ContentResolvedLink(
override val children: List<ContentNode>,
val address: String,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style> = emptySet(),
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentLink {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentResolvedLink =
copy(extra = newExtras)
}
/** Embedded resources like images */
data class ContentEmbeddedResource(
override val children: List<ContentNode> = emptyList(),
val address: String,
val altText: String?,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style> = emptySet(),
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentLink {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentEmbeddedResource =
copy(extra = newExtras)
}
/** Logical grouping of [ContentNode]s */
interface ContentComposite : ContentNode {
val children: List<ContentNode>
}
/** Tables */
data class ContentTable(
val header: List<ContentGroup>,
override val children: List<ContentGroup>,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style>,
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentComposite {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentTable = copy(extra = newExtras)
}
/** Lists */
data class ContentList(
override val children: List<ContentNode>,
val ordered: Boolean,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style>,
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentComposite {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentList = copy(extra = newExtras)
}
/** Default group, eg. for blocks of Functions, Properties, etc. **/
data class ContentGroup(
override val children: List<ContentNode>,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style>,
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentComposite {
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentGroup = copy(extra = newExtras)
}
/**
* @property groupName is used for finding and copying [ContentDivergentInstance]s when merging [ContentPage]s
*/
data class ContentDivergentGroup(
override val children: List<ContentDivergentInstance>,
override val dci: DCI,
override val style: Set<Style>,
override val extra: PropertyContainer<ContentNode>,
val groupID: GroupID,
val implicitlySourceSetHinted: Boolean = true
) : ContentComposite {
data class GroupID(val name: String)
override val sourceSets: Set<SourceSetData>
get() = children.flatMap { it.sourceSets }.distinct().toSet()
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentDivergentGroup =
copy(extra = newExtras)
}
/** Instance of a divergent content */
data class ContentDivergentInstance(
val before: ContentNode?,
val divergent: ContentNode,
val after: ContentNode?,
override val dci: DCI,
override val sourceSets: Set<SourceSetData>,
override val style: Set<Style>,
override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
) : ContentComposite {
override val children: List<ContentNode>
get() = listOfNotNull(before, divergent, after)
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentDivergentInstance =
copy(extra = newExtras)
}
data class PlatformHintedContent(
val inner: ContentNode,
override val sourceSets: Set<SourceSetData>
) : ContentComposite {
override val children = listOf(inner)
override val dci: DCI
get() = inner.dci
override val extra: PropertyContainer<ContentNode>
get() = inner.extra
override val style: Set<Style>
get() = inner.style
override fun withNewExtras(newExtras: PropertyContainer<ContentNode>) =
throw UnsupportedOperationException("This method should not be called on this PlatformHintedContent")
}
interface Style
interface Kind
enum class ContentKind : Kind {
Comment, Constructors, Functions, Parameters, Properties, Classlikes, Packages, Symbol, Sample, Main, BriefComment,
Empty, Source, TypeAliases, Cover, Inheritors, SourceSetDependantHint;
companion object {
private val platformTagged =
setOf(Constructors, Functions, Properties, Classlikes, Packages, Source, TypeAliases, Inheritors)
fun shouldBePlatformTagged(kind: Kind): Boolean = kind in platformTagged
}
}
enum class TextStyle : Style {
Bold, Italic, Strong, Strikethrough, Paragraph, Block, Span, Monospace, Indented
}
enum class ContentStyle : Style {
RowTitle, TabbedContent, TabbedContentBody, WithExtraAttributes
}
object CommentTable: Style
object MultimoduleTable: Style
fun ContentNode.dfs(predicate: (ContentNode) -> Boolean): ContentNode? = if (predicate(this)) {
this
} else {
if (this is ContentComposite) {
this.children.asSequence().mapNotNull { it.dfs(predicate) }.firstOrNull()
} else {
null
}
}
fun ContentNode.hasStyle(style: Style) = this.style.contains(style)
|
