Resolve links in docs.

1 files changed, 83 insertions, 0 deletions

diff --git a/src/Kotlin/ResolveReferences.kt b/src/Kotlin/ResolveReferences.kt
new file mode 100644
index 00000000..90e23ffb
--- /dev/null
+++ b/src/Kotlin/ResolveReferences.kt
@@ -0,0 +1,83 @@
+package org.jetbrains.dokka
+
+import org.jetbrains.jet.lang.resolve.name.Name
+
+/**
+ * Generates cross-references for documentation such as extensions for a type, inheritors, etc
+ *
+ * $receiver: [DocumentationContext] for node/descriptor resolutions
+ * $node: [DocumentationNode] to visit
+ */
+public fun DocumentationContext.resolveReferences(node: DocumentationNode) {
+    node.details(DocumentationNode.Kind.Receiver).forEach { detail ->
+        val receiverType = detail.detail(DocumentationNode.Kind.Type)
+        val descriptor = relations[receiverType]
+        if (descriptor != null) {
+            val typeNode = descriptorToNode[descriptor]
+            // if typeNode is null, extension is to external type like in a library
+            // should we create dummy node here?
+            typeNode?.addReferenceTo(node, DocumentationReference.Kind.Extension)
+        }
+    }
+    node.details(DocumentationNode.Kind.Supertype).forEach { detail ->
+        val descriptor = relations[detail]
+        if (descriptor != null) {
+            val typeNode = descriptorToNode[descriptor]
+            typeNode?.addReferenceTo(node, DocumentationReference.Kind.Inheritor)
+        }
+    }
+    node.details.forEach { detail ->
+        val descriptor = relations[detail]
+        if (descriptor != null) {
+            val typeNode = descriptorToNode[descriptor]
+            if (typeNode != null) {
+                detail.addReferenceTo(typeNode, DocumentationReference.Kind.Link)
+            }
+        }
+    }
+
+    resolveContentLinks(node, node.doc)
+
+    for (child in node.members) {
+        resolveReferences(child)
+    }
+    for (child in node.details) {
+        resolveReferences(child)
+    }
+}
+
+fun DocumentationContext.resolveContentLinks(node : DocumentationNode, content: ContentNode) {
+    val snapshot = content.children.toList()
+    for (child in snapshot) {
+        if (child is ContentNameLink) {
+            val scope = getResolutionScope(node)
+            val symbolName = child.name
+            val symbol =
+                    scope.getLocalVariable(Name.guess(symbolName)) ?:
+                    scope.getProperties(Name.guess(symbolName)).firstOrNull() ?:
+                    scope.getFunctions(Name.guess(symbolName)).firstOrNull() ?:
+                    scope.getClassifier(Name.guess(symbolName))
+
+            if (symbol != null) {
+                val targetNode = descriptorToNode[symbol]
+                if (targetNode != null) {
+                    // we have a doc node for the symbol
+                    val index = content.children.indexOf(child)
+                    content.children.remove(index)
+                    val contentLink = ContentNodeLink(targetNode)
+                    contentLink.children.add(ContentIdentifier(symbolName))
+                    //contentLink.children.addAll(child.children)
+                    content.children.add(index, contentLink)
+                } else {
+                    // we don't have a doc node for the symbol, render as identifier
+                    val index = content.children.indexOf(child)
+                    content.children.remove(index)
+                    val contentLink = ContentIdentifier(symbolName)
+                    contentLink.children.addAll(child.children)
+                    content.children.add(index, contentLink)
+                }
+            }
+        }
+        resolveContentLinks(node, child)
+    }
+}
\ No newline at end of file