From a52e1d543d22fdacf87ec00988b753d2d1107c1d Mon Sep 17 00:00:00 2001
From: Ilya Ryzhenkov <orangy@jetbrains.com>
Date: Fri, 3 Oct 2014 15:57:16 +0400
Subject: Work on cross-references.

---
 .idea/libraries/kotlin_compiler.xml        |  4 ---
 .idea/runConfigurations/All_tests.xml      |  6 ----
 .idea/runConfigurations/Dokka.xml          |  2 +-
 src/Analysis/CompilerAPI.kt                |  4 +--
 src/Formats/StructuredFormatService.kt     | 50 +++++++++++++++++-------------
 src/Kotlin/CrossReferences.kt              | 37 ++++++++++++++++++++++
 src/Kotlin/DocumentationBuildingVisitor.kt |  2 +-
 src/Kotlin/DocumentationContext.kt         | 15 +++++++++
 src/Kotlin/DocumentationNodeBuilder.kt     | 18 ++++++-----
 src/Model/DocumentationNode.kt             |  2 ++
 src/Model/DocumentationReference.kt        |  1 +
 src/Processing/CrossReferences.kt          | 12 -------
 src/main.kt                                |  6 ----
 13 files changed, 97 insertions(+), 62 deletions(-)
 create mode 100644 src/Kotlin/CrossReferences.kt
 delete mode 100644 src/Processing/CrossReferences.kt

diff --git a/.idea/libraries/kotlin_compiler.xml b/.idea/libraries/kotlin_compiler.xml
index 8e5c6bd2..306c11be 100644
--- a/.idea/libraries/kotlin_compiler.xml
+++ b/.idea/libraries/kotlin_compiler.xml
@@ -50,10 +50,8 @@
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-js-tests-junit/src/test/kotlin" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/src/it/test-classpath/src/test/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/src/it/test-helloworld/src/test/java" />
-      <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/src/it/test-inlineDisabled/src/test/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/target/it/test-classpath/src/test/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/target/it/test-helloworld/src/test/java" />
-      <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/target/it/test-inlineDisabled/src/test/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/simpleProject/src/main/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/additionalJavaSrc/src/main/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/additionalJavaSrc/generated" />
@@ -116,10 +114,8 @@
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-js-tests-junit/src/test/kotlin" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/src/it/test-classpath/src/test/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/src/it/test-helloworld/src/test/java" />
-      <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/src/it/test-inlineDisabled/src/test/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/target/it/test-classpath/src/test/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/target/it/test-helloworld/src/test/java" />
-      <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-maven-plugin-test/target/it/test-inlineDisabled/src/test/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/simpleProject/src/main/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/additionalJavaSrc/src/main/java" />
       <root url="file://$PROJECT_DIR$/../kotlin/libraries/tools/kotlin-gradle-plugin-core/src/test/resources/testProject/additionalJavaSrc/generated" />
diff --git a/.idea/runConfigurations/All_tests.xml b/.idea/runConfigurations/All_tests.xml
index deb51b1a..4e7c9c09 100644
--- a/.idea/runConfigurations/All_tests.xml
+++ b/.idea/runConfigurations/All_tests.xml
@@ -23,14 +23,8 @@
       <option name="TRANSPORT" value="0" />
       <option name="LOCAL" value="true" />
     </RunnerSettings>
-    <RunnerSettings RunnerId="Debug">
-      <option name="DEBUG_PORT" value="" />
-      <option name="TRANSPORT" value="0" />
-      <option name="LOCAL" value="true" />
-    </RunnerSettings>
     <RunnerSettings RunnerId="Run" />
     <ConfigurationWrapper RunnerId="Debug" />
-    <ConfigurationWrapper RunnerId="Debug" />
     <ConfigurationWrapper RunnerId="Run" />
     <method />
   </configuration>
diff --git a/.idea/runConfigurations/Dokka.xml b/.idea/runConfigurations/Dokka.xml
index c96a130e..5b2c5a2b 100644
--- a/.idea/runConfigurations/Dokka.xml
+++ b/.idea/runConfigurations/Dokka.xml
@@ -3,7 +3,7 @@
     <extension name="coverage" enabled="false" merge="false" sample_coverage="true" runner="idea" />
     <option name="MAIN_CLASS_NAME" value="org.jetbrains.dokka.DokkaPackage" />
     <option name="VM_PARAMETERS" value="" />
-    <option name="PROGRAM_PARAMETERS" value="src/ -output ../dokka-doc/doc -module dokka -classpath &quot;$KOTLIN_BUNDLED$/lib/kotlin-compiler.jar:$KOTLIN_BUNDLED$/lib/kotlin-runtime.jar&quot;" />
+    <option name="PROGRAM_PARAMETERS" value="src/ -output doc -module dokka -classpath &quot;$KOTLIN_BUNDLED$/lib/kotlin-compiler.jar:$KOTLIN_BUNDLED$/lib/kotlin-runtime.jar&quot;" />
     <option name="WORKING_DIRECTORY" value="file://$PROJECT_DIR$" />
     <option name="ALTERNATIVE_JRE_PATH_ENABLED" value="false" />
     <option name="ALTERNATIVE_JRE_PATH" />
diff --git a/src/Analysis/CompilerAPI.kt b/src/Analysis/CompilerAPI.kt
index 032076e5..03d4dde6 100644
--- a/src/Analysis/CompilerAPI.kt
+++ b/src/Analysis/CompilerAPI.kt
@@ -80,7 +80,7 @@ public fun getFunctionInnerScope(outerScope: JetScope, descriptor: FunctionDescr
     val redeclarationHandler = RedeclarationHandler.DO_NOTHING
 
     val functionScope = WritableScopeImpl(outerScope, descriptor, redeclarationHandler, "Function ${descriptor.getName()} scope")
-    val receiver = descriptor.getReceiverParameter()
+    val receiver = descriptor.getExtensionReceiverParameter()
     if (receiver != null) {
         functionScope.setImplicitReceiver(receiver)
     }
@@ -99,7 +99,7 @@ public fun getPropertyInnerScope(outerScope: JetScope, descriptor: PropertyDescr
     val redeclarationHandler = RedeclarationHandler.DO_NOTHING
 
     val propertyScope = WritableScopeImpl(outerScope, descriptor, redeclarationHandler, "Property ${descriptor.getName()} scope")
-    val receiver = descriptor.getReceiverParameter()
+    val receiver = descriptor.getExtensionReceiverParameter()
     if (receiver != null) {
         propertyScope.setImplicitReceiver(receiver)
     }
diff --git a/src/Formats/StructuredFormatService.kt b/src/Formats/StructuredFormatService.kt
index 40feaf21..f2fb9b41 100644
--- a/src/Formats/StructuredFormatService.kt
+++ b/src/Formats/StructuredFormatService.kt
@@ -103,30 +103,36 @@ public abstract class StructuredFormatService(val locationService: LocationServi
         }
 
         for (node in nodes) {
-            if (node.members.any()) {
-                appendHeader(to, "Members", 3)
+            appendSection("Members", node.members, node, to)
+            appendSection("Extensions", node.extensions, node, to)
+            appendSection("Links", node.links, node, to)
+        }
+    }
 
-                val children = node.members.sortBy { it.name }
-                val membersMap = children.groupBy { link(node, it) }
+    private fun StructuredFormatService.appendSection(caption: String, nodes: List<DocumentationNode>, node: DocumentationNode, to: StringBuilder) {
+        if (nodes.any()) {
+            appendHeader(to, caption, 3)
 
-                appendTable(to) {
-                    appendTableBody(to) {
-                        for ((location, members) in membersMap) {
-                            appendTableRow(to) {
-                                appendTableCell(to) {
-                                    appendText(to, formatLink(location))
-                                }
-                                appendTableCell(to) {
-                                    val breakdownBySummary = members.groupBy { it.doc.summary }
-                                    for ((summary, items) in breakdownBySummary) {
-                                        val signatures = items.map { formatCode("${languageService.render(it)}") }
-                                        for (signature in signatures) {
-                                            appendText(to, signature)
-                                        }
-
-                                        if (!summary.isEmpty()) {
-                                            appendText(to, formatText(summary))
-                                        }
+            val children = nodes.sortBy { it.name }
+            val membersMap = children.groupBy { link(node, it) }
+
+            appendTable(to) {
+                appendTableBody(to) {
+                    for ((location, members) in membersMap) {
+                        appendTableRow(to) {
+                            appendTableCell(to) {
+                                appendText(to, formatLink(location))
+                            }
+                            appendTableCell(to) {
+                                val breakdownBySummary = members.groupBy { it.doc.summary }
+                                for ((summary, items) in breakdownBySummary) {
+                                    val signatures = items.map { formatCode("${languageService.render(it)}") }
+                                    for (signature in signatures) {
+                                        appendText(to, signature)
+                                    }
+
+                                    if (!summary.isEmpty()) {
+                                        appendText(to, formatText(summary))
                                     }
                                 }
                             }
diff --git a/src/Kotlin/CrossReferences.kt b/src/Kotlin/CrossReferences.kt
new file mode 100644
index 00000000..7504cebc
--- /dev/null
+++ b/src/Kotlin/CrossReferences.kt
@@ -0,0 +1,37 @@
+package org.jetbrains.dokka
+
+import org.jetbrains.jet.lang.descriptors.ClassKind
+
+/**
+ * Generates cross-references for documentation such as extensions for a type
+ *
+ * $receiver: [DocumentationContext] for node/descriptor resolutions
+ * $node: [DocumentationNode] to visit
+ */
+public fun DocumentationContext.buildCrossReferences(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.Type).forEach { detail ->
+        val descriptor = relations[detail]
+        if (descriptor != null) {
+            val typeNode = descriptorToNode[descriptor]
+            if (typeNode != null) {
+                // if typeNode is null, type is external to module
+                detail.addReferenceTo(typeNode, DocumentationReference.Kind.Link)
+            }
+        }
+    }
+
+    for (member in node.members) {
+        buildCrossReferences(member)
+    }
+}
+
diff --git a/src/Kotlin/DocumentationBuildingVisitor.kt b/src/Kotlin/DocumentationBuildingVisitor.kt
index 5654903b..754ef8ef 100644
--- a/src/Kotlin/DocumentationBuildingVisitor.kt
+++ b/src/Kotlin/DocumentationBuildingVisitor.kt
@@ -32,7 +32,7 @@ class DocumentationBuildingVisitor(val context: BindingContext,
     private fun processCallable(descriptor: CallableDescriptor, data: DocumentationNode): DocumentationNode {
         val node = createDocumentation(descriptor, data)
         visitChildren(descriptor.getTypeParameters(), node)
-        visitChild(descriptor.getReceiverParameter(), node)
+        visitChild(descriptor.getExtensionReceiverParameter(), node)
         visitChildren(descriptor.getValueParameters(), node)
         return node
     }
diff --git a/src/Kotlin/DocumentationContext.kt b/src/Kotlin/DocumentationContext.kt
index ec9e748f..1fada8b3 100644
--- a/src/Kotlin/DocumentationContext.kt
+++ b/src/Kotlin/DocumentationContext.kt
@@ -6,10 +6,23 @@ import org.jetbrains.jet.lang.resolve.scopes.JetScope
 import org.jetbrains.jet.lang.descriptors.ModuleDescriptor
 import org.jetbrains.jet.lang.resolve.name.FqName
 
+/**
+ * Context for documentation generation.
+ *
+ * Holds information about relations between nodes and descriptors during documentation generation
+ *
+ * %bindingContext: symbol resolution context
+ */
 public class DocumentationContext(val bindingContext: BindingContext) {
     val descriptorToNode = hashMapOf<DeclarationDescriptor, DocumentationNode>()
     val nodeToDescriptor = hashMapOf<DocumentationNode, DeclarationDescriptor>()
 
+    val relations = hashMapOf<DocumentationNode, DeclarationDescriptor>()
+
+    fun attach(node: DocumentationNode, descriptor: DeclarationDescriptor) {
+        relations.put(node, descriptor)
+    }
+
     fun register(descriptor: DeclarationDescriptor, node: DocumentationNode) {
         descriptorToNode.put(descriptor, node)
         nodeToDescriptor.put(node, descriptor)
@@ -41,6 +54,8 @@ fun BindingContext.createDocumentationModule(name: String,
         pkg!!.accept(DocumentationBuildingVisitor(this, options, visitor), documentationModule)
     }
 
+    context.buildCrossReferences(documentationModule)
+
     // TODO: Uncomment for resolve verification
     // checkResolveChildren(documentationModule)
     return documentationModule
diff --git a/src/Kotlin/DocumentationNodeBuilder.kt b/src/Kotlin/DocumentationNodeBuilder.kt
index 535f037f..66f71bf6 100644
--- a/src/Kotlin/DocumentationNodeBuilder.kt
+++ b/src/Kotlin/DocumentationNodeBuilder.kt
@@ -21,10 +21,11 @@ class DocumentationNodeBuilder(val context: DocumentationContext) : DeclarationD
 
     fun reference(from: DocumentationNode, to: DocumentationNode, kind: DocumentationReference.Kind) {
         from.addReferenceTo(to, kind)
-        if (kind == DocumentationReference.Kind.Link)
-            to.addReferenceTo(from, DocumentationReference.Kind.Link)
-        else
-            to.addReferenceTo(from, DocumentationReference.Kind.Owner)
+        when (kind) {
+            DocumentationReference.Kind.Detail -> to.addReferenceTo(from, DocumentationReference.Kind.Owner)
+            DocumentationReference.Kind.Member -> to.addReferenceTo(from, DocumentationReference.Kind.Owner)
+            DocumentationReference.Kind.Owner -> to.addReferenceTo(from, DocumentationReference.Kind.Member)
+        }
     }
 
     fun addModality(descriptor: MemberDescriptor, data: DocumentationNode) {
@@ -42,15 +43,16 @@ class DocumentationNodeBuilder(val context: DocumentationContext) : DeclarationD
     fun addType(descriptor: DeclarationDescriptor, t: JetType?, data: DocumentationNode) {
         if (t == null)
             return
-        val typeConstructor = t.getConstructor()
-        val classifierDescriptor = typeConstructor.getDeclarationDescriptor()
+        val classifierDescriptor = t.getConstructor().getDeclarationDescriptor()
         val name = when (classifierDescriptor) {
             is Named -> classifierDescriptor.getName().asString()
             else -> "<anonymous>"
         }
         val node = DocumentationNode(name, Content.Empty, DocumentationNode.Kind.Type)
-        reference(data, node, DocumentationReference.Kind.Detail)
+        if (classifierDescriptor != null)
+            context.attach(node, classifierDescriptor)
 
+        reference(data, node, DocumentationReference.Kind.Detail)
         for (param in t.getArguments())
             addType(descriptor, param.getType(), node)
     }
@@ -59,7 +61,7 @@ class DocumentationNodeBuilder(val context: DocumentationContext) : DeclarationD
         descriptor!!
         val doc = context.parseDocumentation(descriptor)
         val node = DocumentationNode(descriptor.getName().asString(), doc, DocumentationNode.Kind.Unknown)
-        reference(data!!, node, DocumentationReference.Kind.Link)
+        reference(data!!, node, DocumentationReference.Kind.Member)
         context.register(descriptor, node)
         return node
     }
diff --git a/src/Model/DocumentationNode.kt b/src/Model/DocumentationNode.kt
index 198e549b..cb6a13db 100644
--- a/src/Model/DocumentationNode.kt
+++ b/src/Model/DocumentationNode.kt
@@ -14,6 +14,8 @@ public open class DocumentationNode(val name: String,
         get() = references(DocumentationReference.Kind.Detail).map { it.to }
     public val members: List<DocumentationNode>
         get() = references(DocumentationReference.Kind.Member).map { it.to }
+    public val extensions: List<DocumentationNode>
+        get() = references(DocumentationReference.Kind.Extension).map { it.to }
     public val links: List<DocumentationNode>
         get() = references(DocumentationReference.Kind.Link).map { it.to }
 
diff --git a/src/Model/DocumentationReference.kt b/src/Model/DocumentationReference.kt
index 41cca8db..fdc29b9e 100644
--- a/src/Model/DocumentationReference.kt
+++ b/src/Model/DocumentationReference.kt
@@ -6,6 +6,7 @@ public data class DocumentationReference(val from: DocumentationNode, val to: Do
         Member
         Detail
         Link
+        Extension
         Override
     }
 }
diff --git a/src/Processing/CrossReferences.kt b/src/Processing/CrossReferences.kt
deleted file mode 100644
index 9f21da6e..00000000
--- a/src/Processing/CrossReferences.kt
+++ /dev/null
@@ -1,12 +0,0 @@
-package org.jetbrains.dokka
-
-public fun DocumentationNode.buildCrossReferences() {
-    for (member in members) {
-        member.buildCrossReferences()
-        member.details(DocumentationNode.Kind.Receiver).forEach { detail ->
-
-
-        }
-    }
-}
-
diff --git a/src/main.kt b/src/main.kt
index a541831d..409e030a 100644
--- a/src/main.kt
+++ b/src/main.kt
@@ -59,12 +59,6 @@ public fun main(args: Array<String>) {
     val timeAnalyse = System.currentTimeMillis() - startAnalyse
     println("done in ${timeAnalyse / 1000} secs")
 
-    print("Processing cross references... ")
-    val startProcessing = System.currentTimeMillis()
-    documentation.buildCrossReferences()
-    val timeProcessing = System.currentTimeMillis() - startProcessing
-    println("done in ${timeProcessing / 1000} secs")
-
     val startBuild = System.currentTimeMillis()
     val signatureGenerator = KotlinLanguageService()
     val locationService = FoldersLocationService(arguments.outputDir)
-- 
cgit