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.

Sign up for GitHub

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 inner modifier for java non-static classes #3347

Merged
merged 2 commits into from
Nov 22, 2023
Merged

Support inner modifier for java non-static classes #3347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb395e5
Support `inner` modifier for java non-`static` classes
whyoleg Nov 15, 2023
26259be
Split and move tests to analysis module
whyoleg Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions ...ysis-java-psi/src/main/kotlin/org/jetbrains/dokka/analysis/java/parsers/DokkaPsiParser.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,18 @@ internal class DokkaPsiParser(
val implementedInterfacesExtra =
ImplementedInterfaces(ancestry.allImplementedInterfaces().toSourceSetDependent())

// used only for class and enum
val innerModifierExtra = when {
// top level java classes - no `inner`
psi.containingClass == null -> null
// java `static class` = kotlin `class`
psi.hasModifier(JvmModifier.STATIC) -> null
// java `class` = kotlin `inner class`
else -> setOf(
ExtraModifiers.KotlinOnlyModifiers.Inner
).toSourceSetDependent().toAdditionalModifiers()
}

when {
isAnnotationType ->
DAnnotation(
Expand Down Expand Up @@ -295,6 +307,7 @@ internal class DokkaPsiParser(
isExpectActual = false,
extra = PropertyContainer.withAll(
implementedInterfacesExtra,
innerModifierExtra,
annotations.toList().toListOfAnnotations().toSourceSetDependent()
.toAnnotations()
)
Expand Down Expand Up @@ -341,6 +354,7 @@ internal class DokkaPsiParser(
isExpectActual = false,
extra = PropertyContainer.withAll(
implementedInterfacesExtra,
innerModifierExtra,
annotations.toList().toListOfAnnotations().toSourceSetDependent()
.toAnnotations(),
ancestry.exceptionInSupertypesOrNull()
Expand Down
293 changes: 293 additions & 0 deletions ...c/test/kotlin/org/jetbrains/dokka/analysis/test/jvm/java/InnerModifierJavaAnalysisTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,293 @@
/*
* Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/

package org.jetbrains.dokka.analysis.test.jvm.java

import org.jetbrains.dokka.analysis.test.api.javaTestProject
import org.jetbrains.dokka.analysis.test.api.parse
import org.jetbrains.dokka.model.*
import org.jetbrains.dokka.model.properties.WithExtraProperties
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertTrue

class InnerModifierJavaAnalysisTest {

@Test
fun `top level java declarations should not have kotlin inner modifier`() {
val testProject = javaTestProject {
javaFile(pathFromSrc = "JavaClass.java") {
+"public class JavaClass { }"
}
javaFile(pathFromSrc = "JavaEnum.java") {
+"public enum JavaEnum { S; }"
}
javaFile(pathFromSrc = "JavaInterface.java") {
+"public interface JavaInterface { }"
}
javaFile(pathFromSrc = "JavaAnnotation.java") {
+"public @interface JavaAnnotation { }"
}
}

val module = testProject.parse()
val pkg = module.packages.single()

assertEquals(4, pkg.classlikes.size)

pkg.classlikes.forEach {
@Suppress("UNCHECKED_CAST")
assertTrue((it as WithExtraProperties<Documentable>).kotlinOnlyModifiers().isEmpty())
}
}

@Test
fun `java declarations nested inside interfaces should not have kotlin inner modifier`() {
val testProject = javaTestProject {
javaFile(pathFromSrc = "JavaInterface.java") {
+"""
public interface JavaInterface {
public class InnerClass { }
public static class NestedClass { }
public enum InnerEnum {S}
public static enum NestedEnum {S}
public interface InnerInterface { }
public static interface NestedInterface { }
public @interface InnerAnnotation { }
public static @interface NestedAnnotation { }
}
"""
}
}

val module = testProject.parse()
val pkg = module.packages.single()
val javaInterface = pkg.classlikes.single()

assertTrue(javaInterface is DInterface)
assertEquals(8, javaInterface.classlikes.size)

javaInterface.classlikes.forEach {
@Suppress("UNCHECKED_CAST")
assertTrue((it as WithExtraProperties<Documentable>).kotlinOnlyModifiers().isEmpty())
}
}

@Test
fun `java declarations nested inside annotation interface should not have kotlin inner modifier`() {
val testProject = javaTestProject {
javaFile(pathFromSrc = "JavaAnnotation.java") {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw, for some reason I didn't expect Java to handle root packages correctly, but apparently it works :)

2023-11-22_02-42-14

+"""
public @interface JavaAnnotation {
public class InnerClass { }
public static class NestedClass { }
public enum InnerEnum {S}
public static enum NestedEnum {S}
public interface InnerInterface { }
public static interface NestedInterface { }
public @interface InnerAnnotation { }
public static @interface NestedAnnotation { }
}
"""
}
}

val module = testProject.parse()
val pkg = module.packages.single()
val javaAnnotation = pkg.classlikes.single()

assertTrue(javaAnnotation is DAnnotation)
assertEquals(8, javaAnnotation.classlikes.size)

javaAnnotation.classlikes.forEach {
@Suppress("UNCHECKED_CAST")
assertTrue((it as WithExtraProperties<Documentable>).kotlinOnlyModifiers().isEmpty())
}
}

// java classes tests

@Test
fun `java class nested inside class should have kotlin inner modifiers`() {
val testProject = javaTestProject {
javaFile(pathFromSrc = "JavaClass.java") {
+"""
public class JavaClass {
public class NestedClass { }
}
"""
}
}

val module = testProject.parse()
val pkg = module.packages.single()
val javaClass = pkg.classlikes.single()

assertTrue(javaClass is DClass)
assertEquals("JavaClass", javaClass.name)

val nestedClass = javaClass.classlikes.single()

assertTrue(nestedClass is DClass)
assertEquals("NestedClass", nestedClass.name)

assertEquals(
setOf(ExtraModifiers.KotlinOnlyModifiers.Inner),
nestedClass.kotlinOnlyModifiers().values.single()
)
}

@Test
fun `static java class nested inside class should not have kotlin inner modifiers`() {
val testProject = javaTestProject {
javaFile(pathFromSrc = "JavaClass.java") {
+"""
public class JavaClass {
public static class NestedClass { }
}
"""
}
}

val module = testProject.parse()
val pkg = module.packages.single()
val javaClass = pkg.classlikes.single()

assertTrue(javaClass is DClass)
assertEquals("JavaClass", javaClass.name)

val nestedClass = javaClass.classlikes.single()

assertTrue(nestedClass is DClass)
assertEquals("NestedClass", nestedClass.name)

assertTrue(nestedClass.kotlinOnlyModifiers().isEmpty())
}

@Test
fun `java non-classes nested inside class should not have kotlin inner modifier`() {
val testProject = javaTestProject {
javaFile(pathFromSrc = "JavaClass.java") {
+"""
public class JavaClass {
public enum InnerEnum {S}
public static enum NestedEnum {S}
public interface InnerInterface { }
public static interface NestedInterface { }
public @interface InnerAnnotation { }
public static @interface NestedAnnotation { }
}
"""
}
}

val module = testProject.parse()
val pkg = module.packages.single()
val javaClass = pkg.classlikes.single()

assertTrue(javaClass is DClass)
assertEquals(6, javaClass.classlikes.size)

javaClass.classlikes.forEach {
@Suppress("UNCHECKED_CAST")
assertTrue((it as WithExtraProperties<Documentable>).kotlinOnlyModifiers().isEmpty())
}
}

// java enums tests

@Test
fun `static java class nested inside enum should not have kotlin inner modifiers`() {
val testProject = javaTestProject {
javaFile(pathFromSrc = "JavaEnum.java") {
+"""
public enum JavaEnum { S;
public static class NestedClass { }
}
"""
}
}

val module = testProject.parse()
val pkg = module.packages.single()
val javaEnum = pkg.classlikes.single()

assertTrue(javaEnum is DEnum)
assertEquals("JavaEnum", javaEnum.name)

val nestedClass = javaEnum.classlikes.single()

assertTrue(nestedClass is DClass)
assertEquals("NestedClass", nestedClass.name)

assertTrue(nestedClass.kotlinOnlyModifiers().isEmpty())
}

@Test
fun `java class nested inside enum should have kotlin inner modifiers`() {
val testProject = javaTestProject {
javaFile(pathFromSrc = "JavaEnum.java") {
+"""
public enum JavaEnum { S;
public class NestedClass { }
}
"""
}
}

val module = testProject.parse()
val pkg = module.packages.single()
val javaEnum = pkg.classlikes.single()

assertTrue(javaEnum is DEnum)
assertEquals("JavaEnum", javaEnum.name)

val nestedClass = javaEnum.classlikes.single()

assertTrue(nestedClass is DClass)
assertEquals("NestedClass", nestedClass.name)

assertEquals(
setOf(ExtraModifiers.KotlinOnlyModifiers.Inner),
nestedClass.kotlinOnlyModifiers().values.single()
)
}

@Test
fun `java non-classes nested inside enum should not have kotlin inner modifier`() {
val testProject = javaTestProject {
javaFile(pathFromSrc = "JavaEnum.java") {
+"""
public enum JavaEnum { S;
public enum InnerEnum {S}
public static enum NestedEnum {S}
public interface InnerInterface { }
public static interface NestedInterface { }
public @interface InnerAnnotation { }
public static @interface NestedAnnotation { }
}
"""
}
}

val module = testProject.parse()
val pkg = module.packages.single()
val javaEnum = pkg.classlikes.single()

assertTrue(javaEnum is DEnum)
assertEquals(6, javaEnum.classlikes.size)

javaEnum.classlikes.forEach {
@Suppress("UNCHECKED_CAST")
assertTrue((it as WithExtraProperties<Documentable>).kotlinOnlyModifiers().isEmpty())
}
}

// copied from org.jetbrains.dokka.base.signatures.KotlinSignatureUtils
private fun <T : Documentable> WithExtraProperties<T>.kotlinOnlyModifiers(): SourceSetDependent<Set<ExtraModifiers>> {
return extra[AdditionalModifiers]?.content?.entries?.associate {
it.key to it.value.filterIsInstance<ExtraModifiers.KotlinOnlyModifiers>().toSet()
} ?: emptyMap()
}
}
Loading