moved (meta-)model data classes to open-api

slisson · slisson · commit 0ca7ea54d5b0 · 2023-01-22T12:55:52.000+01:00
diff --git a/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/ConceptInLanguage.kt b/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/ConceptInLanguage.kt
@@ -1,6 +1,12 @@
 package org.modelix.metamodel.generator
 
 import org.modelix.model.api.IConcept
+import org.modelix.model.data.ChildLinkData
+import org.modelix.model.data.ConceptData
+import org.modelix.model.data.IConceptFeatureData
+import org.modelix.model.data.LanguageData
+import org.modelix.model.data.PropertyData
+import org.modelix.model.data.ReferenceLinkData
 
 class LanguageSet(languages: List<LanguageData>) {
     private val languagesMap = HashMap<String, LanguageInSet>()
diff --git a/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/ConceptsFilter.kt b/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/ConceptsFilter.kt
@@ -1,5 +1,7 @@
 package org.modelix.metamodel.generator
 
+import org.modelix.model.data.LanguageData
+
 class ConceptsFilter(val languageSet: LanguageSet) {
     private val includedConcepts: MutableSet<String> = HashSet()
     private val includedLanguages: MutableSet<String> = HashSet()
diff --git a/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/MetaModelDSL.kt b/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/MetaModelDSL.kt
@@ -1,5 +1,11 @@
 package org.modelix.metamodel.generator
 
+import org.modelix.model.data.LanguageData
+import org.modelix.model.data.ConceptData
+import org.modelix.model.data.PropertyData
+import org.modelix.model.data.ChildLinkData
+import org.modelix.model.data.ReferenceLinkData
+
 fun newLanguage(name: String, body: LanguageBuilder.()->Unit): LanguageData {
     return LanguageBuilder(name).apply(body).build()
 }
diff --git a/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/MetaModelDefinition.kt b/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/MetaModelDefinition.kt
@@ -8,6 +8,7 @@ import kotlinx.serialization.json.Json
 import java.io.File
 
 @Serializable
+@Deprecated("use org.modelix.mode.data.*")
 data class LanguageData(
     val uid: String? = null,
     val name: String,
@@ -31,6 +32,7 @@ data class LanguageData(
 }
 
 @Serializable
+@Deprecated("use org.modelix.mode.data.*")
 data class ConceptData(
     val uid: String? = null,
     val name: String,
@@ -41,23 +43,27 @@ data class ConceptData(
     val extends: List<String> = emptyList(),
 )
 
+@Deprecated("use org.modelix.mode.data.*")
 sealed interface IConceptFeatureData {
     val uid: String?
     val name: String
 }
 
 @Serializable
+@Deprecated("use org.modelix.mode.data.*")
 data class PropertyData (
     override val uid: String? = null,
     override val name: String,
     val type: PropertyType = PropertyType.STRING
 ) : IConceptFeatureData
 
+@Deprecated("use org.modelix.mode.data.*")
 enum class PropertyType {
     STRING, BOOLEAN, INT
 }
 
 @Serializable
+@Deprecated("use org.modelix.mode.data.*")
 data class ChildLinkData(
     override val uid: String? = null,
     override val name: String,
@@ -67,6 +73,7 @@ data class ChildLinkData(
 ) : IConceptFeatureData
 
 @Serializable
+@Deprecated("use org.modelix.mode.data.*")
 data class ReferenceLinkData(
     override val uid: String? = null,
     override val name: String,
diff --git a/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/MetaModelGenerator.kt b/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/MetaModelGenerator.kt
@@ -6,6 +6,12 @@ import org.modelix.metamodel.*
 import org.modelix.model.api.*
 import java.nio.file.Path
 import kotlin.reflect.KClass
+import org.modelix.model.data.LanguageData
+import org.modelix.model.data.ConceptData
+import org.modelix.model.data.PropertyData
+import org.modelix.model.data.ChildLinkData
+import org.modelix.model.data.ReferenceLinkData
+import org.modelix.model.data.PropertyType
 
 private val reservedPropertyNames: Set<String> = setOf(
     "constructor", // already exists on JS objects
diff --git a/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/TypescriptMMGenerator.kt b/metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/TypescriptMMGenerator.kt
@@ -2,6 +2,11 @@ package org.modelix.metamodel.generator
 
 import java.nio.file.Path
 import kotlin.io.path.writeText
+import org.modelix.model.data.LanguageData
+import org.modelix.model.data.PropertyData
+import org.modelix.model.data.ChildLinkData
+import org.modelix.model.data.ReferenceLinkData
+import org.modelix.model.data.PropertyType
 
 class TypescriptMMGenerator(val outputDir: Path) {
 
diff --git a/metamodel-generator/src/test/kotlin/org/modelix/metamodel/generator/KotlinGeneratorTest.kt b/metamodel-generator/src/test/kotlin/org/modelix/metamodel/generator/KotlinGeneratorTest.kt
@@ -4,6 +4,7 @@ import com.charleskorn.kaml.Yaml
 import kotlinx.serialization.decodeFromString
 import org.junit.Test
 import java.io.File
+import org.modelix.model.data.LanguageData
 
 class KotlinGeneratorTest {
 
diff --git a/metamodel-gradle/build.gradle.kts b/metamodel-gradle/build.gradle.kts
@@ -29,6 +29,7 @@ dependencies {
     implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
 
     implementation(project(":metamodel-generator"))
+    implementation(project(":model-api"))
 }
 
 // ------------- Download MPS for the functional test ------------------------------------------------------------------
@@ -75,6 +76,7 @@ testing {
             dependencies {
                 // functionalTest test suite depends on the production code in tests
                 implementation(project)
+                implementation(project(":model-api"))
                 implementation(project(":metamodel-generator"))
                 implementation(project(":metamodel-export-mps"))
             }
diff --git a/metamodel-gradle/src/functionalTest/kotlin/org/modelix/metamodel/gradle/MetaModelGradlePluginFunctionalTest.kt b/metamodel-gradle/src/functionalTest/kotlin/org/modelix/metamodel/gradle/MetaModelGradlePluginFunctionalTest.kt
@@ -4,13 +4,12 @@
 package org.modelix.metamodel.gradle
 
 import java.io.File
-import java.nio.file.Files
 import kotlin.test.assertTrue
 import kotlin.test.Test
 import org.gradle.testkit.runner.GradleRunner
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder
-import org.modelix.metamodel.generator.LanguageData
+import org.modelix.model.data.LanguageData
 
 /**
  * A simple functional test for the 'org.modelix.metamodel.gradle.greeting' plugin.
diff --git a/metamodel-gradle/src/main/kotlin/org/modelix/metamodel/gradle/GenerateMetaModelSources.kt b/metamodel-gradle/src/main/kotlin/org/modelix/metamodel/gradle/GenerateMetaModelSources.kt
@@ -10,7 +10,7 @@ import org.gradle.api.tasks.InputDirectory
 import org.gradle.api.tasks.Optional
 import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskAction
-import org.modelix.metamodel.generator.LanguageData
+import org.modelix.model.data.LanguageData
 import org.modelix.metamodel.generator.LanguageSet
 import org.modelix.metamodel.generator.MetaModelGenerator
 import org.modelix.metamodel.generator.TypescriptMMGenerator
@@ -39,7 +39,7 @@ abstract class GenerateMetaModelSources @Inject constructor(of: ObjectFactory) :
     fun generate() {
         var languages: LanguageSet = LanguageSet(exportedLanguagesDir.get().asFile.walk()
             .filter { it.extension.lowercase() == "json" }
-            .map { LanguageData.fromFile(it) }
+            .map { LanguageData.fromJson(it.readText()) }
             .toList())
         val previousLanguageCount = languages.getLanguages().size
 
diff --git a/metamodel-gradle/src/main/kotlin/org/modelix/metamodel/gradle/MetaModelGradlePlugin.kt b/metamodel-gradle/src/main/kotlin/org/modelix/metamodel/gradle/MetaModelGradlePlugin.kt
@@ -1,19 +1,12 @@
 package org.modelix.metamodel.gradle
 
-import org.apache.tools.ant.taskdefs.ExecuteJava
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.tasks.JavaExec
 import org.gradle.api.tasks.Sync
-import org.modelix.metamodel.generator.LanguageData
-import org.modelix.metamodel.generator.LanguageSet
-import org.modelix.metamodel.generator.MetaModelGenerator
-import org.modelix.metamodel.generator.TypescriptMMGenerator
 import java.io.File
-import java.io.IOException
 import java.net.URL
 import java.util.*
-import java.util.jar.Manifest
 
 class MetaModelGradlePlugin: Plugin<Project> {
     private lateinit var project: Project
diff --git a/metamodel-runtime/src/commonMain/kotlin/org/modelix/metamodel/ModelData.kt b/metamodel-runtime/src/commonMain/kotlin/org/modelix/metamodel/ModelData.kt
@@ -7,6 +7,7 @@ import kotlinx.serialization.json.Json
 import org.modelix.model.api.*
 
 @Serializable
+@Deprecated("use org.modelix.mode.data.*")
 data class ModelData(
     val id: String? = null,
     val root: NodeData,
@@ -59,6 +60,7 @@ data class ModelData(
 }
 
 @Serializable
+@Deprecated("use org.modelix.mode.data.*")
 data class NodeData(
     val id: String? = null,
     val concept: String? = null,
@@ -68,9 +70,11 @@ data class NodeData(
     val references: Map<String, String> = emptyMap(),
 )
 
+@Deprecated("use org.modelix.mode.data.*")
 fun NodeData.uid(model: ModelData): String {
     return (model.id ?: throw IllegalArgumentException("Model has no ID")) +
             "/" +
             (id ?: throw IllegalArgumentException("Node has no ID"))
 }
+@Deprecated("use org.modelix.mode.data.*")
 fun ModelData.nodeUID(node: NodeData): String = node.uid(this)
diff --git a/metamodel-runtime/src/jvmMain/kotlin/org/modelix/metamodel/ModelDataUtils.kt b/metamodel-runtime/src/jvmMain/kotlin/org/modelix/metamodel/ModelDataUtils.kt
@@ -4,6 +4,7 @@ import com.charleskorn.kaml.Yaml
 import kotlinx.serialization.decodeFromString
 import kotlinx.serialization.encodeToString
 import java.io.File
+import org.modelix.model.data.ModelData
 
 fun modelDataFromFile(file: File): ModelData {
     return when (file.extension.lowercase()) {
diff --git a/model-api/build.gradle.kts b/model-api/build.gradle.kts
@@ -32,6 +32,7 @@ tasks.named("check") {
 }
 
 val kotlinLoggingVersion: String by rootProject
+val kotlinxSerializationVersion: String by rootProject
 
 kotlin {
     jvm()
@@ -49,6 +50,7 @@ kotlin {
             dependencies {
                 implementation(kotlin("stdlib-common"))
                 implementation("io.github.microutils:kotlin-logging:$kotlinLoggingVersion")
+                implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$kotlinxSerializationVersion")
             }
         }
         val commonTest by getting {
diff --git a/model-api/src/commonMain/kotlin/org/modelix/model/data/MetaModelData.kt b/model-api/src/commonMain/kotlin/org/modelix/model/data/MetaModelData.kt
@@ -0,0 +1,68 @@
+package org.modelix.model.data
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.decodeFromString
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+
+@Serializable
+data class LanguageData(
+    val uid: String? = null,
+    val name: String,
+    val concepts: List<ConceptData>,
+) {
+
+    fun toJson(): String = prettyJson.encodeToString(this)
+    fun toCompactJson(): String = Json.encodeToString(this)
+
+    companion object {
+        private val prettyJson = Json { prettyPrint = true }
+        fun fromJson(json: String): LanguageData {
+            return Json.decodeFromString(json)
+        }
+    }
+}
+
+@Serializable
+data class ConceptData(
+    val uid: String? = null,
+    val name: String,
+    val abstract: Boolean = false,
+    val properties: List<PropertyData> = emptyList(),
+    val children: List<ChildLinkData> = emptyList(),
+    val references: List<ReferenceLinkData> = emptyList(),
+    val extends: List<String> = emptyList(),
+)
+
+sealed interface IConceptFeatureData {
+    val uid: String?
+    val name: String
+}
+
+@Serializable
+data class PropertyData (
+    override val uid: String? = null,
+    override val name: String,
+    val type: PropertyType = PropertyType.STRING
+) : IConceptFeatureData
+
+enum class PropertyType {
+    STRING, BOOLEAN, INT
+}
+
+@Serializable
+data class ChildLinkData(
+    override val uid: String? = null,
+    override val name: String,
+    val type: String,
+    val multiple: Boolean = false,
+    val optional: Boolean = true,
+) : IConceptFeatureData
+
+@Serializable
+data class ReferenceLinkData(
+    override val uid: String? = null,
+    override val name: String,
+    val type: String,
+    val optional: Boolean = true,
+) : IConceptFeatureData
diff --git a/model-api/src/commonMain/kotlin/org/modelix/model/data/ModelData.kt b/model-api/src/commonMain/kotlin/org/modelix/model/data/ModelData.kt
@@ -0,0 +1,76 @@
+package org.modelix.model.data
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.decodeFromString
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+import org.modelix.model.api.*
+
+@Serializable
+data class ModelData(
+    val id: String? = null,
+    val root: NodeData,
+) {
+    fun toJson(): String = prettyJson.encodeToString(this)
+    fun toCompactJson(): String = Json.encodeToString(this)
+
+    fun load(branch: IBranch) {
+        branch.computeWriteT { t ->
+            val createdNodes = HashMap<String, Long>()
+            val pendingReferences = ArrayList<()->Unit>()
+            val parentId = ITree.ROOT_ID
+            for (nodeData in root.children) {
+                loadNode(nodeData, t, parentId, createdNodes, pendingReferences)
+            }
+            pendingReferences.forEach { it() }
+        }
+    }
+
+    private fun loadNode(
+        nodeData: NodeData,
+        t: IWriteTransaction,
+        parentId: Long,
+        createdNodes: HashMap<String, Long>,
+        pendingReferences: ArrayList<() -> Unit>
+    ) {
+        val conceptRef = nodeData.concept?.let { ConceptReference(it) }
+        val createdId = t.addNewChild(parentId, nodeData.role, -1, conceptRef)
+        if (nodeData.id != null) {
+            createdNodes[nodeData.id] = createdId
+        }
+        for (propertyData in nodeData.properties) {
+            t.setProperty(createdId, propertyData.key, propertyData.value)
+        }
+        for (referenceData in nodeData.references) {
+            pendingReferences += {
+                val target = createdNodes[referenceData.value]?.let { LocalPNodeReference(it) }
+                t.setReferenceTarget(createdId, referenceData.key, target)
+            }
+        }
+        for (childData in nodeData.children) {
+            loadNode(childData, t, createdId, createdNodes, pendingReferences)
+        }
+    }
+
+    companion object {
+        private val prettyJson = Json { prettyPrint = true }
+        fun fromJson(serialized: String): ModelData = Json.decodeFromString(serialized)
+    }
+}
+
+@Serializable
+data class NodeData(
+    val id: String? = null,
+    val concept: String? = null,
+    val role: String? = null,
+    val children: List<NodeData> = emptyList(),
+    val properties: Map<String, String> = emptyMap(),
+    val references: Map<String, String> = emptyMap(),
+)
+
+fun NodeData.uid(model: ModelData): String {
+    return (model.id ?: throw IllegalArgumentException("Model has no ID")) +
+            "/" +
+            (id ?: throw IllegalArgumentException("Node has no ID"))
+}
+fun ModelData.nodeUID(node: NodeData): String = node.uid(this)

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ dependencies {`
`29`	`29`	`implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")`
`30`	`30`
`31`	`31`	`implementation(project(":metamodel-generator"))`
	`32`	`+ implementation(project(":model-api"))`
`32`	`33`	`}`
`33`	`34`
`34`	`35`	`// ------------- Download MPS for the functional test ------------------------------------------------------------------`
`@@ -75,6 +76,7 @@ testing {`
`75`	`76`	`dependencies {`
`76`	`77`	`// functionalTest test suite depends on the production code in tests`
`77`	`78`	`implementation(project)`
	`79`	`+ implementation(project(":model-api"))`
`78`	`80`	`implementation(project(":metamodel-generator"))`
`79`	`81`	`implementation(project(":metamodel-export-mps"))`
`80`	`82`	`}`