Add inspection visitor handler

Author: xterao

src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/handler/InspectionFieldAccessVisitorProcessor.kt

@@ -0,0 +1,100 @@
+/*
+ * 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.inspection.sql.handler
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiFile
+import org.domaframework.doma.intellij.common.dao.findDaoMethod
+import org.domaframework.doma.intellij.common.psi.PsiDaoMethod
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+import org.domaframework.doma.intellij.common.sql.cleanString
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationForDirectiveItemTypeResult
+import org.domaframework.doma.intellij.common.util.ForDirectiveUtil
+import org.domaframework.doma.intellij.extension.expr.accessElements
+import org.domaframework.doma.intellij.extension.psi.findParameter
+import org.domaframework.doma.intellij.psi.SqlElFieldAccessExpr
+import org.domaframework.doma.intellij.psi.SqlElIdExpr
+import org.domaframework.doma.intellij.psi.SqlElPrimaryExpr
+
+class InspectionFieldAccessVisitorProcessor(
+    val shortName: String,
+    private val element: SqlElFieldAccessExpr,
+) : InspectionVisitorProcessor(shortName) {
+    fun check(
+        holder: ProblemsHolder,
+        file: PsiFile,
+    ) {
+        // Get element inside block comment
+        val blockElement = getFieldAccessBlocks(element)
+        val topElm = blockElement.firstOrNull() as SqlElPrimaryExpr
+
+        // Exclude fixed Literal
+        if (isLiteralOrStatic(topElm)) return
+
+        val topElement = blockElement.firstOrNull() ?: return
+        val daoMethod = findDaoMethod(file) ?: return
+        val project = topElement.project
+        val forDirectiveBlocks = ForDirectiveUtil.getForDirectiveBlocks(topElement)
+        val forItem = ForDirectiveUtil.findForItem(topElement, forDirectives = forDirectiveBlocks)
+        var isBatchAnnotation = false
+        val topElementParentClass =
+            if (forItem != null) {
+                val result = ForDirectiveUtil.getForDirectiveItemClassType(project, forDirectiveBlocks, forItem)
+                if (result == null) {
+                    ValidationForDirectiveItemTypeResult(
+                        topElement,
+                        this.shortName,
+                    ).highlightElement(holder)
+                    return
+                }
+                val specifiedClassType =
+                    ForDirectiveUtil.resolveForDirectiveItemClassTypeBySuffixElement(topElement.text)
+                if (specifiedClassType != null) {
+                    PsiParentClass(specifiedClassType)
+                } else {
+                    result
+                }
+            } else {
+                val paramType = daoMethod.findParameter(cleanString(topElement.text))?.type
+                if (paramType == null) {
+                    errorHighlight(topElement, daoMethod, holder)
+                    return
+                }
+                isBatchAnnotation = PsiDaoMethod(project, daoMethod).daoType.isBatchAnnotation()
+                PsiParentClass(paramType)
+            }
+
+        val result =
+            ForDirectiveUtil.getFieldAccessLastPropertyClassType(
+                blockElement,
+                project,
+                topElementParentClass,
+                shortName = this.shortName,
+                isBatchAnnotation = isBatchAnnotation,
+            )
+
+        result?.highlightElement(holder)
+    }
+
+    fun getFieldAccessBlocks(element: SqlElFieldAccessExpr): List<SqlElIdExpr> {
+        val blockElements = element.accessElements
+        (blockElements.firstOrNull() as? SqlElPrimaryExpr)
+            ?.let { if (isLiteralOrStatic(it)) return emptyList() }
+            ?: return emptyList()
+
+        return blockElements.mapNotNull { it as SqlElIdExpr }
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/handler/InspectionPrimaryVisitorProcessor.kt

@@ -0,0 +1,79 @@
+/*
+ * 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.inspection.sql.handler
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiFile
+import com.intellij.psi.util.PsiTreeUtil
+import org.domaframework.doma.intellij.common.dao.findDaoMethod
+import org.domaframework.doma.intellij.common.sql.cleanString
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationDaoParamResult
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationForDirectiveItemTypeResult
+import org.domaframework.doma.intellij.common.util.ForDirectiveUtil
+import org.domaframework.doma.intellij.extension.psi.findParameter
+import org.domaframework.doma.intellij.extension.psi.getForItem
+import org.domaframework.doma.intellij.psi.SqlElForDirective
+import org.domaframework.doma.intellij.psi.SqlElPrimaryExpr
+import org.domaframework.doma.intellij.psi.SqlElStaticFieldAccessExpr
+
+class InspectionPrimaryVisitorProcessor(
+    val shortName: String,
+    private val element: SqlElPrimaryExpr,
+) : InspectionVisitorProcessor(shortName) {
+    fun check(
+        holder: ProblemsHolder,
+        file: PsiFile,
+    ) {
+        if (isLiteralOrStatic(element)) return
+        PsiTreeUtil.getParentOfType(element, SqlElStaticFieldAccessExpr::class.java)?.let { return }
+
+        val forDirectiveExp = PsiTreeUtil.getParentOfType(element, SqlElForDirective::class.java)
+        val isSkip = forDirectiveExp != null && forDirectiveExp.getForItem() != element
+
+        var forDirectiveBlocks = ForDirectiveUtil.getForDirectiveBlocks(element, skipSelf = isSkip)
+        val forItem =
+            ForDirectiveUtil.findForItem(
+                element,
+                skipSelf = isSkip,
+                forDirectives = forDirectiveBlocks,
+            )
+        if (forItem != null) {
+            val forDeclarationType =
+                ForDirectiveUtil.getForDirectiveItemClassType(
+                    element.project,
+                    forDirectiveBlocks,
+                    forItem,
+                )
+            if (forDeclarationType == null) {
+                ValidationForDirectiveItemTypeResult(
+                    element,
+                    this.shortName,
+                ).highlightElement(holder)
+            }
+            return
+        }
+
+        val daoMethod = findDaoMethod(file) ?: return
+        val param = daoMethod.findParameter(cleanString(element.text))
+        if (param != null) return
+
+        ValidationDaoParamResult(
+            element,
+            daoMethod.name,
+            this.shortName,
+        ).highlightElement(holder)
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/handler/InspectionStaticFieldAccessVisitorProcessor.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.inspection.sql.handler
+
+import com.intellij.codeInspection.ProblemsHolder
+import org.domaframework.doma.intellij.common.psi.PsiParentClass
+import org.domaframework.doma.intellij.common.psi.PsiStaticElement
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationClassPathResult
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationPropertyResult
+import org.domaframework.doma.intellij.common.util.ForDirectiveUtil
+import org.domaframework.doma.intellij.extension.expr.accessElements
+import org.domaframework.doma.intellij.extension.psi.psiClassType
+import org.domaframework.doma.intellij.psi.SqlElStaticFieldAccessExpr
+
+class InspectionStaticFieldAccessVisitorProcessor(
+    val shortName: String,
+) : InspectionVisitorProcessor(shortName) {
+    /**
+     * Check for existence of static field
+     */
+    fun check(
+        staticAccuser: SqlElStaticFieldAccessExpr,
+        holder: ProblemsHolder,
+    ) {
+        val blockElements = staticAccuser.accessElements
+        val psiStaticClass = PsiStaticElement(staticAccuser.elClass.elIdExprList, staticAccuser.containingFile)
+        val referenceClass = psiStaticClass.getRefClazz()
+        if (referenceClass == null) {
+            ValidationClassPathResult(
+                staticAccuser.elClass,
+                shortName,
+            ).highlightElement(holder)
+            return
+        }
+
+        val topParentClass = ForDirectiveUtil.getStaticFieldAccessTopElementClassType(staticAccuser, referenceClass)
+        if (topParentClass == null) {
+            blockElements.firstOrNull()?.let {
+                ValidationPropertyResult(
+                    it,
+                    PsiParentClass(referenceClass.psiClassType),
+                    shortName,
+                ).highlightElement(holder)
+            }
+            return
+        }
+        val result =
+            topParentClass.let {
+                ForDirectiveUtil.getFieldAccessLastPropertyClassType(
+                    blockElements,
+                    staticAccuser.project,
+                    it,
+                    shortName = shortName,
+                )
+            }
+        result?.highlightElement(holder)
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/inspection/sql/handler/InspectionVisitorProcessor.kt

@@ -0,0 +1,52 @@
+/*
+ * 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.inspection.sql.handler
+
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiMethod
+import com.intellij.psi.util.elementType
+import org.domaframework.doma.intellij.common.sql.validator.result.ValidationDaoParamResult
+import org.domaframework.doma.intellij.psi.SqlElIdExpr
+import org.domaframework.doma.intellij.psi.SqlElNewExpr
+import org.domaframework.doma.intellij.psi.SqlTypes
+
+abstract class InspectionVisitorProcessor(
+    private val shortName: String,
+) {
+    protected fun errorHighlight(
+        topElement: SqlElIdExpr,
+        daoMethod: PsiMethod,
+        holder: ProblemsHolder,
+    ) {
+        ValidationDaoParamResult(
+            topElement,
+            daoMethod.name,
+            this.shortName,
+        ).highlightElement(holder)
+    }
+
+    protected fun isLiteralOrStatic(targetElement: PsiElement): Boolean =
+        (
+            targetElement.firstChild?.elementType == SqlTypes.EL_STRING ||
+                targetElement.firstChild?.elementType == SqlTypes.EL_CHAR ||
+                targetElement.firstChild?.elementType == SqlTypes.EL_NUMBER ||
+                targetElement.firstChild?.elementType == SqlTypes.EL_NULL ||
+                targetElement.firstChild?.elementType == SqlTypes.BOOLEAN ||
+                targetElement.firstChild is SqlElNewExpr ||
+                targetElement.text.startsWith("@")
+        )
+}