Display values of java constants (#2609)

Fixes #2524
Kotlin · Aug 17, 2022 · d755694 · d755694
1 parent a7c3113
commit d755694
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 0 deletions.
diff --git a/plugins/base/src/main/kotlin/translators/psi/DefaultPsiToDocumentableTranslator.kt b/plugins/base/src/main/kotlin/translators/psi/DefaultPsiToDocumentableTranslator.kt
@@ -658,6 +658,7 @@ class DefaultPsiToDocumentableTranslator(
                         inheritedFrom?.let { inheritedFrom -> InheritedMember(inheritedFrom.toSourceSetDependent()) },
                         it.toSourceSetDependent().toAdditionalModifiers(),
                         annotations.toSourceSetDependent().toAnnotations(),
+                        psi.getConstantExpression()?.let { DefaultValue(it.toSourceSetDependent()) },
                         takeIf { isVar }?.let { IsVar }
                     )
                 }
@@ -671,6 +672,22 @@ class DefaultPsiToDocumentableTranslator(
         private fun Collection<PsiAnnotation>.toListOfAnnotations() =
             filter { it !is KtLightAbstractAnnotation }.mapNotNull { it.toAnnotation() }
 
+        private fun PsiField.getConstantExpression(): Expression? {
+            val constantValue = this.computeConstantValue() ?: return null
+            return when (constantValue) {
+                is Byte -> IntegerConstant(constantValue.toLong())
+                is Short -> IntegerConstant(constantValue.toLong())
+                is Int -> IntegerConstant(constantValue.toLong())
+                is Long -> IntegerConstant(constantValue)
+                is Char -> StringConstant(constantValue.toString())
+                is String -> StringConstant(constantValue)
+                is Double -> DoubleConstant(constantValue)
+                is Float -> FloatConstant(constantValue)
+                is Boolean -> BooleanConstant(constantValue)
+                else -> ComplexExpression(constantValue.toString())
+            }
+        }
+
         private fun JvmAnnotationAttribute.toValue(): AnnotationParameterValue = when (this) {
             is PsiNameValuePair -> value?.toValue() ?: attributeValue?.toValue() ?: StringValue("")
             else -> StringValue(this.attributeName)

diff --git a/plugins/base/src/test/kotlin/translators/DefaultPsiToDocumentableTranslatorTest.kt b/plugins/base/src/test/kotlin/translators/DefaultPsiToDocumentableTranslatorTest.kt
@@ -198,6 +198,51 @@ class DefaultPsiToDocumentableTranslatorTest : BaseAbstractTest() {
         }
     }
 
+    @Test
+    fun `should add default value to constant properties`() {
+        testInline(
+            """
+            |/src/main/java/test/JavaConstants.java
+            |package test;
+            |
+            |public class JavaConstants {
+            |    public static final byte BYTE = 1;
+            |    public static final short SHORT = 2;
+            |    public static final int INT = 3;
+            |    public static final long LONG = 4L;
+            |    public static final float FLOAT = 5.0f;
+            |    public static final double DOUBLE = 6.0d;
+            |    public static final String STRING = "Seven";
+            |    public static final char CHAR = 'E';
+            |    public static final boolean BOOLEAN = true;
+            |}
+            """.trimIndent(),
+            configuration
+        ) {
+            documentablesMergingStage = { module ->
+                val testedClass = module.packages.single().classlikes.single { it.name == "JavaConstants" }
+
+                val constants = testedClass.properties
+                assertEquals(9, constants.size)
+
+                val constantsByName = constants.associateBy { it.name }
+                fun getConstantExpression(name: String): Expression? {
+                    return constantsByName.getValue(name).extra[DefaultValue]?.expression?.values?.first()
+                }
+
+                assertEquals(IntegerConstant(1), getConstantExpression("BYTE"))
+                assertEquals(IntegerConstant(2), getConstantExpression("SHORT"))
+                assertEquals(IntegerConstant(3), getConstantExpression("INT"))
+                assertEquals(IntegerConstant(4), getConstantExpression("LONG"))
+                assertEquals(FloatConstant(5.0f), getConstantExpression("FLOAT"))
+                assertEquals(DoubleConstant(6.0), getConstantExpression("DOUBLE"))
+                assertEquals(StringConstant("Seven"), getConstantExpression("STRING"))
+                assertEquals(StringConstant("E"), getConstantExpression("CHAR"))
+                assertEquals(BooleanConstant(true), getConstantExpression("BOOLEAN"))
+            }
+        }
+    }
+
     @Test
     fun `should resolve static imports used as annotation param values as literal values`() {
         testInline(