Merge pull request #117 from domaframework/feature/analys-for-directive-item-classtype

resolution for elements defined in the %for directive

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/common/sql/PsiClassTypeUtil.kt

@@ -0,0 +1,71 @@
+/*
+ * 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.common.sql
+
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiClassType
+import com.intellij.psi.PsiType
+import com.intellij.psi.search.GlobalSearchScope
+
+class PsiClassTypeUtil {
+    companion object {
+        fun getPsiTypeByList(
+            classType: PsiClassType,
+            project: Project,
+            useListParam: Boolean,
+        ): PsiType? {
+            val isIterableType = isIterableType(classType, project)
+            if (isIterableType && useListParam) {
+                return classType.parameters.firstOrNull()
+            }
+            return classType
+        }
+
+        fun isIterableType(
+            type: PsiClassType,
+            project: Project,
+        ): Boolean {
+            val iterableType =
+                PsiType.getTypeByName(
+                    "java.lang.Iterable",
+                    project,
+                    GlobalSearchScope.allScope(project),
+                )
+            return iterableType.isAssignableFrom(type)
+        }
+
+        fun getParameterType(
+            project: Project,
+            baseType: PsiType?,
+            preReturnListType: PsiType,
+            index: Int,
+        ): PsiClassType? {
+            val returnType = baseType as? PsiClassType ?: return null
+            val preReturnType = preReturnListType as? PsiClassType ?: return null
+
+            if (returnType.name == "E" && isIterableType(preReturnListType, project)) {
+                var count = 1
+                var type: PsiType? = preReturnType.parameters.firstOrNull()
+                while (index > count && type != null && type is PsiClassType) {
+                    type = type.parameters.firstOrNull()
+                    count++
+                }
+                return type as? PsiClassType
+            }
+            return null
+        }
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/common/sql/directive/EmbeddedDirectiveHandler.kt

@@ -21,6 +21,7 @@ import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
 import com.intellij.psi.PsiMethod
 import org.domaframework.doma.intellij.common.dao.findDaoMethod
+import org.domaframework.doma.intellij.extension.psi.searchParameter
 
 class EmbeddedDirectiveHandler(
     private val originalFile: PsiFile,
@@ -36,11 +37,8 @@ class EmbeddedDirectiveHandler(
             result,
         ) { daoMethod, bind ->
             daoMethod
-                ?.parameterList
-                ?.parameters
-                ?.filter {
-                    it.name.startsWith(bind)
-                }?.map { param -> VariableLookupItem(param) }
+                ?.searchParameter(bind)
+                ?.map { param -> VariableLookupItem(param) }
                 ?.toList()
                 ?: emptyList()
         }

src/main/kotlin/org/domaframework/doma/intellij/common/sql/directive/LiteralDirectiveHandler.kt

@@ -22,6 +22,7 @@ import com.intellij.psi.PsiFile
 import com.intellij.psi.PsiMethod
 import org.domaframework.doma.intellij.common.dao.findDaoMethod
 import org.domaframework.doma.intellij.common.psi.PsiTypeChecker
+import org.domaframework.doma.intellij.extension.psi.searchParameter
 
 class LiteralDirectiveHandler(
     private val originalFile: PsiFile,
@@ -37,11 +38,9 @@ class LiteralDirectiveHandler(
             result,
         ) { daoMethod, bind ->
             daoMethod
-                ?.parameterList
-                ?.parameters
+                ?.searchParameter(bind)
                 ?.filter {
-                    it.name.startsWith(bind) &&
-                        PsiTypeChecker.isTargetType(it.type)
+                    PsiTypeChecker.isTargetType(it.type)
                 }?.map { param -> VariableLookupItem(param) }
                 ?.toList()
                 ?: emptyList()

src/main/kotlin/org/domaframework/doma/intellij/common/sql/foritem/ForDeclarationDaoBaseItem.kt

@@ -0,0 +1,54 @@
+/*
+ * 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.common.sql.foritem
+
+import com.intellij.psi.PsiParameter
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+import org.domaframework.doma.intellij.common.sql.validator.SqlElFieldAccessorChildElementValidator
+import org.domaframework.doma.intellij.psi.SqlElIdExpr
+
+/**
+ * In the For directive, define the element based on the Dao parameter.
+ * %for [ForItem] : [ForDeclarationDaoBaseItem]
+ *   %for [ForItem] : [ForDeclarationItem]
+ *    ...
+ */
+open class ForDeclarationDaoBaseItem(
+    private val blocks: List<SqlElIdExpr>,
+    val daoParameter: PsiParameter? = null,
+    open val index: Int = 0,
+) : ForDeclarationItem(blocks.first()) {
+    /***
+     * Obtain the type information of the For item defined from the Dao parameters.
+     */
+    open fun getPsiParentClass(): PsiParentClass? {
+        val daoParamFieldValidator =
+            SqlElFieldAccessorChildElementValidator(
+                blocks,
+                element.containingFile,
+                topDaoParameter = daoParameter,
+            )
+
+        var lastType: PsiParentClass? = null
+        daoParamFieldValidator.validateChildren(
+            complete = { parent ->
+                lastType = parent
+            },
+        )
+        if (lastType == null) return null
+        return lastType
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/common/sql/foritem/ForDeclarationItem.kt

@@ -0,0 +1,33 @@
+/*
+ * 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.common.sql.foritem
+
+import com.intellij.psi.PsiElement
+import org.domaframework.doma.intellij.extension.expr.accessElements
+import org.domaframework.doma.intellij.psi.SqlElFieldAccessExpr
+import org.domaframework.doma.intellij.psi.SqlElIdExpr
+
+/**
+ *  definition source in the For directive
+ *  %for [ForItem] : [ForDeclarationItem]
+ */
+open class ForDeclarationItem(
+    override val element: PsiElement,
+) : ForDirectiveItemBase(element) {
+    open fun getDeclarationChildren(): List<SqlElIdExpr> =
+        (element as? SqlElFieldAccessExpr)?.accessElements?.mapNotNull { it as SqlElIdExpr }
+            ?: listOf(element as SqlElIdExpr)
+}

src/main/kotlin/org/domaframework/doma/intellij/common/sql/foritem/ForDeclarationStaticFieldAccessorItem.kt

@@ -0,0 +1,71 @@
+/*
+ * 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.common.sql.foritem
+
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+import org.domaframework.doma.intellij.common.sql.cleanString
+import org.domaframework.doma.intellij.common.sql.validator.SqlElStaticFieldAccessorChildElementValidator
+import org.domaframework.doma.intellij.psi.SqlElIdExpr
+import org.domaframework.doma.intellij.psi.SqlElStaticFieldAccessExpr
+
+/**
+ * In the For directive, define the element based on the Dao parameter.
+ * %for [ForItem] : [ForDeclarationStaticFieldAccessorItem]
+ *   %for [ForItem] : [ForDeclarationItem]
+ *    ...
+ */
+class ForDeclarationStaticFieldAccessorItem(
+    private val blocks: List<SqlElIdExpr>,
+    private val staticFieldAccessExpr: SqlElStaticFieldAccessExpr,
+    override val index: Int = 0,
+    private val shortName: String = "",
+) : ForDeclarationDaoBaseItem(blocks, null, index) {
+    /***
+     * Obtain the type information of the For item defined from the Dao parameters.
+     */
+    override fun getPsiParentClass(): PsiParentClass? {
+        val staticFieldValidator =
+            SqlElStaticFieldAccessorChildElementValidator(
+                blocks,
+                staticFieldAccessExpr,
+                shortName = shortName,
+            )
+
+        var lastPsiParentClass: PsiParentClass? = null
+        staticFieldValidator.validateChildren(
+            complete = { parent ->
+                lastPsiParentClass = parent
+            },
+        )
+        if (lastPsiParentClass == null) return null
+
+        if (blocks.size == 1) {
+            val searchElementText = cleanString(blocks.first().text)
+            val field = lastPsiParentClass.findField(searchElementText)
+            if (field != null) {
+                val fieldType = field.type
+                return PsiParentClass(fieldType)
+            }
+
+            val method = lastPsiParentClass.findMethod(searchElementText)
+            if (method != null) {
+                val methodReturnType = method.returnType ?: return null
+                return PsiParentClass(methodReturnType)
+            }
+        }
+        return lastPsiParentClass
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/common/sql/foritem/ForDirectiveItemBase.kt

@@ -0,0 +1,22 @@
+/*
+ * 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.common.sql.foritem
+
+import com.intellij.psi.PsiElement
+
+abstract class ForDirectiveItemBase(
+    open val element: PsiElement,
+)

src/main/kotlin/org/domaframework/doma/intellij/common/sql/foritem/ForItem.kt

@@ -0,0 +1,30 @@
+/*
+ * 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.common.sql.foritem
+
+import com.intellij.psi.PsiElement
+import com.intellij.psi.util.PsiTreeUtil
+import org.domaframework.doma.intellij.psi.SqlElForDirective
+
+/**
+ * Elements defined within the For directive
+ * %for [ForItem] : [ForDeclarationItem]
+ */
+class ForItem(
+    override val element: PsiElement,
+) : ForDirectiveItemBase(element) {
+    fun getParentForDirectiveExpr() = PsiTreeUtil.getParentOfType(element, SqlElForDirective::class.java)
+}