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
|
package org.jetbrains.dokka
import com.google.inject.Singleton
enum class RefKind {
Owner,
Member,
InheritedMember,
InheritedCompanionObjectMember,
Detail,
Link,
HiddenLink,
Extension,
Inheritor,
Superclass,
Override,
Annotation,
HiddenAnnotation,
Deprecation,
TopLevelPage,
Platform,
ExternalType,
Origin,
SinceKotlin
}
data class DocumentationReference(val from: DocumentationNode, val to: DocumentationNode, val kind: RefKind) {
}
sealed class NodeResolver {
abstract fun resolve(nodeRephGraph: NodeReferenceGraph): DocumentationNode?
class BySignature(var signature: String) : NodeResolver() {
override fun resolve(nodeRephGraph: NodeReferenceGraph): DocumentationNode? {
return nodeRephGraph.lookup(signature)
}
}
class Exact(var exactNode: DocumentationNode) : NodeResolver() {
override fun resolve(nodeRephGraph: NodeReferenceGraph): DocumentationNode? {
return exactNode
}
}
}
class PendingDocumentationReference(val lazyNodeFrom: NodeResolver,
val lazyNodeTo: NodeResolver,
val kind: RefKind) {
fun resolve(nodeRephGraph: NodeReferenceGraph) {
val fromNode = lazyNodeFrom.resolve(nodeRephGraph)
val toNode = lazyNodeTo.resolve(nodeRephGraph)
if (fromNode != null && toNode != null) {
fromNode.addReferenceTo(toNode, kind)
}
}
}
class NodeReferenceGraph {
private val nodeMap = hashMapOf<String, DocumentationNode>()
val nodeMapView: Map<String, DocumentationNode>
get() = HashMap(nodeMap)
val references = arrayListOf<PendingDocumentationReference>()
fun register(signature: String, node: DocumentationNode) {
nodeMap[signature] = node
}
fun link(fromNode: DocumentationNode, toSignature: String, kind: RefKind) {
references.add(
PendingDocumentationReference(
NodeResolver.Exact(fromNode),
NodeResolver.BySignature(toSignature),
kind
))
}
fun link(fromSignature: String, toNode: DocumentationNode, kind: RefKind) {
references.add(
PendingDocumentationReference(
NodeResolver.BySignature(fromSignature),
NodeResolver.Exact(toNode),
kind
)
)
}
fun link(fromSignature: String, toSignature: String, kind: RefKind) {
references.add(
PendingDocumentationReference(
NodeResolver.BySignature(fromSignature),
NodeResolver.BySignature(toSignature),
kind
)
)
}
fun addReference(reference: PendingDocumentationReference) {
references.add(reference)
}
fun lookup(signature: String) = nodeMap[signature]
fun lookupOrWarn(signature: String, logger: DokkaLogger): DocumentationNode? {
val result = nodeMap[signature]
if (result == null) {
logger.warn("Can't find node by signature `$signature`." +
"This is probably caused by invalid configuration of cross-module dependencies")
}
return result
}
fun resolveReferences() {
references.forEach { it.resolve(this) }
}
}
|
