filter duplicate CC menu entries

When there are nested binary expressions show only
side transformations for one of the expressions.

Author: slisson

editor-runtime/src/commonMain/kotlin/org/modelix/editor/CaretSelection.kt

@@ -148,6 +148,7 @@ class CaretSelection(val layoutable: LayoutableCell, val start: Int, val end: In
             val actions = providers.flatMap { it.flattenApplicableActions(params) }
             val matchingActions = actions
                 .filter { it.getMatchingText().startsWith(typedText) }
+                .applyShadowing()
             if (matchingActions.isNotEmpty()) {
                 if (matchingActions.size == 1 && matchingActions.first().getMatchingText() == typedText) {
                     matchingActions.first().execute()

editor-runtime/src/commonMain/kotlin/org/modelix/editor/CellTemplate.kt

@@ -14,9 +14,7 @@ import org.modelix.model.api.INode
 import org.modelix.model.api.IProperty
 import org.modelix.model.api.addNewChild
 import org.modelix.model.api.getChildren
-import org.modelix.model.api.getContainmentLink
 import org.modelix.model.api.getReferenceTarget
-import org.modelix.model.api.index
 import org.modelix.model.api.moveChild
 import org.modelix.model.api.setPropertyValue
 import org.modelix.model.api.setReferenceTarget
@@ -135,16 +133,28 @@ class ConstantCellTemplate<NodeT : ITypedNode, ConceptT : ITypedConcept>(concept
     }
 
     override fun createWrapperAction(nodeToWrap: INode, wrappingLink: IChildLink): List<ICodeCompletionAction> {
-        return listOf(WrapperAction(nodeToWrap, wrappingLink))
+        return listOf(SideTransformWrapper(nodeToWrap.toNonExisting(), wrappingLink))
     }
 
-    inner class WrapperAction(val nodeToWrap: INode, val wrappingLink: IChildLink) : ICodeCompletionAction {
+    inner class SideTransformWrapper(val nodeToWrap: INonExistingNode, val wrappingLink: IChildLink) : ICodeCompletionAction {
         override fun getMatchingText(): String = text
         override fun getDescription(): String = concept.getShortName()
         override fun execute() {
-            val wrapper = nodeToWrap.parent!!.addNewChild(nodeToWrap.getContainmentLink()!!, nodeToWrap.index(), concept)
-            wrapper.moveChild(wrappingLink, 0, nodeToWrap)
+            val wrapper = nodeToWrap.getParent()!!.getOrCreateNode(null).addNewChild(nodeToWrap.getContainmentLink()!!, nodeToWrap.index(), concept)
+            wrapper.moveChild(wrappingLink, 0, nodeToWrap.getOrCreateNode(null))
         }
+
+        override fun shadows(shadowed: ICodeCompletionAction): Boolean {
+            if (shadowed !is ConstantCellTemplate<*, *>.SideTransformWrapper) return false
+            if (shadowed.getTemplate().concept != concept) return false
+            val commonAncestor = nodeToWrap.commonAncestor(shadowed.nodeToWrap)
+            val ownDepth = nodeToWrap.ancestors(true).takeWhile { it != commonAncestor }.count()
+            val otherDepth = shadowed.nodeToWrap.ancestors(true).takeWhile { it != commonAncestor }.count()
+            if (ownDepth > otherDepth) return true
+            return false
+        }
+
+        fun getTemplate() = this@ConstantCellTemplate
     }
 
     inner class InstantiateNodeAction(val location: INonExistingNode) : ICodeCompletionAction {

editor-runtime/src/commonMain/kotlin/org/modelix/editor/CodeCompletionMenu.kt

@@ -28,6 +28,7 @@ class CodeCompletionMenu(
                 val matchingText = it.getMatchingText()
                 matchingText.isNotEmpty() && matchingText.startsWith(parameters.pattern)
             }
+            .applyShadowing()
             .sortedBy { it.getMatchingText().lowercase() }
     }
 
@@ -200,6 +201,8 @@ interface ICodeCompletionAction : IActionOrProvider {
     fun getMatchingText(): String
     fun getDescription(): String
     fun execute()
+    fun shadows(shadowed: ICodeCompletionAction) = false
+    fun shadowedBy(shadowing: ICodeCompletionAction) = false
 }
 
 class CodeCompletionActionWithPostprocessor(val action: ICodeCompletionAction, val after: () -> Unit) : ICodeCompletionAction by action {
@@ -243,4 +246,15 @@ enum class CompletionPosition {
     CENTER,
     LEFT,
     RIGHT
+}
+
+fun List<ICodeCompletionAction>.applyShadowing(): List<ICodeCompletionAction> {
+    return groupBy { it.getMatchingText() }.flatMap { applyShadowingToGroup(it.value) }
+}
+
+private fun applyShadowingToGroup(actions: List<ICodeCompletionAction>): List<ICodeCompletionAction> {
+    return actions.filter { a1 ->
+        val isShadowed = actions.any { a2 -> a2 !== a1 && (a2.shadows(a1) || a1.shadowedBy(a2)) }
+        !isShadowed
+    }
 }

editor-runtime/src/commonMain/kotlin/org/modelix/editor/INonExistingNode.kt

@@ -30,16 +30,37 @@ import org.modelix.model.api.remove
 
 interface INonExistingNode {
     fun getParent(): INonExistingNode?
+    fun getContainmentLink(): IChildLink?
+    fun index(): Int
     fun replaceNode(subConcept: IConcept?): INode
     fun getOrCreateNode(subConcept: IConcept?): INode
     fun expectedConcept(): IConcept?
     fun getVisibleReferenceTargets(link: IReferenceLink): List<INode>
 }
 
-data class SpecializedNonExistingNode(val node: INonExistingNode, val subConcept: IConcept): INonExistingNode {
-    override fun getParent(): INonExistingNode? {
-        TODO("Not yet implemented")
+fun INonExistingNode.ancestors(includeSelf: Boolean = false): Sequence<INonExistingNode> {
+    return generateSequence(if (includeSelf) this else getParent()) { it.getParent() }
+}
+
+fun INonExistingNode.commonAncestor(otherNode: INonExistingNode): INonExistingNode? {
+    val ancestors1 = HashSet<INonExistingNode>()
+    val ancestors2 = HashSet<INonExistingNode>()
+
+    for (ancestorPair in ancestors(true).zip(otherNode.ancestors(true))) {
+        ancestors1.add(ancestorPair.first)
+        ancestors2.add(ancestorPair.second)
+        if (ancestors1.contains(ancestorPair.second)) return ancestorPair.second
+        if (ancestors2.contains(ancestorPair.first)) return ancestorPair.first
     }
+    return null
+}
+
+data class SpecializedNonExistingNode(val node: INonExistingNode, val subConcept: IConcept): INonExistingNode {
+    override fun getParent(): INonExistingNode? = node.getParent()
+
+    override fun getContainmentLink(): IChildLink? = node.getContainmentLink()
+
+    override fun index(): Int = node.index()
 
     override fun replaceNode(subConcept: IConcept?): INode {
         return node.replaceNode(coerceOutputConcept(subConcept))
@@ -81,6 +102,10 @@ fun INonExistingNode.coerceOutputConcept(subConcept: IConcept?): IConcept? {
 data class ExistingNode(val node: INode) : INonExistingNode {
     override fun getParent(): INonExistingNode? = node.parent?.let { ExistingNode(it) }
 
+    override fun getContainmentLink() = node.getContainmentLink()
+
+    override fun index() = node.index()
+
     override fun replaceNode(subConcept: IConcept?): INode {
         val parent = node.parent ?: throw RuntimeException("cannot replace the root node")
         val newNode = parent.addNewChild(node.roleInParent, node.index(), coerceOutputConcept(subConcept))
@@ -109,9 +134,13 @@ data class ExistingNode(val node: INode) : INonExistingNode {
 
 fun INode.toNonExisting() = ExistingNode(this)
 
-data class NonExistingChild(private val parent: INonExistingNode, val link: IChildLink, val index: Int = 0) : INonExistingNode {
+data class NonExistingChild(private val parent: INonExistingNode, val link: IChildLink, private val index: Int = 0) : INonExistingNode {
     override fun getParent() = parent
 
+    override fun getContainmentLink() = link
+
+    override fun index(): Int = index
+
     override fun replaceNode(subConcept: IConcept?): INode {
         val parentNode = parent.getOrCreateNode(null)
         val existing = parentNode.getChildren(link).toList().getOrNull(index)