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
|
package org.jetbrains.dokka.Model
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.pages.PlatformData
import org.jetbrains.kotlin.descriptors.*
import org.jetbrains.kotlin.kdoc.psi.impl.KDocTag
class Module(val packages: List<Package>) : DocumentationNode<Nothing>() {
override val dri: DRI = DRI.topLevel
override val children: List<Package> = packages
}
class Package(
override val dri: DRI,
override val functions: List<Function>,
override val properties: List<Property>,
override val classes: List<Class>
) : ScopeNode<Nothing>() {
val name = dri.packageName.orEmpty()
}
class Class(
override val dri: DRI,
val name: String,
val constructors: List<Function>,
override val functions: List<Function>,
override val properties: List<Property>,
override val classes: List<Class>,
override val expectDescriptor: Descriptor<ClassDescriptor>?,
override val actualDescriptors: List<Descriptor<ClassDescriptor>>
) : ScopeNode<ClassDescriptor>()
class Function(
override val dri: DRI,
val name: String,
override val receiver: Parameter?,
val parameters: List<Parameter>,
override val expectDescriptor: Descriptor<FunctionDescriptor>?,
override val actualDescriptors: List<Descriptor<FunctionDescriptor>>
) : CallableNode<FunctionDescriptor>() {
override val children: List<Parameter>
get() = listOfNotNull(receiver) + parameters
}
class Property(
override val dri: DRI,
val name: String,
override val receiver: Parameter?,
override val expectDescriptor: Descriptor<PropertyDescriptor>?,
override val actualDescriptors: List<Descriptor<PropertyDescriptor>>
) : CallableNode<PropertyDescriptor>() {
override val children: List<Parameter>
get() = listOfNotNull(receiver)
}
// TODO: treat named Parameters and receivers differently
class Parameter(
override val dri: DRI,
val name: String?,
override val actualDescriptors: List<Descriptor<ParameterDescriptor>>
) : DocumentationNode<ParameterDescriptor>() {
override val children: List<DocumentationNode<*>>
get() = emptyList()
}
class Descriptor<out T : DeclarationDescriptor>(
val descriptor: T,
val docTag: KDocTag?,
val links: Map<String, DRI>,
val platformData: List<PlatformData>
) : DeclarationDescriptor by descriptor {
override fun equals(other: Any?): Boolean =
other is Descriptor<*> && (
descriptor.toString() == other.descriptor.toString() &&
docTag?.text == other.docTag?.text &&
links == other.links)
override fun hashCode(): Int =
listOf(descriptor.toString(), docTag?.text, links).hashCode()
}
abstract class DocumentationNode<out T : DeclarationDescriptor> {
open val expectDescriptor: Descriptor<T>? = null
open val actualDescriptors: List<Descriptor<T>> = emptyList()
val descriptors by lazy { listOfNotNull(expectDescriptor) + actualDescriptors }
val platformData by lazy { descriptors.flatMap { it.platformData }.toSet() }
abstract val dri: DRI
abstract val children: List<DocumentationNode<*>>
override fun toString(): String {
return "${javaClass.simpleName}($dri)" + briefDocstring.takeIf { it.isNotBlank() }?.let { " [$it]" }.orEmpty()
}
override fun equals(other: Any?) = other is DocumentationNode<*> && this.dri == other.dri
override fun hashCode() = dri.hashCode()
val commentsData: List<Pair<String, Map<String, DRI>>>
get() = descriptors.mapNotNull { it.docTag?.let { tag -> Pair(tag.getContent(), it.links) } }
val briefDocstring: String
get() = descriptors.firstOrNull()?.docTag?.getContent().orEmpty().shorten(40)
}
abstract class ScopeNode<out T : ClassOrPackageFragmentDescriptor> : DocumentationNode<T>() {
abstract val functions: List<Function>
abstract val properties: List<Property>
abstract val classes: List<Class>
override val children: List<DocumentationNode<MemberDescriptor>>
get() = functions + properties + classes
}
abstract class CallableNode<out T : CallableDescriptor> : DocumentationNode<T>() {
abstract val receiver: Parameter?
}
private fun String.shorten(maxLength: Int) = lineSequence().first().let {
if (it.length != length || it.length > maxLength) it.take(maxLength - 3) + "..." else it
}
|
