feat(model-api): add and implement ITreeChangeVisitor::conceptChanged

mhuster23 · mhuster23 · commit da0a0aa97fcc · 2024-04-05T14:36:07.000+02:00
diff --git a/model-api/src/commonMain/kotlin/org/modelix/model/api/ITreeChangeVisitor.kt b/model-api/src/commonMain/kotlin/org/modelix/model/api/ITreeChangeVisitor.kt
@@ -26,6 +26,13 @@ interface ITreeChangeVisitor {
      */
     fun containmentChanged(nodeId: Long)
 
+    /**
+     * Called when the concept of a node has changed.
+     *
+     * @param nodeId id of the affected node
+     */
+    fun conceptChanged(nodeId: Long)
+
     /**
      * Called when the children of a node have changed.
      *
diff --git a/model-client/src/commonMain/kotlin/org/modelix/model/IncrementalBranch.kt b/model-client/src/commonMain/kotlin/org/modelix/model/IncrementalBranch.kt
@@ -45,6 +45,10 @@ class IncrementalBranch(val branch: IBranch) : IBranch, IBranchWrapper {
                     modified(ContainmentDependency(this@IncrementalBranch, nodeId))
                 }
 
+                override fun conceptChanged(nodeId: Long) {
+                    modified(ConceptDependency(this@IncrementalBranch, nodeId))
+                }
+
                 override fun childrenChanged(nodeId: Long, role: String?) {
                     modified(ChildrenDependency(this@IncrementalBranch, nodeId, role))
                 }
@@ -331,7 +335,6 @@ class IncrementalBranch(val branch: IBranch) : IBranch, IBranchWrapper {
             val oldRole = transaction.getRole(nodeId)
             transaction.setConcept(nodeId, concept)
             modified(ChildrenDependency(this@IncrementalBranch, oldParentId, oldRole))
-            modified(ContainmentDependency(this@IncrementalBranch, nodeId))
             modified(UnclassifiedNodeDependency(this@IncrementalBranch, nodeId))
         }
 
@@ -541,4 +544,8 @@ data class ContainmentDependency(val branch: IBranch, val nodeId: Long) : Depend
     override fun getGroup() = UnclassifiedNodeDependency(branch, nodeId)
 }
 
+data class ConceptDependency(val branch: IBranch, val nodeId: Long) : DependencyBase() {
+    override fun getGroup(): IStateVariableGroup = UnclassifiedNodeDependency(branch, nodeId)
+}
+
 fun IBranch.withIncrementalComputationSupport() = IncrementalBranch(this)
diff --git a/model-client/src/commonMain/kotlin/org/modelix/model/ModelIndex.kt b/model-client/src/commonMain/kotlin/org/modelix/model/ModelIndex.kt
@@ -44,6 +44,8 @@ class ModelIndex private constructor(val tree: ITree, val propertyRole: String)
 
                     override fun referenceChanged(nodeId: Long, role: String) {}
                     override fun containmentChanged(nodeId: Long) {}
+                    override fun conceptChanged(nodeId: Long) {}
+
                     override fun nodeRemoved(nodeId: Long) {
                         val key = oldIndex.readKey(nodeId)
                         index.nodeMap[key]?.remove(nodeId)
diff --git a/model-client/src/commonMain/kotlin/org/modelix/model/SubtreeChanges.kt b/model-client/src/commonMain/kotlin/org/modelix/model/SubtreeChanges.kt
@@ -52,6 +52,10 @@ class SubtreeChanges(val cacheSize: Int) {
                         // there is always a corresponding childrenChanged event for this
                     }
 
+                    override fun conceptChanged(nodeId: Long) {
+                        affectedNodes += nodeId
+                    }
+
                     override fun propertyChanged(nodeId: Long, role: String) {
                         affectedNodes += nodeId
                     }
diff --git a/model-client/src/commonMain/kotlin/org/modelix/model/metameta/MetaModelIndex.kt b/model-client/src/commonMain/kotlin/org/modelix/model/metameta/MetaModelIndex.kt
@@ -70,6 +70,7 @@ class MetaModelIndex private constructor(val tree: ITree) {
 
                     override fun referenceChanged(nodeId: Long, role: String) {}
                     override fun containmentChanged(nodeId: Long) {}
+                    override fun conceptChanged(nodeId: Long) {}
                 },
             )
 
diff --git a/model-client/src/jsMain/kotlin/org/modelix/model/client2/ChangeJS.kt b/model-client/src/jsMain/kotlin/org/modelix/model/client2/ChangeJS.kt
@@ -55,3 +55,10 @@ data class ReferenceChanged(override val node: INodeJS, val role: String) : Chan
 )
 @JsExport
 data class ContainmentChanged(override val node: INodeJS) : ChangeJS
+
+@UnstableModelixFeature(
+    reason = "The overarching task https://issues.modelix.org/issue/MODELIX-500 is in development.",
+    intendedFinalization = "The client is intended to be finalized when the overarching task is finished.",
+)
+@JsExport
+data class ConceptChanged(override val node: INodeJS) : ChangeJS
diff --git a/model-client/src/jsMain/kotlin/org/modelix/model/client2/ClientJS.kt b/model-client/src/jsMain/kotlin/org/modelix/model/client2/ClientJS.kt
@@ -171,6 +171,10 @@ class ChangeListener(private val branch: IBranch, private val changeCallback: (C
                     changeCallback(ContainmentChanged(nodeIdToInode(nodeId)))
                 }
 
+                override fun conceptChanged(nodeId: Long) {
+                    changeCallback(ConceptChanged(nodeIdToInode(nodeId)))
+                }
+
                 override fun childrenChanged(nodeId: Long, role: String?) {
                     changeCallback(ChildrenChanged(nodeIdToInode(nodeId), role))
                 }
diff --git a/model-datastructure/src/commonMain/kotlin/org/modelix/model/lazy/CLTree.kt b/model-datastructure/src/commonMain/kotlin/org/modelix/model/lazy/CLTree.kt
@@ -486,6 +486,8 @@ class CLTree : ITree, IBulkTree {
                             }
                             if (oldElement.parentId != newElement.parentId) {
                                 visitor.containmentChanged(key)
+                            } else if (oldElement.concept != newElement.concept) {
+                                visitor.conceptChanged(key)
                             } else if (oldElement.roleInParent != newElement.roleInParent) {
                                 visitor.containmentChanged(key)
                                 notifyChildrenChange(oldElement.parentId, oldElement.roleInParent)
diff --git a/model-datastructure/src/commonTest/kotlin/ConflictResolutionTest.kt b/model-datastructure/src/commonTest/kotlin/ConflictResolutionTest.kt
@@ -825,6 +825,10 @@ fun assertSameTree(tree1: ITree, tree2: ITree) {
                 fail("containmentChanged ${nodeId.toString(16)}")
             }
 
+            override fun conceptChanged(nodeId: Long) {
+                fail("conceptChanged ${nodeId.toString(16)}")
+            }
+
             override fun childrenChanged(nodeId: Long, role: String?) {
                 fail("childrenChanged ${nodeId.toString(16)}, $role")
             }
diff --git a/model-datastructure/src/commonTest/kotlin/DiffTest.kt b/model-datastructure/src/commonTest/kotlin/DiffTest.kt
@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import org.modelix.model.api.BuiltinLanguages
 import org.modelix.model.api.ConceptReference
 import org.modelix.model.api.ITree
 import org.modelix.model.api.NodeReference
@@ -26,6 +27,17 @@ import kotlin.test.fail
 
 class DiffTest {
 
+    @Test
+    fun changeConcept() {
+        runTest(
+            setOf(
+                TreeChangeCollector.ConceptChangedEvent(ITree.ROOT_ID),
+            ),
+        ) {
+            it.setConcept(ITree.ROOT_ID, BuiltinLanguages.jetbrains_mps_lang_core.INamedConcept.getReference())
+        }
+    }
+
     @Test
     fun changeProperty() {
         runTest(
diff --git a/model-datastructure/src/commonTest/kotlin/FailingVisitor.kt b/model-datastructure/src/commonTest/kotlin/FailingVisitor.kt
@@ -20,6 +20,10 @@ class FailingVisitor : ITreeChangeVisitorEx {
         fail("Tree expected to be the same")
     }
 
+    override fun conceptChanged(nodeId: Long) {
+        fail("Tree expected to be the same")
+    }
+
     override fun childrenChanged(nodeId: Long, role: String?) {
         fail("Tree expected to be the same")
     }
diff --git a/model-datastructure/src/commonTest/kotlin/TreeChangeCollector.kt b/model-datastructure/src/commonTest/kotlin/TreeChangeCollector.kt
@@ -39,6 +39,10 @@ class TreeChangeCollector : ITreeChangeVisitorEx {
         events += ContainmentChangedEvent(nodeId)
     }
 
+    override fun conceptChanged(nodeId: Long) {
+        events += ConceptChangedEvent(nodeId)
+    }
+
     override fun childrenChanged(nodeId: Long, role: String?) {
         events += ChildrenChangedEvent(nodeId, role)
     }
@@ -61,6 +65,7 @@ class TreeChangeCollector : ITreeChangeVisitorEx {
 
     abstract class ChangeEvent
     data class ContainmentChangedEvent(val nodeId: Long) : ChangeEvent()
+    data class ConceptChangedEvent(val nodeId: Long) : ChangeEvent()
     data class ChildrenChangedEvent(val nodeId: Long, val role: String?) : ChangeEvent()
     data class ReferenceChangedEvent(val nodeId: Long, val role: String?) : ChangeEvent()
     data class PropertyChangedEvent(val nodeId: Long, val role: String?) : ChangeEvent()
diff --git a/model-datastructure/src/commonTest/kotlin/TreeDiffTest.kt b/model-datastructure/src/commonTest/kotlin/TreeDiffTest.kt
@@ -149,6 +149,10 @@ class TreeDiffTest {
             changedContainments.add(nodeId)
         }
 
+        override fun conceptChanged(nodeId: Long) {
+            TODO("Not yet implemented")
+        }
+
         override fun propertyChanged(nodeId: Long, role: String) {
             changedRoles.add(RoleInNode(nodeId, role))
         }
diff --git a/model-server/src/main/kotlin/org/modelix/model/server/handlers/DeprecatedLightModelServer.kt b/model-server/src/main/kotlin/org/modelix/model/server/handlers/DeprecatedLightModelServer.kt
@@ -359,6 +359,10 @@ class DeprecatedLightModelServer(val client: LocalModelClient) {
 
                     override fun containmentChanged(nodeId: Long) {}
 
+                    override fun conceptChanged(nodeId: Long) {
+                        nodesToInclude += nodeId
+                    }
+
                     override fun propertyChanged(nodeId: Long, role: String) {
                         nodesToInclude += nodeId
                     }
diff --git a/model-server/src/main/kotlin/org/modelix/model/server/handlers/LightModelServer.kt b/model-server/src/main/kotlin/org/modelix/model/server/handlers/LightModelServer.kt
@@ -297,6 +297,10 @@ class LightModelServer(val client: LocalModelClient) {
                         }
                     }
 
+                    override fun conceptChanged(nodeId: Long) {
+                        nodesToInclude += nodeId
+                    }
+
                     override fun propertyChanged(nodeId: Long, role: String) {
                         nodesToInclude += nodeId
                     }

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,10 @@ class IncrementalBranch(val branch: IBranch) : IBranch, IBranchWrapper {`
`45`	`45`	`modified(ContainmentDependency(this@IncrementalBranch, nodeId))`
`46`	`46`	`}`
`47`	`47`
	`48`	`+ override fun conceptChanged(nodeId: Long) {`
	`49`	`+ modified(ConceptDependency(this@IncrementalBranch, nodeId))`
	`50`	`+ }`
	`51`	`+`
`48`	`52`	`override fun childrenChanged(nodeId: Long, role: String?) {`
`49`	`53`	`modified(ChildrenDependency(this@IncrementalBranch, nodeId, role))`
`50`	`54`	`}`
`@@ -331,7 +335,6 @@ class IncrementalBranch(val branch: IBranch) : IBranch, IBranchWrapper {`
`331`	`335`	`val oldRole = transaction.getRole(nodeId)`
`332`	`336`	`transaction.setConcept(nodeId, concept)`
`333`	`337`	`modified(ChildrenDependency(this@IncrementalBranch, oldParentId, oldRole))`
`334`		`- modified(ContainmentDependency(this@IncrementalBranch, nodeId))`
`335`	`338`	`modified(UnclassifiedNodeDependency(this@IncrementalBranch, nodeId))`
`336`	`339`	`}`
`337`	`340`
`@@ -541,4 +544,8 @@ data class ContainmentDependency(val branch: IBranch, val nodeId: Long) : Depend`
`541`	`544`	`override fun getGroup() = UnclassifiedNodeDependency(branch, nodeId)`
`542`	`545`	`}`
`543`	`546`
	`547`	`+data class ConceptDependency(val branch: IBranch, val nodeId: Long) : DependencyBase() {`
	`548`	`+ override fun getGroup(): IStateVariableGroup = UnclassifiedNodeDependency(branch, nodeId)`
	`549`	`+}`
	`550`	`+`
`544`	`551`	`fun IBranch.withIncrementalComputationSupport() = IncrementalBranch(this)`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,10 @@ class SubtreeChanges(val cacheSize: Int) {`
`52`	`52`	`// there is always a corresponding childrenChanged event for this`
`53`	`53`	`}`
`54`	`54`
	`55`	`+ override fun conceptChanged(nodeId: Long) {`
	`56`	`+ affectedNodes += nodeId`
	`57`	`+ }`
	`58`	`+`
`55`	`59`	`override fun propertyChanged(nodeId: Long, role: String) {`
`56`	`60`	`affectedNodes += nodeId`
`57`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@ class MetaModelIndex private constructor(val tree: ITree) {`
`70`	`70`
`71`	`71`	`override fun referenceChanged(nodeId: Long, role: String) {}`
`72`	`72`	`override fun containmentChanged(nodeId: Long) {}`
	`73`	`+ override fun conceptChanged(nodeId: Long) {}`
`73`	`74`	`},`
`74`	`75`	`)`
`75`	`76`
Original file line number	Diff line number	Diff line change
`@@ -171,6 +171,10 @@ class ChangeListener(private val branch: IBranch, private val changeCallback: (C`
`171`	`171`	`changeCallback(ContainmentChanged(nodeIdToInode(nodeId)))`
`172`	`172`	`}`
`173`	`173`
	`174`	`+ override fun conceptChanged(nodeId: Long) {`
	`175`	`+ changeCallback(ConceptChanged(nodeIdToInode(nodeId)))`
	`176`	`+ }`
	`177`	`+`
`174`	`178`	`override fun childrenChanged(nodeId: Long, role: String?) {`
`175`	`179`	`changeCallback(ChildrenChanged(nodeIdToInode(nodeId), role))`
`176`	`180`	`}`
Original file line number	Diff line number	Diff line change
`@@ -486,6 +486,8 @@ class CLTree : ITree, IBulkTree {`
`486`	`486`	`}`
`487`	`487`	`if (oldElement.parentId != newElement.parentId) {`
`488`	`488`	`visitor.containmentChanged(key)`
	`489`	`+ } else if (oldElement.concept != newElement.concept) {`
	`490`	`+ visitor.conceptChanged(key)`
`489`	`491`	`} else if (oldElement.roleInParent != newElement.roleInParent) {`
`490`	`492`	`visitor.containmentChanged(key)`
`491`	`493`	`notifyChildrenChange(oldElement.parentId, oldElement.roleInParent)`
Original file line number	Diff line number	Diff line change
`@@ -825,6 +825,10 @@ fun assertSameTree(tree1: ITree, tree2: ITree) {`
`825`	`825`	`fail("containmentChanged ${nodeId.toString(16)}")`
`826`	`826`	`}`
`827`	`827`
	`828`	`+ override fun conceptChanged(nodeId: Long) {`
	`829`	`+ fail("conceptChanged ${nodeId.toString(16)}")`
	`830`	`+ }`
	`831`	`+`
`828`	`832`	`override fun childrenChanged(nodeId: Long, role: String?) {`
`829`	`833`	`fail("childrenChanged ${nodeId.toString(16)}, $role")`
`830`	`834`	`}`