Merge remote-tracking branch 'origin/main' into feature/MODELIX-461-Enable-ktlint-in-modelix-core

languitar · languitar · commit 3bf3f8d46f88 · 2023-08-09T17:12:55.000+02:00
diff --git a/.github/workflows/mps-model-adapters.yaml b/.github/workflows/mps-model-adapters.yaml
@@ -0,0 +1,34 @@
+name: MPS compatibility
+
+on:
+  push:
+    branches:
+      - 'main'
+  pull_request: {}
+  # allow manual execution just in case
+  workflow_dispatch:
+
+jobs:
+  build-mps-model-adapters:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '11'
+      - name: Build with MPS 2020.3.6
+        run: ./gradlew :mps-model-adapters:build -Pmps.version=2020.3.6
+      - name: Build with MPS 2021.1.4
+        run: ./gradlew :mps-model-adapters:build -Pmps.version=2021.1.4
+      - name: Build with MPS 2021.2.6
+        run: ./gradlew :mps-model-adapters:build -Pmps.version=2021.2.6
+      - name: Build with MPS 2021.3.3
+        run: ./gradlew :mps-model-adapters:build -Pmps.version=2021.3.3
+      - name: Build with MPS 2022.2
+        run: ./gradlew :mps-model-adapters:build -Pmps.version=2022.2
+      - name: Build with MPS 2022.3
+        run: ./gradlew :mps-model-adapters:build -Pmps.version=2022.3
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -38,12 +38,6 @@ plugins {
     alias(libs.plugins.dokka)
 }
 
-repositories {
-    mavenLocal()
-    maven { url = uri("https://artifacts.itemis.cloud/repository/maven-mps/") }
-    mavenCentral()
-}
-
 group = "org.modelix"
 description = "Projectional Editor"
 version = computeVersion()
@@ -88,7 +82,9 @@ subprojects {
             freeCompilerArgs += listOf("-Xjvm-default=all-compatibility")
         }
     }
+}
 
+allprojects {
     repositories {
         mavenLocal()
         maven { url = uri("https://artifacts.itemis.cloud/repository/maven-mps/") }
diff --git a/docs/global/modules/core/pages/reference/component-model-api-gen-gradle.adoc b/docs/global/modules/core/pages/reference/component-model-api-gen-gradle.adoc
@@ -82,6 +82,14 @@ Inside of the `metamodel` block the following settings can be configured.
 |File
 |Target Kotlin directory of the generator
 
+|`modelqlKotlinDir`
+|File
+|The generation of the ModelQL API is optional, because the output has a dependency on the ModelQL runtime.
+ If this option is set, you have to add a dependency on `org.modelix:modelql-typed`.
+
+ Can be the same as `kotlinDir` or a directory in a separate subproject,
+ if you run into memory issues of the Kotlin compiler.
+
 |`kotlinProject`
 |Project
 |Target Kotlin project of the generator
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -20,11 +20,11 @@ dokka = {id = "org.jetbrains.dokka", version = "1.8.20"}
 [versions]
 kotlin = "1.9.0"
 kotlinCoroutines="1.7.3"
-ktor="2.3.2"
+ktor="2.3.3"
 kotlinHtml="0.8.0"
 kotlinSerialization="1.5.1"
 ignite="2.15.0"
-apacheCxf="3.5.5"
+apacheCxf="3.6.1"
 
 [libraries]
 
@@ -64,7 +64,7 @@ ktor-serialization-json = { group = "io.ktor", name = "ktor-serialization-kotlin
 
 keycloak-authz-client = { group = "org.keycloak", name = "keycloak-authz-client", version = "22.0.1" }
 guava = { group = "com.google.guava", name = "guava", version = "32.1.2-jre" }
-modelix-incremental = { group = "org.modelix", name = "incremental", version = "0.1.4" }
+modelix-incremental = { group = "org.modelix", name = "incremental", version = "0.2.0" }
 kotlinpoet = { group = "com.squareup", name = "kotlinpoet", version = "1.14.2" }
 vavr = { group = "io.vavr", name = "vavr", version = "0.10.4" }
 apache-commons-lang = { group = "org.apache.commons", name = "commons-lang3", version = "3.13.0" }
diff --git a/model-api-gen-gradle-test/build.gradle.kts b/model-api-gen-gradle-test/build.gradle.kts
@@ -93,6 +93,7 @@ metamodel {
     dependsOn(resolveMps)
     mpsHome = mpsDir
     kotlinDir = kotlinGenDir
+    modelqlKotlinDir = kotlinGenDir
     kotlinProject = project
     typescriptDir = projectDir.resolve("typescript_src")
     includeNamespace("jetbrains")
diff --git a/model-api-gen-gradle/src/main/kotlin/org/modelix/metamodel/gradle/GenerateMetaModelSources.kt b/model-api-gen-gradle/src/main/kotlin/org/modelix/metamodel/gradle/GenerateMetaModelSources.kt
@@ -31,6 +31,10 @@ abstract class GenerateMetaModelSources @Inject constructor(of: ObjectFactory) :
     @Optional
     val kotlinOutputDir: DirectoryProperty = of.directoryProperty()
 
+    @get:OutputDirectory
+    @Optional
+    val modelqlKotlinOutputDir: DirectoryProperty = of.directoryProperty()
+
     @get:OutputDirectory
     @Optional
     val typescriptOutputDir: DirectoryProperty = of.directoryProperty()
@@ -92,7 +96,11 @@ abstract class GenerateMetaModelSources @Inject constructor(of: ObjectFactory) :
 
         val kotlinOutputDir = this.kotlinOutputDir.orNull?.asFile
         if (kotlinOutputDir != null) {
-            val generator = MetaModelGenerator(kotlinOutputDir.toPath(), nameConfig.get())
+            val generator = MetaModelGenerator(
+                kotlinOutputDir.toPath(),
+                nameConfig.get(),
+                this.modelqlKotlinOutputDir.orNull?.asFile?.toPath()
+            )
             generator.generate(processedLanguages)
             registrationHelperName.orNull?.let {
                 generator.generateRegistrationHelper(it, processedLanguages)
diff --git a/model-api-gen-gradle/src/main/kotlin/org/modelix/metamodel/gradle/MetaModelGradlePlugin.kt b/model-api-gen-gradle/src/main/kotlin/org/modelix/metamodel/gradle/MetaModelGradlePlugin.kt
@@ -87,6 +87,7 @@ class MetaModelGradlePlugin : Plugin<Project> {
         project.afterEvaluate {
             generateMetaModelSources.configure { task ->
                 settings.kotlinDir?.let { task.kotlinOutputDir.set(it) }
+                settings.modelqlKotlinDir?.let { task.modelqlKotlinOutputDir.set(it) }
                 settings.typescriptDir?.let { task.typescriptOutputDir.set(it) }
                 task.includedNamespaces.addAll(settings.includedLanguageNamespaces)
                 task.includedLanguages.addAll(settings.includedLanguages)
diff --git a/model-api-gen-gradle/src/main/kotlin/org/modelix/metamodel/gradle/MetaModelGradleSettings.kt b/model-api-gen-gradle/src/main/kotlin/org/modelix/metamodel/gradle/MetaModelGradleSettings.kt
@@ -20,6 +20,7 @@ open class MetaModelGradleSettings {
     val includedConcepts: MutableSet<String> = HashSet()
     val includedModules: MutableSet<String> = HashSet()
     var kotlinDir: File? = null
+    var modelqlKotlinDir: File? = null
     var kotlinProject: Project? = null
         set(value) {
             if (kotlinDir == null && value != null) {
diff --git a/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/MetaModelGenerator.kt b/model-api-gen/src/main/kotlin/org/modelix/metamodel/generator/MetaModelGenerator.kt
@@ -56,7 +56,7 @@ import org.modelix.modelql.typed.TypedModelQL
 import java.nio.file.Path
 import kotlin.reflect.KClass
 
-class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameConfig()) {
+class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameConfig(), val modelqlOutputDir: Path? = null) {
     var alwaysUseNonNullableProperties: Boolean = true
 
     private val headerComment = "\ngenerated by modelix model-api-gen \n"
@@ -128,16 +128,18 @@ class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameC
                 FileSpec.builder(language.generatedClassName().packageName, language.generatedClassName().simpleName)
             val file = builder.addFileComment(headerComment)
                 .addType(generateLanguage(language)).build()
+            file.write()
+
             for (enum in language.getEnums()) {
                 generateEnumFile(enum)
             }
+
             for (concept in language.getConcepts()) {
                 generateConceptFile(concept)
-                if (concept.getOwnRoles().isNotEmpty()) {
+                if (modelqlOutputDir != null && concept.getOwnRoles().isNotEmpty()) {
                     generateModelQLFile(concept)
                 }
             }
-            file.write()
         }
     }
 
@@ -469,7 +471,7 @@ class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameC
                     }
                 }
             }
-            .build().write()
+            .build().writeTo(modelqlOutputDir!!)
     }
 
     private fun generateConceptObject(concept: ProcessedConcept): TypeSpec {
diff --git a/mps-model-adapters/build.gradle.kts b/mps-model-adapters/build.gradle.kts
@@ -3,12 +3,14 @@ plugins {
     `maven-publish`
 }
 
+val mpsVersion = project.findProperty("mps.version")?.toString().takeIf { !it.isNullOrBlank() } ?: "2020.3.6"
+
 dependencies {
     api(project(":model-api"))
 
-    compileOnly("com.jetbrains:mps-openapi:2021.1.4")
-    compileOnly("com.jetbrains:mps-core:2021.1.4")
-    compileOnly("com.jetbrains:mps-environment:2021.1.4")
+    compileOnly("com.jetbrains:mps-openapi:$mpsVersion")
+    compileOnly("com.jetbrains:mps-core:$mpsVersion")
+    compileOnly("com.jetbrains:mps-environment:$mpsVersion")
 
     implementation(kotlin("stdlib"))
     implementation(libs.kotlin.logging)
diff --git a/mps-model-adapters/src/main/java/org/modelix/model/mpsadapters/ConceptWorkaround.java b/mps-model-adapters/src/main/java/org/modelix/model/mpsadapters/ConceptWorkaround.java
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2023.
+ *
+ * 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.model.mpsadapters;
+
+import org.jetbrains.mps.openapi.language.SAbstractConcept;
+import org.jetbrains.mps.openapi.language.SConcept;
+import org.jetbrains.mps.openapi.language.SInterfaceConcept;
+
+/**
+ * The Kotlin compiler cannot disambiguate the call to getSuperConcept/getSuperInterfaces
+ * that where moved to SAbstractConcept in MPS 2021.2, but still exist in SConcept/SInterfaceConcept.
+ */
+public class ConceptWorkaround {
+    public SAbstractConcept concept;
+
+    public ConceptWorkaround(SAbstractConcept concept) {
+        this.concept = concept;
+    }
+
+    public SConcept getSuperConcept() {
+        return ((SConcept) concept).getSuperConcept();
+    }
+
+    public Iterable<SInterfaceConcept> getSuperInterfaces() {
+        if (concept instanceof SConcept) {
+            return ((SConcept) concept).getSuperInterfaces();
+        } else {
+            return ((SInterfaceConcept) concept).getSuperInterfaces();
+        }
+    }
+}
diff --git a/mps-model-adapters/src/main/kotlin/org/modelix/model/mpsadapters/MPSConcept.kt b/mps-model-adapters/src/main/kotlin/org/modelix/model/mpsadapters/MPSConcept.kt
@@ -65,9 +65,10 @@ data class MPSConcept(val concept: SAbstractConceptAdapter) : IConcept {
 
     override fun getDirectSuperConcepts(): List<IConcept> {
         return when (concept) {
-            is SConcept -> listOfNotNull<SAbstractConcept>(concept.superConcept) + concept.superInterfaces
-            is SInterfaceConcept -> concept.superInterfaces
-            else -> emptyList()
+            is SConcept -> listOfNotNull<SAbstractConcept>(ConceptWorkaround(concept).superConcept) +
+                ConceptWorkaround(concept).superInterfaces
+            is SInterfaceConcept -> ConceptWorkaround(concept).superInterfaces
+            else -> emptyList<SAbstractConcept>()
         }.map { MPSConcept(it) }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ import org.modelix.modelql.typed.TypedModelQL`
`56`	`56`	`import java.nio.file.Path`
`57`	`57`	`import kotlin.reflect.KClass`
`58`	`58`
`59`		`-class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameConfig()) {`
	`59`	`+class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameConfig(), val modelqlOutputDir: Path? = null) {`
`60`	`60`	`var alwaysUseNonNullableProperties: Boolean = true`
`61`	`61`
`62`	`62`	`private val headerComment = "\ngenerated by modelix model-api-gen \n"`
`@@ -128,16 +128,18 @@ class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameC`
`128`	`128`	`FileSpec.builder(language.generatedClassName().packageName, language.generatedClassName().simpleName)`
`129`	`129`	`val file = builder.addFileComment(headerComment)`
`130`	`130`	`.addType(generateLanguage(language)).build()`
	`131`	`+ file.write()`
	`132`	`+`
`131`	`133`	`for (enum in language.getEnums()) {`
`132`	`134`	`generateEnumFile(enum)`
`133`	`135`	`}`
	`136`	`+`
`134`	`137`	`for (concept in language.getConcepts()) {`
`135`	`138`	`generateConceptFile(concept)`
`136`		`- if (concept.getOwnRoles().isNotEmpty()) {`
	`139`	`+ if (modelqlOutputDir != null && concept.getOwnRoles().isNotEmpty()) {`
`137`	`140`	`generateModelQLFile(concept)`
`138`	`141`	`}`
`139`	`142`	`}`
`140`		`- file.write()`
`141`	`143`	`}`
`142`	`144`	`}`
`143`	`145`
`@@ -469,7 +471,7 @@ class MetaModelGenerator(val outputDir: Path, val nameConfig: NameConfig = NameC`
`469`	`471`	`}`
`470`	`472`	`}`
`471`	`473`	`}`
`472`		`- .build().write()`
	`474`	`+ .build().writeTo(modelqlOutputDir!!)`
`473`	`475`	`}`
`474`	`476`
`475`	`477`	`private fun generateConceptObject(concept: ProcessedConcept): TypeSpec {`