resolve conflicts between duplicate role names in the concept hierarchy

Author: slisson

metamodel-generator/src/main/kotlin/org/modelix/metamodel/generator/GeneratorInput.kt

@@ -0,0 +1,228 @@
+/*
+ * 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.
+ */
+package org.modelix.metamodel.generator
+
+import org.modelix.model.api.IConcept
+import org.modelix.model.data.ConceptData
+import org.modelix.model.data.LanguageData
+import org.modelix.model.data.PropertyType
+import kotlin.reflect.KClass
+
+private val reservedPropertyNames: Set<String> = setOf(
+    "constructor", // already exists on JS objects
+) + IConcept::class.members.map { it.name }
+
+interface IProcessedLanguageSet
+fun LanguageSet.process(): IProcessedLanguageSet = ProcessedLanguageSet(getLanguages().map { it.language })
+
+internal class ProcessedLanguageSet(dataList: List<LanguageData>) : IProcessedLanguageSet {
+
+    private val languages: MutableList<ProcessedLanguage> = ArrayList()
+
+    private lateinit var fqName2language: Map<String, ProcessedLanguage>
+    private lateinit var uid2language: Map<String, ProcessedLanguage>
+    private lateinit var fqName2concept: Map<String, ProcessedConcept>
+    private lateinit var uid2concept: Map<String, ProcessedConcept>
+
+    init {
+        load(dataList)
+    }
+
+    fun addLanguage(language: ProcessedLanguage) {
+        languages.add(language)
+        language.languageSet = this
+    }
+
+    fun load(dataList: List<LanguageData>) {
+        for (data in dataList) {
+            addLanguage(ProcessedLanguage(data.name, data.uid).also { lang ->
+                lang.load(data.concepts)
+            })
+        }
+        process()
+    }
+
+    private fun process() {
+        initIndexes()
+        resolveConceptReferences()
+        fixRoleConflicts()
+    }
+
+    private fun initIndexes() {
+        fqName2language = languages.associateBy { it.name }
+        uid2language = languages.filter { it.uid != null }.associateBy { it.uid!! }
+        fqName2concept = languages.flatMap { it.getConcepts() }.associateBy { it.fqName() }
+        uid2concept = languages.flatMap { it.getConcepts() }.filter { it.uid != null }.associateBy { it.uid!! }
+        languages.forEach { lang -> lang.simpleName2concept = lang.getConcepts().associateBy { it.name } }
+    }
+
+    private fun resolveConceptReferences() {
+        val visitor: (ProcessedConceptReference, ProcessedLanguage) -> Unit = { ref, contextLanguage ->
+            ref.resolved = uid2concept[ref.name]
+                ?: fqName2concept[ref.name]
+                ?: contextLanguage.simpleName2concept[ref.name]
+                ?: throw RuntimeException("Failed to resolve concept '${ref.name}'")
+        }
+        languages.forEach { lang -> lang.visitConceptReferences { visitor(it, lang) } }
+    }
+
+    private fun fixRoleConflicts() {
+        val allConcepts = languages.asSequence().flatMap { it.getConcepts() }
+
+        // add type suffix if there are two roles of the same name, but different type
+        allConcepts.forEach { concept ->
+            val conflicts: List<List<ProcessedRole>> = concept.getOwnRoles().groupBy { it.generatedName }.values.filter { it.size > 1 }
+            for (conflict in conflicts) {
+                val conflictsByType: Map<KClass<out ProcessedRole>, List<ProcessedRole>> = conflict.groupBy { it::class }
+                conflictsByType.entries.forEach { conflictByType ->
+                    conflictByType.value.forEach {
+                        it.generatedName += getTypeSuffix(it)
+                    }
+                }
+            }
+        }
+
+        // add number suffix if there are still two roles of the same name
+        allConcepts.forEach { concept ->
+            val conflicts: List<List<ProcessedRole>> = concept.getOwnRoles().groupBy { it.generatedName }.values.filter { it.size > 1 }
+            for (conflict in conflicts) {
+                conflict.forEachIndexed { index, role -> role.generatedName += "_$index" }
+            }
+        }
+
+        // add concept name suffix if there is a role with the same name in a super concept
+        val sameInHierarchyConflicts = HashSet<ProcessedRole>()
+        allConcepts.forEach { concept ->
+            concept.getAllSuperConceptsAndSelf()
+                .flatMap { it.getOwnRoles() }
+                .groupBy { it.generatedName }
+                .values.asSequence()
+                .filter { it.size > 1 }
+                .forEach { sameInHierarchyConflicts.addAll(it) }
+        }
+        sameInHierarchyConflicts.forEach { it.generatedName += "_" + it.concept.name }
+
+        // replace illegal names
+        allConcepts.flatMap { it.getOwnRoles() }.forEach {
+            if (reservedPropertyNames.contains(it.generatedName)) {
+                it.generatedName += getTypeSuffix(it)
+            }
+        }
+    }
+
+    private fun getTypeSuffix(role: ProcessedRole): String {
+        return when (role) {
+            is ProcessedProperty -> "_property"
+            is ProcessedReferenceLink -> "_reference"
+            is ProcessedChildLink -> if (role.multiple) "_children" else "_child"
+        }
+    }
+
+    fun getLanguages(): List<ProcessedLanguage> {
+        return languages
+    }
+}
+
+internal class ProcessedLanguage(var name: String, var uid: String?) {
+    lateinit var languageSet: ProcessedLanguageSet
+    private val concepts: MutableList<ProcessedConcept> = ArrayList()
+    lateinit var simpleName2concept: Map<String, ProcessedConcept>
+
+    fun addConcept(concept: ProcessedConcept) {
+        concepts.add(concept)
+        concept.language = this
+    }
+
+    fun getConcepts(): List<ProcessedConcept> = concepts
+
+    fun load(dataList: List<ConceptData>) {
+        for (data in dataList) {
+            addConcept(ProcessedConcept(data.name, data.uid, data.abstract, data.extends.map { ProcessedConceptReference(it) }.toMutableList()).also { concept ->
+                concept.loadRoles(data)
+            })
+        }
+    }
+
+    fun visitConceptReferences(visitor: (ProcessedConceptReference) -> Unit) {
+        concepts.forEach { it.visitConceptReferences(visitor) }
+    }
+}
+
+internal class ProcessedConceptReference(var name: String) {
+    lateinit var resolved: ProcessedConcept
+}
+
+internal class ProcessedConcept(var name: String, var uid: String?, var abstract: Boolean, val extends: MutableList<ProcessedConceptReference>) {
+    lateinit var language: ProcessedLanguage
+    private val roles: MutableList<ProcessedRole> = ArrayList()
+
+    fun fqName() = language.name + "." + name
+
+    fun addRole(role: ProcessedRole) {
+        roles.add(role)
+        role.concept = this
+    }
+
+    fun getOwnRoles(): List<ProcessedRole> = roles
+
+    fun getOwnAndDuplicateRoles(): List<ProcessedRole> = roles + getDuplicateSuperConcepts().flatMap { it.getOwnRoles() }
+
+    fun loadRoles(data: ConceptData) {
+        data.properties.forEach { addRole(ProcessedProperty(it.name, it.uid, it.optional, it.type)) }
+        data.children.forEach { addRole(ProcessedChildLink(it.name, it.uid, it.optional, it.multiple, ProcessedConceptReference(it.type))) }
+        data.references.forEach { addRole(ProcessedReferenceLink(it.name, it.uid, it.optional, ProcessedConceptReference(it.type))) }
+    }
+
+    fun visitConceptReferences(visitor: (ProcessedConceptReference) -> Unit) {
+        extends.forEach { visitor(it) }
+        roles.forEach { it.visitConceptReferences(visitor) }
+    }
+
+    fun getDirectSuperConcepts(): Sequence<ProcessedConcept> = extends.asSequence().map { it.resolved }
+    private fun getAllSuperConcepts_(): Sequence<ProcessedConcept> = getDirectSuperConcepts().flatMap { it.getAllSuperConceptsAndSelf_() }
+    private fun getAllSuperConceptsAndSelf_(): Sequence<ProcessedConcept> = sequenceOf(this) + getAllSuperConcepts_()
+
+    fun getAllSuperConcepts(): Sequence<ProcessedConcept> = getAllSuperConcepts_().distinct()
+    fun getAllSuperConceptsAndSelf(): Sequence<ProcessedConcept> = getAllSuperConceptsAndSelf_().distinct()
+    fun getDuplicateSuperConcepts() = getAllSuperConcepts_().groupBy { it }.filter { it.value.size > 1 }.map { it.key }
+}
+
+internal sealed class ProcessedRole(
+    var originalName: String,
+    var uid: String?,
+    var optional: Boolean
+) {
+    lateinit var concept: ProcessedConcept
+    var generatedName: String = originalName
+
+    abstract fun visitConceptReferences(visitor: (ProcessedConceptReference) -> Unit)
+}
+
+internal class ProcessedProperty(name: String, uid: String?, optional: Boolean, var type: PropertyType)
+    : ProcessedRole(name, uid, optional) {
+    override fun visitConceptReferences(visitor: (ProcessedConceptReference) -> Unit) {}
+}
+
+internal sealed class ProcessedLink(name: String, uid: String?, optional: Boolean, var type: ProcessedConceptReference)
+    : ProcessedRole(name, uid, optional) {
+    override fun visitConceptReferences(visitor: (ProcessedConceptReference) -> Unit) {
+        visitor(type)
+    }
+}
+
+internal class ProcessedChildLink(name: String, uid: String?, optional: Boolean, var multiple: Boolean, type: ProcessedConceptReference)
+    : ProcessedLink(name, uid, optional, type)
+
+internal class ProcessedReferenceLink(name: String, uid: String?, optional: Boolean, type: ProcessedConceptReference)
+    : ProcessedLink(name, uid, optional, type)