Merge pull request #229 from domaframework/fix/dao-parameter-suggestions

Fix FieldAccess code completion

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/contributor/sql/processor/SqlCompletionBlockProcessor.kt

@@ -0,0 +1,92 @@
+/*
+ * Copyright Doma Tools Authors
+ *
+ * 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
+ *
+ *     https://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.domaframework.doma.intellij.contributor.sql.processor
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiErrorElement
+import com.intellij.psi.PsiWhiteSpace
+import com.intellij.psi.util.PsiTreeUtil
+import com.intellij.psi.util.elementType
+import com.intellij.psi.util.prevLeafs
+import org.domaframework.doma.intellij.extension.psi.isNotWhiteSpace
+import org.domaframework.doma.intellij.psi.SqlBlockComment
+import org.domaframework.doma.intellij.psi.SqlElIdExpr
+import org.domaframework.doma.intellij.psi.SqlElParameters
+import org.domaframework.doma.intellij.psi.SqlElTermExpr
+import org.domaframework.doma.intellij.psi.SqlTypes
+
+abstract class SqlCompletionBlockProcessor {
+    abstract fun generateBlock(targetElement: PsiElement): List<PsiElement>?
+
+    protected fun filterBlocks(blocks: List<PsiElement>): List<PsiElement> =
+        blocks
+            .filter {
+                it is SqlElIdExpr || it.elementType == SqlTypes.EL_IDENTIFIER || it == blocks.last()
+            }.sortedBy { it.textOffset }
+
+    // Get the list of elements before itself
+    protected fun findSelfBlocks(targetElement: PsiElement): List<PsiElement> {
+        val prevElements =
+            targetElement.prevLeafs
+                .takeWhile {
+                    it.elementType != SqlTypes.BLOCK_COMMENT_START &&
+                        !isSqlElSymbol(it) &&
+                        it.elementType != SqlTypes.AT_SIGN &&
+                        it !is SqlElTermExpr &&
+                        it !is SqlBlockComment
+                }.toList()
+
+        var inParameter = false
+        val formatElements = mutableListOf<PsiElement>()
+        prevElements.forEach { prev ->
+            if (prev.elementType == SqlTypes.RIGHT_PAREN) inParameter = true
+            if (!inParameter) {
+                formatElements.add(prev)
+            }
+            if (prev.elementType == SqlTypes.LEFT_PAREN) inParameter = false
+        }
+
+        val filterElements =
+            formatElements
+                .takeWhile { it !is PsiWhiteSpace }
+                .filter {
+                    it is PsiErrorElement ||
+                        it is SqlElIdExpr ||
+                        it.elementType == SqlTypes.EL_IDENTIFIER
+                }.filter {
+                    it.isNotWhiteSpace() &&
+                        PsiTreeUtil.getParentOfType(it, SqlElParameters::class.java) == null
+                }.plus(targetElement)
+                .sortedBy { it.textOffset }
+
+        return if (filterElements.isNotEmpty()) filterElements else emptyList()
+    }
+
+    private fun isSqlElSymbol(element: PsiElement): Boolean =
+        element.elementType == SqlTypes.EL_PLUS ||
+            element.elementType == SqlTypes.EL_MINUS ||
+            element.elementType == SqlTypes.ASTERISK ||
+            element.elementType == SqlTypes.EL_DIVIDE_EXPR ||
+            element.elementType == SqlTypes.EL_EQ ||
+            element.elementType == SqlTypes.EL_NE ||
+            element.elementType == SqlTypes.EL_LE_EXPR ||
+            element.elementType == SqlTypes.EL_LT_EXPR ||
+            element.elementType == SqlTypes.EL_GE_EXPR ||
+            element.elementType == SqlTypes.EL_GT_EXPR ||
+            element.elementType == SqlTypes.EL_AND ||
+            element.elementType == SqlTypes.EL_NOT ||
+            element.elementType == SqlTypes.SEPARATOR
+}

src/main/kotlin/org/domaframework/doma/intellij/contributor/sql/processor/SqlCompletionDirectiveBlockProcessor.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright Doma Tools Authors
+ *
+ * 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
+ *
+ *     https://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.domaframework.doma.intellij.contributor.sql.processor
+
+import com.intellij.psi.PsiElement
+
+class SqlCompletionDirectiveBlockProcessor : SqlCompletionBlockProcessor() {
+    override fun generateBlock(targetElement: PsiElement): List<PsiElement>? {
+        val prevElms = findSelfBlocks(targetElement)
+        if (prevElms.isNotEmpty()) {
+            return filterBlocks(prevElms)
+        }
+        return null
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/contributor/sql/processor/SqlCompletionOtherBlockProcessor.kt

@@ -0,0 +1,49 @@
+/*
+ * Copyright Doma Tools Authors
+ *
+ * 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
+ *
+ *     https://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.domaframework.doma.intellij.contributor.sql.processor
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiWhiteSpace
+import com.intellij.psi.util.PsiTreeUtil
+import com.intellij.psi.util.elementType
+import org.domaframework.doma.intellij.psi.SqlTypes
+
+class SqlCompletionOtherBlockProcessor : SqlCompletionBlockProcessor() {
+    /**
+     * Generate a list of related elements for suggesting regular DAO argument parameters
+     * and instance properties of field access elements.
+     *
+     * @param targetElement Element at the caret position.
+     * @return List of preceding elements related to the caret position.
+     */
+    override fun generateBlock(targetElement: PsiElement): List<PsiElement> {
+        // When entering a new bind variable, an empty list is returned and element names defined as DAO argument parameters
+        // or in loop directives are suggested.
+        if (targetElement is PsiWhiteSpace &&
+            targetElement.text.length > 1 &&
+            PsiTreeUtil.prevLeaf(targetElement, true)?.elementType != SqlTypes.DOT
+        ) {
+            return emptyList()
+        }
+
+        // For SqlElFieldAccessExpr,this is the list from the top element to the element at the caret position.
+        val prevElms = findSelfBlocks(targetElement)
+        if (prevElms.isNotEmpty()) {
+            return filterBlocks(prevElms)
+        }
+        return emptyList()
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/contributor/sql/processor/SqlCompletionParameterArgsBlockProcessor.kt

@@ -0,0 +1,89 @@
+/*
+ * Copyright Doma Tools Authors
+ *
+ * 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
+ *
+ *     https://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.domaframework.doma.intellij.contributor.sql.processor
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.util.PsiTreeUtil
+import com.intellij.psi.util.elementType
+import com.intellij.psi.util.prevLeafs
+import org.domaframework.doma.intellij.extension.psi.isNotWhiteSpace
+import org.domaframework.doma.intellij.psi.SqlElFieldAccessExpr
+import org.domaframework.doma.intellij.psi.SqlElParameters
+import org.domaframework.doma.intellij.psi.SqlTypes
+import kotlin.collections.addAll
+
+class SqlCompletionParameterArgsBlockProcessor(
+    private val targetElement: PsiElement,
+) : SqlCompletionBlockProcessor() {
+    override fun generateBlock(targetElement: PsiElement): List<PsiElement> = emptyList()
+
+    /**
+     * Generates the first argument block for a given parameter parent element.
+     * This method collects all children of the parameter parent, including nested field access expressions.
+     *
+     * @param parameterParent The parent PsiElement of the parameter.
+     * @return A list of PsiElements representing the first argument block.
+     */
+    fun generateFirstArgsBlock(parameterParent: PsiElement): List<PsiElement> {
+        val children = mutableListOf<PsiElement>()
+        parameterParent.children.forEach { child ->
+            if (child is SqlElFieldAccessExpr) {
+                children.addAll(child.children)
+            } else {
+                children.add(child)
+            }
+        }
+        return children
+    }
+
+    /**
+     * Retrieves the parent element of the second argument block.
+     * This method traverses previous leaf elements to find the parent of type SqlElParameters.
+     *
+     * @return The parent PsiElement of the second argument block, or null if not found.
+     */
+    fun getSecondArgsParent(): PsiElement? =
+        targetElement.prevLeafs
+            .takeWhile {
+                it.isNotWhiteSpace() &&
+                    it.elementType != SqlTypes.LEFT_PAREN
+            }.firstOrNull {
+                PsiTreeUtil.getParentOfType(
+                    it,
+                    SqlElParameters::class.java,
+                ) != null
+            }
+
+    fun generateSecondArgsBlock(parameterArg: PsiElement): List<PsiElement> {
+        val parameterParent = PsiTreeUtil.getParentOfType(parameterArg, SqlElParameters::class.java)
+        val children = mutableListOf<PsiElement>()
+        parameterParent
+            ?.children
+            ?.reversed()
+            ?.takeWhile {
+                it.nextSibling?.elementType != SqlTypes.COMMA
+            }?.forEach { child ->
+                if (child is SqlElFieldAccessExpr) {
+                    children.addAll(child.children)
+                } else {
+                    children.add(child)
+                }
+            }
+        val blocks = children.reversed()
+
+        return filterBlocks(blocks)
+    }
+}