Merge pull request #163 from modelix/issue/MODELIX-466

MODELIX-466 Add an interface to all generated enums enforcing the presentation field

Author: mhuster23

model-api-gen-gradle-test/src/test/kotlin/GeneratedApiTest.kt

@@ -8,18 +8,18 @@ import jetbrains.mps.lang.core.L_jetbrains_mps_lang_core
 import jetbrains.mps.lang.editor.*
 import jetbrains.mps.lang.smodel.query.CustomScope_old
 import org.junit.jupiter.api.BeforeAll
-import org.modelix.metamodel.TypedLanguagesRegistry
-import org.modelix.metamodel.typed
-import org.modelix.metamodel.untyped
+import org.modelix.metamodel.*
 import org.modelix.model.ModelFacade
 import org.modelix.model.api.INode
 import org.modelix.model.api.getRootNode
 import org.modelix.model.data.ModelData
 import java.io.File
 import kotlin.reflect.KAnnotatedElement
 import kotlin.reflect.KClass
+import kotlin.reflect.KType
 import kotlin.reflect.full.findAnnotation
 import kotlin.reflect.full.hasAnnotation
+import kotlin.reflect.full.isSubclassOf
 import kotlin.test.Test
 import kotlin.test.assertContains
 import kotlin.test.assertEquals
@@ -35,6 +35,7 @@ class GeneratedApiTest {
         branch.runWrite {
             data.load(branch)
             val node = findNodeWithStyleAttribute(branch.getRootNode())!!.typed(C_FontStyleStyleClassItem.getInstanceInterface())
+            assert(_FontStyle_Enum::class.isSubclassOf(IPropertyValueEnum::class))
             assertContains(_FontStyle_Enum.values(), node.style)
             val enumValue = _FontStyle_Enum.BOLD_ITALIC
             node.style = enumValue

model-api-gen-runtime/src/commonMain/kotlin/org/modelix/metamodel/IPropertyValueEnum.kt

@@ -0,0 +1,18 @@
+package org.modelix.metamodel
+
+/**
+ * Superinterface for enums generated by model-api-gen
+ */
+interface IPropertyValueEnum {
+
+    /**
+     * Name of the enum literal.
+     */
+    val name: String
+
+    /**
+     * Textual representation of the enum value.
+     * Null, if undefined.
+     */
+    val presentation: String?
+}

model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/MetaModelGenerator.kt

@@ -119,6 +119,7 @@ class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameC
         val enumBuilder = TypeSpec.enumBuilder(enum.name)
             .addDeprecationIfNecessary(enum)
             .primaryConstructor(constructorSpec)
+            .addSuperinterface(IPropertyValueEnum::class)
             .addProperty(
                 PropertySpec.builder("uid", String::class)
                     .initializer("uid")
@@ -127,6 +128,7 @@ class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameC
             .addProperty(
                 PropertySpec.builder("presentation", String::class.asTypeName().copy(nullable = true))
                     .initializer("presentation")
+                    .addModifiers(KModifier.OVERRIDE)
                     .build()
             )