Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support definitely non-nullable types #2520

Merged
merged 2 commits into from Jun 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions core/api/core.api
Expand Up @@ -1378,6 +1378,17 @@ public final class org/jetbrains/dokka/model/DefaultValue$Companion : org/jetbra
public fun mergeStrategyFor (Lorg/jetbrains/dokka/model/DefaultValue;Lorg/jetbrains/dokka/model/DefaultValue;)Lorg/jetbrains/dokka/model/properties/MergeStrategy;
}

public final class org/jetbrains/dokka/model/DefinitelyNonNullable : org/jetbrains/dokka/model/Bound {
public fun <init> (Lorg/jetbrains/dokka/model/Bound;)V
public final fun component1 ()Lorg/jetbrains/dokka/model/Bound;
public final fun copy (Lorg/jetbrains/dokka/model/Bound;)Lorg/jetbrains/dokka/model/DefinitelyNonNullable;
public static synthetic fun copy$default (Lorg/jetbrains/dokka/model/DefinitelyNonNullable;Lorg/jetbrains/dokka/model/Bound;ILjava/lang/Object;)Lorg/jetbrains/dokka/model/DefinitelyNonNullable;
public fun equals (Ljava/lang/Object;)Z
public final fun getInner ()Lorg/jetbrains/dokka/model/Bound;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class org/jetbrains/dokka/model/DisplaySourceSet : org/jetbrains/dokka/utilities/SelfRepresentingSingletonSet {
public fun <init> (Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;)V
public fun <init> (Lorg/jetbrains/dokka/model/CompositeSourceSetID;Ljava/lang/String;Lorg/jetbrains/dokka/Platform;)V
Expand Down
5 changes: 5 additions & 0 deletions core/src/main/kotlin/model/Documentable.kt
Expand Up @@ -459,6 +459,11 @@ data class UnresolvedBound(
// The following Projections are not AnnotationTargets; they cannot be annotated.
data class Nullable(val inner: Bound) : Bound()

/**
* It introduces [definitely non-nullable types](https://github.com/Kotlin/KEEP/blob/c72601cf35c1e95a541bb4b230edb474a6d1d1a8/proposals/definitely-non-nullable-types.md)
*/
data class DefinitelyNonNullable(val inner: Bound) : Bound()

sealed class Variance<out T : Bound> : Projection() {
abstract val inner: T
}
Expand Down
Expand Up @@ -430,6 +430,11 @@ class KotlinSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLog
signatureForProjection(p.inner, showFullyQualifiedName)
operator("?")
}
is DefinitelyNonNullable -> group(styles = emptySet()) {
signatureForProjection(p.inner, showFullyQualifiedName)
operator(" & ")
link("Any", DriOfAny)
}

is TypeAliased -> signatureForProjection(p.typeAlias)
is JavaObject -> {
Expand Down
Expand Up @@ -39,6 +39,7 @@ object KotlinSignatureUtils : JvmSignatureUtils {
is TypeParameter -> dri
is TypeConstructor -> dri
is Nullable -> inner.driOrNull
is DefinitelyNonNullable -> inner.driOrNull
is PrimitiveJavaType -> dri
is Void -> DriOfUnit
is JavaObject -> DriOfAny
Expand All @@ -52,6 +53,7 @@ object KotlinSignatureUtils : JvmSignatureUtils {
is TypeParameter -> listOf(dri)
is TypeConstructor -> listOf(dri) + projections.flatMap { it.drisOfAllNestedBounds }
is Nullable -> inner.drisOfAllNestedBounds
is DefinitelyNonNullable -> inner.drisOfAllNestedBounds
is PrimitiveJavaType -> listOf(dri)
is Void -> listOf(DriOfUnit)
is JavaObject -> listOf(DriOfAny)
Expand Down
Expand Up @@ -9,7 +9,6 @@ import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.flow
import kotlinx.coroutines.flow.flowOn
import kotlinx.coroutines.flow.toList
import org.jetbrains.dokka.base.signatures.KotlinSignatureUtils.driOrNull
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.links.DriOfAny
import org.jetbrains.dokka.model.*
Expand Down Expand Up @@ -91,6 +90,7 @@ private fun Callable.asPairsWithReceiverDRIs(): Sequence<Pair<DRI, Callable>> =
// care about it since there is nowhere to put documentation of given extension.
private fun Callable.findReceiverDRIs(bound: Bound): Sequence<DRI> = when (bound) {
is Nullable -> findReceiverDRIs(bound.inner)
is DefinitelyNonNullable -> findReceiverDRIs(bound.inner)
is TypeParameter ->
if (this is DFunction && bound.dri == this.dri)
generics.find { it.name == bound.name }?.bounds?.asSequence()?.flatMap(::findReceiverDRIs).orEmpty()
Expand Down
Expand Up @@ -910,6 +910,9 @@ private class DokkaDescriptorVisitor(
expandedType.toBound(),
annotations()
)
is DefinitelyNotNullType -> DefinitelyNonNullable(
original.toBound()
)
else -> when (val ctor = constructor.declarationDescriptor) {
is TypeParameterDescriptor -> TypeParameter(
dri = DRI.from(ctor),
Expand Down
37 changes: 37 additions & 0 deletions plugins/base/src/test/kotlin/signatures/SignatureTest.kt
Expand Up @@ -2,8 +2,12 @@ package signatures

import org.jetbrains.dokka.DokkaSourceSetID
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.model.DFunction
import org.jetbrains.dokka.model.DefinitelyNonNullable
import org.jetbrains.dokka.model.dfs
import org.junit.jupiter.api.Test
import utils.*
import kotlin.test.assertEquals
import kotlin.test.assertFalse

class SignatureTest : BaseAbstractTest() {
Expand Down Expand Up @@ -185,6 +189,39 @@ class SignatureTest : BaseAbstractTest() {
}
}

@Test
fun `fun with definitely non-nullable types`() {
val source = source("fun <T> elvisLike(x: T, y: T & Any): T & Any = x ?: y")
val writerPlugin = TestOutputWriterPlugin()

testInline(
source,
configuration,
pluginOverrides = listOf(writerPlugin)
) {
documentablesTransformationStage = {
val fn = (it.dfs { it.name == "elvisLike" } as? DFunction).assertNotNull("Function elvisLike")

assert(fn.type is DefinitelyNonNullable)
assert(fn.parameters[1].type is DefinitelyNonNullable)
}
renderingStage = { _, _ ->
IgnatBeresnev marked this conversation as resolved.
Show resolved Hide resolved
val signature = writerPlugin.writer.renderedContent("root/example/elvis-like.html")
assertEquals(2, signature.select("a[href=\"https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html\"]").size)
signature.firstSignature().match(
"fun <", A("T"), "> ", A("elvisLike"),
"(",
Span(
Span("x: ", A("T"), ", "),
Span("y: ", A("T"), " & ", A("Any"))
),
"): ", A("T"), " & ", A("Any"), Span(),
ignoreSpanWithTokenStyle = true
)
}
}
}

@Test
fun `fun with keywords, params and generic bound`() {
val source = source("inline suspend fun <T : String> simpleFun(a: Int, b: String): T = \"Celebrimbor\" as T")
Expand Down
1 change: 1 addition & 0 deletions plugins/base/src/test/kotlin/utils/TestUtils.kt
Expand Up @@ -66,6 +66,7 @@ val DClass.supers
val Bound.name: String?
get() = when (this) {
is Nullable -> inner.name
is DefinitelyNonNullable -> inner.name
is TypeParameter -> name
is PrimitiveJavaType -> name
is TypeConstructor -> dri.classNames
Expand Down
Expand Up @@ -205,6 +205,7 @@ class JavadocSignatureProvider(ctcc: CommentsToContentConverter, logger: DokkaLo
}
is Star -> text("?")
is Nullable -> signatureForProjection(p.inner)
is DefinitelyNonNullable -> signatureForProjection(p.inner)
is JavaObject, is Dynamic -> link("Object", DRI("java.lang", "Object"))
is Void -> text("void")
is PrimitiveJavaType -> text(p.name)
Expand Down
Expand Up @@ -305,6 +305,7 @@ private fun Bound.asJava(): Bound = when (this) {
inner = inner.asJava()
)
is Nullable -> copy(inner.asJava())
is DefinitelyNonNullable -> copy(inner.asJava())
is PrimitiveJavaType -> this
is Void -> this
is JavaObject -> this
Expand Down
Expand Up @@ -196,6 +196,7 @@ class JavaSignatureProvider internal constructor(ctcc: CommentsToContentConverte
is Star -> operator("?")

is Nullable -> signatureForProjection(p.inner)
is DefinitelyNonNullable -> signatureForProjection(p.inner)
IgnatBeresnev marked this conversation as resolved.
Show resolved Hide resolved

is JavaObject, is Dynamic -> link("Object", DRI("java.lang", "Object"))
is Void -> text("void")
Expand Down
@@ -0,0 +1,59 @@
package kotlinAsJavaPlugin

import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.jdk
import org.junit.jupiter.api.Test
import signatures.firstSignature
import signatures.renderedContent
import utils.*

class KotlinAsJavaSignatureTest : BaseAbstractTest() {

private val configuration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
externalDocumentationLinks = listOf(
DokkaConfiguration.ExternalDocumentationLink.jdk(8),
stdlibExternalDocumentationLink
)
}
}
}

@Suppress("SameParameterValue")
private fun source(signature: String) =
"""
|/src/main/kotlin/kotlinAsJavaPlugin/Test.kt
|package kotlinAsJavaPlugin
|
| $signature
""".trimIndent()

@Test
fun `fun with definitely non-nullable types as java`() {
val source = source("fun <T> elvisLike(x: T, y: T & Any): T & Any = x ?: y")
val writerPlugin = TestOutputWriterPlugin()

testInline(
source,
configuration,
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val signature = writerPlugin.writer.renderedContent("root/kotlinAsJavaPlugin/-test-kt/elvis-like.html").firstSignature()
signature.match(
"public final static ", Span("T"), A("elvisLike"),
"<T extends ", A("Any"), ">(",
Span(
Span(Span(), " x, "),
Span(Span(), " y")
),
")", Span(),
ignoreSpanWithTokenStyle = true
)
}
}
}
}