Enhance signature presentation. Support presetnation Java as Kotlin and Kotlin as Java. Refactor annotations creation from PSI/Descriptors. Add proper rendering of annotation signatures in both kotlin syntax and java syntax. Tests for annotations

4 files changed, 275 insertions, 74 deletions

diff --git a/plugins/base/src/main/kotlin/signatures/JvmSingatureUtils.kt b/plugins/base/src/main/kotlin/signatures/JvmSingatureUtils.kt
new file mode 100644
index 00000000..dde553b9
--- /dev/null
+++ b/plugins/base/src/main/kotlin/signatures/JvmSingatureUtils.kt
@@ -0,0 +1,129 @@
+package org.jetbrains.dokka.base.signatures
+
+import javaslang.Tuple2
+import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
+import org.jetbrains.dokka.model.*
+import org.jetbrains.dokka.model.properties.WithExtraProperties
+
+interface JvmSingatureUtils {
+
+    fun PageContentBuilder.DocumentableContentBuilder.annotationsBlock(d: Documentable)
+
+    fun PageContentBuilder.DocumentableContentBuilder.annotationsInline(d: Documentable)
+
+    fun <T : Documentable> WithExtraProperties<T>.modifiers(): Set<ExtraModifiers>
+
+    fun Set<ExtraModifiers>.toSignatureString(): String =
+        joinToString("") { it.name.toLowerCase() + " " }
+
+    fun <T : Documentable> WithExtraProperties<T>.annotations(): List<Annotations.Annotation> =
+        extra[Annotations]?.content ?: emptyList()
+
+    private fun Annotations.Annotation.toSignatureString(): String =
+        "@${this.dri.classNames}(${this.params.entries.joinToString { it.key + "=" + it.value }})"
+
+    private fun PageContentBuilder.DocumentableContentBuilder.annotations(
+        d: Documentable,
+        ignored: Set<Annotations.Annotation>,
+        operation: (Annotations.Annotation) -> Unit
+    ): Unit = when (d) {
+        is DFunction -> d.annotations()
+        is DProperty -> d.annotations()
+        is DClass -> d.annotations()
+        is DInterface -> d.annotations()
+        is DObject -> d.annotations()
+        is DEnum -> d.annotations()
+        is DAnnotation -> d.annotations()
+        is DTypeParameter -> d.annotations()
+        is DEnumEntry -> d.annotations()
+        is DTypeAlias -> d.annotations()
+        is DParameter -> d.annotations()
+        else -> null
+    }?.let {
+        it.filter { it !in ignored }.forEach {
+            operation(it)
+        }
+    } ?: Unit
+
+    fun <T : Documentable> WithExtraProperties<T>.modifiersWithFilter(
+        filter: Set<ExtraModifiers> = ExtraModifiers.values().toSet()
+    ): Set<ExtraModifiers> =
+        extra[AdditionalModifiers]?.content?.filter { it in filter }?.toSet() ?: emptySet()
+
+    fun PageContentBuilder.DocumentableContentBuilder.toSignatureString(
+        a: Annotations.Annotation,
+        renderAtStrategy: AtStrategy,
+        listBrackets: Tuple2<Char, Char>,
+        classExtension: String
+    ) {
+        when (renderAtStrategy) {
+            is All, is OnlyOnce -> text("@")
+            is Never -> Unit
+        }
+        link(a.dri.classNames!!, a.dri)
+        text("(")
+        a.params.entries.forEachIndexed { i, it ->
+            text(it.key + " = ")
+            when (renderAtStrategy) {
+                is All -> All
+                is Never, is OnlyOnce -> Never
+            }.let { strategy ->
+                valueToSignature(it.value, strategy, listBrackets, classExtension)
+            }
+            if (i != a.params.entries.size - 1) text(", ")
+        }
+        text(")")
+    }
+
+    private fun PageContentBuilder.DocumentableContentBuilder.valueToSignature(
+        a: AnnotationParameterValue,
+        renderAtStrategy: AtStrategy,
+        listBrackets: Tuple2<Char, Char>,
+        classExtension: String
+    ): Unit = when (a) {
+        is AnnotationValue -> toSignatureString(a.annotation, renderAtStrategy, listBrackets, classExtension)
+        is ArrayValue -> {
+            text(listBrackets._1.toString())
+            a.value.forEachIndexed { i, it ->
+                valueToSignature(it, renderAtStrategy, listBrackets, classExtension)
+                if (i != a.value.size - 1) text(", ")
+            }
+            text(listBrackets._2.toString())
+        }
+        is EnumValue -> link(a.enumName, a.enumDri)
+        is ClassValue -> link(a.className + classExtension, a.classDRI)
+        is StringValue -> text(a.value)
+    }
+
+    fun PageContentBuilder.DocumentableContentBuilder.annotationsBlockWithIgnored(
+        d: Documentable,
+        ignored: Set<Annotations.Annotation>,
+        renderAtStrategy: AtStrategy,
+        listBrackets: Tuple2<Char, Char>,
+        classExtension: String
+    ) {
+        annotations(d, ignored) {
+            group {
+                toSignatureString(it, renderAtStrategy, listBrackets, classExtension)
+            }
+        }
+    }
+
+    fun PageContentBuilder.DocumentableContentBuilder.annotationsInlineWithIgnored(
+        d: Documentable,
+        ignored: Set<Annotations.Annotation>,
+        renderAtStrategy: AtStrategy,
+        listBrackets: Tuple2<Char, Char>,
+        classExtension: String
+    ) {
+        annotations(d, ignored) {
+            toSignatureString(it, renderAtStrategy, listBrackets, classExtension)
+            text(Typography.nbsp.toString())
+        }
+    }
+}
+
+sealed class AtStrategy
+object All : AtStrategy()
+object OnlyOnce : AtStrategy()
+object Never : AtStrategy()
\ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt b/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt
index 617af959..4c689abc 100644
--- a/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt
+++ b/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt
@@ -6,16 +6,20 @@ import org.jetbrains.dokka.links.*
 import org.jetbrains.dokka.model.*
 import org.jetbrains.dokka.model.Nullable
 import org.jetbrains.dokka.model.TypeConstructor
+import org.jetbrains.dokka.model.properties.ExtraProperty
 import org.jetbrains.dokka.model.properties.WithExtraProperties
 import org.jetbrains.dokka.pages.ContentKind
 import org.jetbrains.dokka.pages.ContentNode
 import org.jetbrains.dokka.pages.TextStyle
 import org.jetbrains.dokka.utilities.DokkaLogger
+import kotlin.text.Typography.nbsp
 
-class KotlinSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLogger) : SignatureProvider {
+class KotlinSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLogger) : SignatureProvider,
+    JvmSingatureUtils by KotlinSignatureUtils {
     private val contentBuilder = PageContentBuilder(ctcc, this, logger)
 
-    private val ignoredVisibilities = setOf(JavaVisibility.Default, KotlinVisibility.Public)
+    private val ignoredVisibilities = setOf(JavaVisibility.Public, KotlinVisibility.Public)
+    private val ignoredModifiers = setOf(JavaModifier.Final, KotlinModifier.Final)
 
     override fun signature(documentable: Documentable): ContentNode = when (documentable) {
         is DFunction -> functionSignature(documentable)
@@ -29,9 +33,10 @@ class KotlinSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLog
         )
     }
 
-    private fun signature(e: DEnumEntry) = contentBuilder.contentFor(e, ContentKind.Symbol, setOf(TextStyle.Monospace)){
-        link(e.name, e.dri)
-    }
+    private fun signature(e: DEnumEntry) =
+        contentBuilder.contentFor(e, ContentKind.Symbol, setOf(TextStyle.Monospace)) {
+            link(e.name, e.dri)
+        }
 
     private fun actualTypealiasedSignature(dri: DRI, name: String, aliasedTypes: SourceSetDependent<Bound>) =
         aliasedTypes.entries.groupBy({ it.value }, { it.key }).map { (bound, platforms) ->
@@ -55,84 +60,121 @@ class KotlinSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLog
 
     private fun regularSignature(c: DClasslike, sourceSets: Set<SourceSetData> = c.sourceSets.toSet()) =
         contentBuilder.contentFor(c, ContentKind.Symbol, setOf(TextStyle.Monospace), sourceSets = sourceSets) {
-            platformText(c.visibility, sourceSets) { (it.takeIf { it !in ignoredVisibilities }?.name ?: "") + " " }
-            if (c is DClass) {
-                platformText(c.modifier, sourceSets) {
-                    if (c.extra[AdditionalModifiers]?.content?.contains(ExtraModifiers.DATA) == true && it.name == "final") "data "
-                    else it.name + " "
+            group(styles = setOf(TextStyle.Block)) {
+                annotationsBlock(c)
+                platformText(
+                    c.visibility,
+                    sourceSets
+                ) { it.takeIf { it !in ignoredVisibilities }?.name?.let { "$it " } ?: "" }
+                if (c is DClass) {
+                    platformText(c.modifier, sourceSets) {
+                        if (it !in ignoredModifiers)
+                            if (c.extra[AdditionalModifiers]?.content?.contains(ExtraModifiers.DATA) == true) ""
+                            else (if (it is JavaModifier.Empty) KotlinModifier.Open else it).let { it.name + " " }
+                        else
+                            ""
+                    }
                 }
-            }
-            when (c) {
-                is DClass -> text("class ")
-                is DInterface -> text("interface ")
-                is DEnum -> text("enum ")
-                is DObject -> text("object ")
-                is DAnnotation -> text("annotation class ")
-            }
-            link(c.name!!, c.dri)
-            if(c is WithGenerics){
-                list(c.generics, prefix = "<", suffix = "> ") {
-                    +buildSignature(it)
+                when (c) {
+                    is DClass -> text("class ")
+                    is DInterface -> text("interface ")
+                    is DEnum -> text("enum ")
+                    is DObject -> text("object ")
+                    is DAnnotation -> text("annotation class ")
                 }
-            }
-            if (c is DClass) {
-                val pConstructor = c.constructors.singleOrNull { it.extra[PrimaryConstructorExtra] != null }
-                list(pConstructor?.parameters.orEmpty(), "(", ")", ",", pConstructor?.sourceSets.orEmpty().toSet()) {
-                    text(it.name ?: "", styles = mainStyles.plus(TextStyle.Bold).plus(TextStyle.Indented))
-                    text(": ")
-                    signatureForProjection(it.type)
+                link(c.name!!, c.dri)
+                if (c is WithGenerics) {
+                    list(c.generics, prefix = "<", suffix = "> ") {
+                        +buildSignature(it)
+                    }
                 }
-            }
-            if (c is WithSupertypes) {
-                c.supertypes.filter { it.key in sourceSets }.map { (p, dris) ->
-                    list(dris, prefix = " : ", sourceSets = setOf(p)) {
-                        link(it.sureClassNames, it, sourceSets = setOf(p))
+                if (c is DClass) {
+                    val pConstructor = c.constructors.singleOrNull { it.extra[PrimaryConstructorExtra] != null }
+                    if (pConstructor?.annotations()?.isNotEmpty() == true) {
+                        text(nbsp.toString())
+                        annotationsInline(pConstructor)
+                        text("constructor")
+                    }
+                    list(
+                        pConstructor?.parameters.orEmpty(),
+                        "(",
+                        ")",
+                        ",",
+                        pConstructor?.sourceSets.orEmpty().toSet()
+                    ) {
+                        annotationsInline(it)
+                        text(it.name ?: "", styles = mainStyles.plus(TextStyle.Bold))
+                        text(": ")
+                        signatureForProjection(it.type)
+                    }
+                }
+                if (c is WithSupertypes) {
+                    c.supertypes.filter { it.key in sourceSets }.map { (s, dris) ->
+                        list(dris, prefix = " : ", sourceSets = setOf(s)) {
+                            link(it.sureClassNames, it, sourceSets = setOf(s))
+                        }
                     }
                 }
             }
         }
 
+
     private fun propertySignature(p: DProperty, sourceSets: Set<SourceSetData> = p.sourceSets.toSet()) =
         contentBuilder.contentFor(p, ContentKind.Symbol, setOf(TextStyle.Monospace), sourceSets = sourceSets) {
-            platformText(p.visibility) { (it.takeIf { it !in ignoredVisibilities }?.name ?: "") + " " }
-            platformText(p.modifier){ it.name + " "}
-            p.setter?.let { text("var ") } ?: text("val ")
-            list(p.generics, prefix = "<", suffix = "> ") {
-                +buildSignature(it)
-            }
-            p.receiver?.also {
-                signatureForProjection(it.type)
-                text(".")
+            group(styles = setOf(TextStyle.Block)) {
+                annotationsBlock(p)
+                platformText(p.visibility) { it.takeIf { it !in ignoredVisibilities }?.name?.let { "$it " } ?: "" }
+                platformText(p.modifier) {
+                    it.takeIf { it !in ignoredModifiers }?.let {
+                        if (it is JavaModifier.Empty) KotlinModifier.Open else it
+                    }?.name?.let { "$it " } ?: ""
+                }
+                text(p.modifiers().toSignatureString())
+                p.setter?.let { text("var ") } ?: text("val ")
+                list(p.generics, prefix = "<", suffix = "> ") {
+                    +buildSignature(it)
+                }
+                p.receiver?.also {
+                    signatureForProjection(it.type)
+                    text(".")
+                }
+                link(p.name, p.dri)
+                text(": ")
+                signatureForProjection(p.type)
             }
-            link(p.name, p.dri)
-            text(": ")
-            signatureForProjection(p.type)
         }
 
     private fun functionSignature(f: DFunction, sourceSets: Set<SourceSetData> = f.sourceSets.toSet()) =
         contentBuilder.contentFor(f, ContentKind.Symbol, setOf(TextStyle.Monospace), sourceSets = sourceSets) {
-            platformText(f.visibility) { (it.takeIf { it !in ignoredVisibilities }?.name ?: "") + " " }
-            platformText(f.modifier) { it.name + " " }
-            text("fun ")
-            list(f.generics, prefix = "<", suffix = "> ") {
-                +buildSignature(it)
-            }
-            f.receiver?.also {
-                signatureForProjection(it.type)
-                text(".")
-            }
-            link(f.name, f.dri)
-            text("(")
-            list(f.parameters) {
-                text(it.name!!)
-                text(": ")
-
-                signatureForProjection(it.type)
-            }
-            text(")")
-            if (f.documentReturnType()) {
-                text(": ")
-                signatureForProjection(f.type)
+            group(styles = setOf(TextStyle.Block)) {
+                annotationsBlock(f)
+                platformText(f.visibility) { it.takeIf { it !in ignoredVisibilities }?.name?.let { "$it " } ?: "" }
+                platformText(f.modifier) {
+                    it.takeIf { it !in ignoredModifiers }?.let {
+                        if (it is JavaModifier.Empty) KotlinModifier.Open else it
+                    }?.name?.let { "$it " } ?: ""
+                }
+                text(f.modifiers().toSignatureString())
+                text("fun ")
+                list(f.generics, prefix = "<", suffix = "> ") {
+                    +buildSignature(it)
+                }
+                f.receiver?.also {
+                    signatureForProjection(it.type)
+                    text(".")
+                }
+                link(f.name, f.dri)
+                list(f.parameters, "(", ")") {
+                    annotationsInline(it)
+                    text(it.modifiers().toSignatureString())
+                    text(it.name!!)
+                    text(": ")
+                    signatureForProjection(it.type)
+                }
+                if (f.documentReturnType()) {
+                    text(": ")
+                    signatureForProjection(f.type)
+                }
             }
         }
 
@@ -152,7 +194,8 @@ class KotlinSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLog
                     setOf(TextStyle.Monospace),
                     sourceSets = platforms.toSet()
                 ) {
-                    platformText(t.visibility) { (it.takeIf { it !in ignoredVisibilities }?.name ?: "") + " " }
+                    platformText(t.visibility) { it.takeIf { it !in ignoredVisibilities }?.name?.let { "$it " } ?: "" }
+                    text(t.modifiers().toSignatureString())
                     text("typealias ")
                     signatureForProjection(t.type)
                     text(" = ")
@@ -175,21 +218,21 @@ class KotlinSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLog
             is TypeConstructor -> if (p.function)
                 +funType(mainDRI.single(), mainPlatformData, p)
             else
-                group {
+                group(styles = emptySet()) {
                     link(p.dri.classNames.orEmpty(), p.dri)
                     list(p.projections, prefix = "<", suffix = ">") {
                         signatureForProjection(it)
                     }
                 }
 
-            is Variance -> group {
+            is Variance -> group(styles = emptySet()) {
                 text(p.kind.toString() + " ")
                 signatureForProjection(p.inner)
             }
 
             is Star -> text("*")
 
-            is Nullable -> group {
+            is Nullable -> group(styles = emptySet()) {
                 signatureForProjection(p.inner)
                 text("?")
             }
@@ -197,6 +240,7 @@ class KotlinSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLog
             is JavaObject -> link("Any", DriOfAny)
             is Void -> link("Unit", DriOfUnit)
             is PrimitiveJavaType -> signatureForProjection(p.translateToKotlin())
+            is Dynamic -> text("dynamic")
         }
 
     private fun funType(dri: DRI, sourceSets: Set<SourceSetData>, type: TypeConstructor) =
diff --git a/plugins/base/src/main/kotlin/signatures/KotlinSignatureUtils.kt b/plugins/base/src/main/kotlin/signatures/KotlinSignatureUtils.kt
new file mode 100644
index 00000000..3ce4be0a
--- /dev/null
+++ b/plugins/base/src/main/kotlin/signatures/KotlinSignatureUtils.kt
@@ -0,0 +1,24 @@
+package org.jetbrains.dokka.base.signatures
+
+import javaslang.Tuple2
+import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
+import org.jetbrains.dokka.model.Documentable
+import org.jetbrains.dokka.model.ExtraModifiers
+import org.jetbrains.dokka.model.ExtraModifiers.Companion.kotlinOnlyModifiers
+import org.jetbrains.dokka.model.properties.WithExtraProperties
+
+object KotlinSignatureUtils : JvmSingatureUtils {
+
+    private val strategy = OnlyOnce
+    private val listBrackets = Tuple2('[', ']')
+    private val classExtension = "::class"
+
+    override fun PageContentBuilder.DocumentableContentBuilder.annotationsBlock(d: Documentable) =
+        annotationsBlockWithIgnored(d, emptySet(), strategy, listBrackets, classExtension)
+
+    override fun PageContentBuilder.DocumentableContentBuilder.annotationsInline(d: Documentable) =
+        annotationsInlineWithIgnored(d, emptySet(), strategy, listBrackets, classExtension)
+
+    override fun <T : Documentable> WithExtraProperties<T>.modifiers() =
+        modifiersWithFilter(kotlinOnlyModifiers)
+}
\ No newline at end of file
diff --git a/plugins/base/src/main/kotlin/signatures/SignatureProvider.kt b/plugins/base/src/main/kotlin/signatures/SignatureProvider.kt
index 041015fc..7d7995b7 100644
--- a/plugins/base/src/main/kotlin/signatures/SignatureProvider.kt
+++ b/plugins/base/src/main/kotlin/signatures/SignatureProvider.kt
@@ -1,8 +1,12 @@
 package org.jetbrains.dokka.base.signatures
 
-import org.jetbrains.dokka.model.Documentable
+import javaslang.Tuple2
+import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
+import org.jetbrains.dokka.model.*
+import org.jetbrains.dokka.model.properties.WithExtraProperties
 import org.jetbrains.dokka.pages.ContentNode
+import org.jetbrains.dokka.pages.TextStyle
 
 interface SignatureProvider {
     fun signature(documentable: Documentable): ContentNode
-}
\ No newline at end of file
+}