Conditionally warn about Java/Kotlin attributes mismatch

In order to ease transition from Java to Kotlin
the users have the possibility to enable warnings
about mismatch in attributes for elements.

The following new CLI parameter is available
`-enableandroidattributesmismatchwarning` as well as
`GLUECODIUM_ENABLE_ANDROID_ATTRIBUTES_MISMATCH_WARNING`
CMake parameter.

When flag is set to true and an element from LIME file uses
annotations for Java, but it does not use the matching annotation
for Kotlin then the warning is generated (and vice versa).

Signed-off-by: Patryk Wrobel <183546751+pwrobeldev@users.noreply.github.com>

Author: pwrobeldev

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 ### Features
  * Dart/Flutter: the generated code is now compatible with Flutter 3.29 and above. When the user invokes the callback created for lambda/interface from the thread that is the main isolate thread, but outside of isolate context then it is correclty executed. Before this release the thread would deadlock. Now the generated code identifies such case and enters the isolate context before invoking the callback.
+ * Java/Kotlin: in order to ease transition from Java to Kotlin the possibility to conditionally warn about mismatch in attributes used for Java/Kotlin is implemented. The following new CLI parameter is available `-enableandroidattributesmismatchwarning` as well as `GLUECODIUM_ENABLE_ANDROID_ATTRIBUTES_MISMATCH_WARNING` CMake parameter.
 
 ## 13.12.0
 Release date 2025-03-24

cmake/modules/gluecodium/gluecodium/KnownOptionalProperties.cmake

@@ -237,6 +237,15 @@ _gluecodium_define_target_property(
     "This property is initialized by the value of the GLUECODIUM_DART_DISABLE_FINALIZABLE_MARKER_DEFAULT variable if it is set when the function gluecodium_add_generate_command is called."
 )
 
+_gluecodium_define_target_property(
+  GLUECODIUM_ENABLE_ANDROID_ATTRIBUTES_MISMATCH_WARNING
+  BRIEF_DOCS "Enables generation of warnings when attributes for Java and Kotlin do not match."
+  FULL_DOCS
+    "Enables generation of warnings when attributes for Java and Kotlin do not match. "
+    "Option used to ease adjustments of LIME files needed to transition from Java to Kotlin. "
+    "This property is initialized by the value of the GLUECODIUM_ENABLE_ANDROID_ATTRIBUTES_MISMATCH_WARNING_DEFAULT variable if it is set when the function gluecodium_add_generate_command is called."
+)
+
 _gluecodium_define_target_property(
   GLUECODIUM_DART_NAMERULES
   BRIEF_DOCS "The path to a file with name rules for Dart"

cmake/modules/gluecodium/gluecodium/details/runGenerate.cmake

@@ -151,6 +151,7 @@ function(_prepare_gluecodium_config_file file_path placeholder_file)
   _append_boolean_value(swiftexpose "${GLUECODIUM_SWIFT_EXPOSE_INTERNALS}")
   _append_boolean_value(strict "${GLUECODIUM_STRICT_VALIDATION}")
   _append_boolean_value(dartdisablefinalizablemarker "${GLUECODIUM_DART_DISABLE_FINALIZABLE_MARKER}")
+  _append_boolean_value(enableandroidattributesmismatchwarning "${GLUECODIUM_ENABLE_ANDROID_ATTRIBUTES_MISMATCH_WARNING}")
 
   _append_list_option(generators GLUECODIUM_GENERATORS)
   _append_list_option(werror GLUECODIUM_WERROR)

gluecodium/src/main/java/com/here/gluecodium/Gluecodium.kt

@@ -34,6 +34,7 @@ import com.here.gluecodium.generator.common.templates.TemplateEngine
 import com.here.gluecodium.model.lime.LimeModel
 import com.here.gluecodium.model.lime.LimeModelLoader
 import com.here.gluecodium.model.lime.LimeModelLoaderException
+import com.here.gluecodium.validator.LimeAndroidAttributesMismatchValidator
 import com.here.gluecodium.validator.LimeAsyncValidator
 import com.here.gluecodium.validator.LimeConstantRefsValidator
 import com.here.gluecodium.validator.LimeExternalTypesValidator
@@ -178,6 +179,9 @@ class Gluecodium(
             getIndependentValidators(limeLogger) +
                 if (typeRefsValidationResult) getTypeRefDependentValidators(limeLogger) else emptyList()
         val validationResults = validators.map { it.invoke(filteredModel) }
+        if (generatorOptions.enableAndroidAttributesMismatchWarning) {
+            LimeAndroidAttributesMismatchValidator(limeLogger).validate(filteredModel)
+        }
         return typeRefsValidationResult && !validationResults.contains(false)
     }
 

gluecodium/src/main/java/com/here/gluecodium/cli/OptionReader.kt

@@ -128,6 +128,12 @@ object OptionReader {
                     " below 3.6.0. may experience internal compiler error when compiling the generated code, which utilizes " +
                     "'Finalizable' marker)",
             )
+            addOption(
+                "enableandroidattributesmismatchwarning",
+                false,
+                "Enables generation of warnings when attributes for Java and Kotlin do not match. " +
+                    "Option used to ease adjustments of LIME files needed to transition from Java to Kotlin.",
+            )
             addOption(
                 "werror",
                 "warning-as-error",
@@ -233,6 +239,7 @@ object OptionReader {
         getStringValue("dartlookuperrormessage")?.let { generatorOptions.dartLookupErrorMessage = it }
         getStringListValue("werror")?.let { generatorOptions.werror = it.toSet() }
 
+        generatorOptions.enableAndroidAttributesMismatchWarning = getFlagValue("enableandroidattributesmismatchwarning")
         generatorOptions.dartDisableFinalizableMarker = getFlagValue("dartdisablefinalizablemarker")
         generatorOptions.swiftExposeInternals = getFlagValue("swiftexpose")
 

gluecodium/src/main/java/com/here/gluecodium/generator/common/GeneratorOptions.kt

@@ -38,6 +38,7 @@ data class GeneratorOptions(
     var cppExportCommon: String? = null,
     var internalPrefix: String? = null,
     var libraryName: String = "library",
+    var enableAndroidAttributesMismatchWarning: Boolean = false,
     var dartDisableFinalizableMarker: Boolean = false,
     var dartLookupErrorMessage: String =
         "Failed to resolve an FFI function. Perhaps `LibraryContext.init()` was not called.",

gluecodium/src/main/java/com/here/gluecodium/validator/LimeAndroidAttributesMismatchValidator.kt

@@ -0,0 +1,67 @@
+/*
+ * Copyright (C) 2016-2025 HERE Europe B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+package com.here.gluecodium.validator
+
+import com.here.gluecodium.common.LimeLogger
+import com.here.gluecodium.model.lime.LimeAttributeType
+import com.here.gluecodium.model.lime.LimeAttributeValueType
+import com.here.gluecodium.model.lime.LimeModel
+import com.here.gluecodium.model.lime.LimeNamedElement
+
+class LimeAndroidAttributesMismatchValidator(private val limeLogger: LimeLogger) {
+    fun validate(limeModel: LimeModel) {
+        val allElements = limeModel.referenceMap.values
+        allElements.filterIsInstance<LimeNamedElement>().forEach { element ->
+            val javaAttributes = element.attributes.getAllAttributeValueTypes(LimeAttributeType.JAVA)
+            val kotlinAttributes = element.attributes.getAllAttributeValueTypes(LimeAttributeType.KOTLIN)
+            val commonAttributes = kotlinAttributes intersect javaAttributes
+
+            val attributesMissingInJava = kotlinAttributes subtract commonAttributes
+            if (attributesMissingInJava.isNotEmpty()) {
+                logAttributesMismatch(
+                    element = element,
+                    attributes = attributesMissingInJava,
+                    present = "Kotlin",
+                    missing = "Java",
+                )
+            }
+
+            val attributesMissingInKotlin = javaAttributes subtract commonAttributes
+            if (attributesMissingInKotlin.isNotEmpty()) {
+                logAttributesMismatch(
+                    element = element,
+                    attributes = attributesMissingInKotlin,
+                    present = "Java",
+                    missing = "Kotlin",
+                )
+            }
+        }
+    }
+
+    private fun logAttributesMismatch(
+        element: LimeNamedElement,
+        attributes: Set<LimeAttributeValueType>,
+        present: String,
+        missing: String,
+    ) {
+        val warningMessage = "Attributes missing in $missing, but present in $present: $attributes"
+        limeLogger.warning(element, warningMessage)
+    }
+}

lime-runtime/src/main/java/com/here/gluecodium/model/lime/LimeAttributes.kt

@@ -38,6 +38,8 @@ class LimeAttributes private constructor(
         else -> true
     }
 
+    fun getAllAttributeValueTypes(type: LimeAttributeType) = attributes[type]?.keys ?: emptySet()
+
     fun <T> get(
         attributeType: LimeAttributeType,
         valueType: LimeAttributeValueType,