diff --git a/core/src/main/kotlin/model/Documentable.kt b/core/src/main/kotlin/model/Documentable.kt index 0f73c8e1f1..73ab35d41e 100644 --- a/core/src/main/kotlin/model/Documentable.kt +++ b/core/src/main/kotlin/model/Documentable.kt @@ -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 : Projection() { abstract val inner: T } diff --git a/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt b/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt index 294c1d2462..02da3f24fb 100644 --- a/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt +++ b/plugins/base/src/main/kotlin/signatures/KotlinSignatureProvider.kt @@ -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 -> { diff --git a/plugins/base/src/main/kotlin/signatures/KotlinSignatureUtils.kt b/plugins/base/src/main/kotlin/signatures/KotlinSignatureUtils.kt index 0fea9132e9..381fadf11c 100644 --- a/plugins/base/src/main/kotlin/signatures/KotlinSignatureUtils.kt +++ b/plugins/base/src/main/kotlin/signatures/KotlinSignatureUtils.kt @@ -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 @@ -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) diff --git a/plugins/base/src/main/kotlin/transformers/documentables/ExtensionExtractorTransformer.kt b/plugins/base/src/main/kotlin/transformers/documentables/ExtensionExtractorTransformer.kt index 2a8baf0be3..73023a8688 100644 --- a/plugins/base/src/main/kotlin/transformers/documentables/ExtensionExtractorTransformer.kt +++ b/plugins/base/src/main/kotlin/transformers/documentables/ExtensionExtractorTransformer.kt @@ -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.* @@ -91,6 +90,7 @@ private fun Callable.asPairsWithReceiverDRIs(): Sequence> = // care about it since there is nowhere to put documentation of given extension. private fun Callable.findReceiverDRIs(bound: Bound): Sequence = 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() diff --git a/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt b/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt index 57c5fe18a3..f422ef2900 100644 --- a/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt +++ b/plugins/base/src/main/kotlin/translators/descriptors/DefaultDescriptorToDocumentableTranslator.kt @@ -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), diff --git a/plugins/base/src/test/kotlin/signatures/SignatureTest.kt b/plugins/base/src/test/kotlin/signatures/SignatureTest.kt index 2d17b7f8f7..755f6e4794 100644 --- a/plugins/base/src/test/kotlin/signatures/SignatureTest.kt +++ b/plugins/base/src/test/kotlin/signatures/SignatureTest.kt @@ -185,6 +185,31 @@ class SignatureTest : BaseAbstractTest() { } } + @Test + fun `fun with definitely non-nullable types`() { + val source = source("fun elvisLike(x: T, y: T & Any): T & Any = x ?: y") + val writerPlugin = TestOutputWriterPlugin() + + testInline( + source, + configuration, + pluginOverrides = listOf(writerPlugin) + ) { + renderingStage = { _, _ -> + writerPlugin.writer.renderedContent("root/example/elvis-like.html").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 simpleFun(a: Int, b: String): T = \"Celebrimbor\" as T") diff --git a/plugins/base/src/test/kotlin/utils/TestUtils.kt b/plugins/base/src/test/kotlin/utils/TestUtils.kt index 990821109f..e4bc4a1e68 100644 --- a/plugins/base/src/test/kotlin/utils/TestUtils.kt +++ b/plugins/base/src/test/kotlin/utils/TestUtils.kt @@ -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 diff --git a/plugins/kotlin-as-java/src/main/kotlin/converters/KotlinToJavaConverter.kt b/plugins/kotlin-as-java/src/main/kotlin/converters/KotlinToJavaConverter.kt index 8ff357812b..4a21aeae97 100644 --- a/plugins/kotlin-as-java/src/main/kotlin/converters/KotlinToJavaConverter.kt +++ b/plugins/kotlin-as-java/src/main/kotlin/converters/KotlinToJavaConverter.kt @@ -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 diff --git a/plugins/kotlin-as-java/src/main/kotlin/signatures/JavaSignatureProvider.kt b/plugins/kotlin-as-java/src/main/kotlin/signatures/JavaSignatureProvider.kt index 2b56a2bf02..50dbc1cb17 100644 --- a/plugins/kotlin-as-java/src/main/kotlin/signatures/JavaSignatureProvider.kt +++ b/plugins/kotlin-as-java/src/main/kotlin/signatures/JavaSignatureProvider.kt @@ -196,6 +196,7 @@ class JavaSignatureProvider internal constructor(ctcc: CommentsToContentConverte is Star -> operator("?") is Nullable -> signatureForProjection(p.inner) + is DefinitelyNonNullable -> signatureForProjection(p.inner) is JavaObject, is Dynamic -> link("Object", DRI("java.lang", "Object")) is Void -> text("void")