Merge pull request #175 from domaframework/feature/support-custom-functions

Support custom functions

Author: xterao

README.md

@@ -39,6 +39,7 @@ The plugin also provides quick fixes for Dao methods where the required SQL file
 - Check the class name and package name for static property calls
   ![inspectionPackageName.png](images/inspectionPackageName.png)
 - Optional types are recognized as their element type (e.g. Optional<String> is treated as String).
+- Checks calls to custom functions and error-highlights any methods that aren’t defined in the classes registered via the settings.
 
 ## Completion
 Adds code completion functionality to support indexing of Doma directives and bind variables
@@ -54,6 +55,7 @@ Adds code completion functionality to support indexing of Doma directives and bi
 - Directives such as Condition, Loop, Population are suggested after “%”
 - Suggest built-in functions after “@”
 - Optional types are recognized as their element type (e.g. Optional<String> is treated as String).
+- Suggest functions during code completion from the ExpressionFunctions implementation classes registered in the settings.
 
 ## Refactoring
 Along with the Dao name change, we will refactor the SQL file directory and file name.
@@ -81,6 +83,7 @@ This feature works in source JARs as well, but in binary JARs, if the DAO method
 - The DAO method’s argument parameter definition
 - The field and method definitions on that parameter’s type
 - The class definition referenced by @ClassName@
+- Resolve references for custom functions using the ExpressionFunctions implementation class in which they are defined.
 - You can also jump using the **Go To > Declaration Usage** menu.
 
 ![reference.png](images/reference.png)
@@ -92,3 +95,6 @@ Some functions of "Doma Tools" can be customized from the settings screen.
 - Highlight color settings for SQL elements
 ![setting_highlight.png](images/setting_highlight.png)
 - Customize action shortcut keys
+- Toggle the SQL formatting feature on or off
+- Specify the class names that define custom functions.
+ ![setting.png](images/setting.png)

images/setting.png

@@ -0,0 +1,29 @@
+/*
+ * 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
+
+// TODO Dynamically build the source directory path and retrieve subproject info
+// by inspecting file metadata instead of using string manipulation.
+object CommonPathParameterHelper {
+    val SRC_MAIN_PATH: String
+        get() = "/src/main"
+
+    val RESOURCES_PATH: String
+        get() = "resources"
+
+    val RESOURCES_META_INF_PATH: String
+        get() = "META-INF"
+}

src/main/kotlin/org/domaframework/doma/intellij/common/CommonPathParameterHelper.kt

@@ -18,7 +18,7 @@ package org.domaframework.doma.intellij.common
 import com.intellij.openapi.fileTypes.FileTypeManager
 import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.psi.PsiFile
-import org.domaframework.doma.intellij.common.CommonPathParameter.Companion.SRC_MAIN_PATH
+import org.domaframework.doma.intellij.common.CommonPathParameterHelper.SRC_MAIN_PATH
 
 /**
  * Get extension by file type identifier

src/main/kotlin/org/domaframework/doma/intellij/common/FileTypeCheck.kt

@@ -18,7 +18,7 @@ package org.domaframework.doma.intellij.common
 import com.intellij.openapi.vfs.StandardFileSystems
 import com.intellij.openapi.vfs.VirtualFile
 import com.intellij.psi.PsiFile
-import org.domaframework.doma.intellij.common.CommonPathParameter.Companion.RESOURCES_META_INF_PATH
+import org.domaframework.doma.intellij.common.CommonPathParameterHelper.RESOURCES_META_INF_PATH
 
 fun getJarRoot(
     virtualFile: VirtualFile,

src/main/kotlin/org/domaframework/doma/intellij/common/JarFileSearch.kt

@@ -27,8 +27,8 @@ import com.intellij.psi.PsiManager
 import com.intellij.psi.PsiMethod
 import com.intellij.psi.search.GlobalSearchScope
 import com.intellij.psi.util.PsiTreeUtil
-import org.domaframework.doma.intellij.common.CommonPathParameter.Companion.RESOURCES_META_INF_PATH
-import org.domaframework.doma.intellij.common.CommonPathParameter.Companion.RESOURCES_PATH
+import org.domaframework.doma.intellij.common.CommonPathParameterHelper.RESOURCES_META_INF_PATH
+import org.domaframework.doma.intellij.common.CommonPathParameterHelper.RESOURCES_PATH
 import org.domaframework.doma.intellij.common.getExtension
 import org.domaframework.doma.intellij.common.getJarRoot
 import org.domaframework.doma.intellij.common.getMethodDaoFilePath

src/main/kotlin/org/domaframework/doma/intellij/common/dao/DaoMethodUtil.kt

@@ -0,0 +1,48 @@
+/*
+ * 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.helper
+
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.project.ProjectManager
+import com.intellij.openapi.wm.IdeFocusManager
+
+object ActiveProjectHelper {
+    private var activeProject: Project? = null
+
+    fun setCurrentActiveProject(value: Project?) {
+        activeProject = value
+    }
+
+    fun getCurrentActiveProject(): Project? {
+        val initProject = activeProject
+        val active = getActiveUIProject()
+        return active ?: initProject
+    }
+
+    private fun getActiveUIProject(): Project? {
+        val openProjects: Array<out Project> = ProjectManager.getInstance().openProjects
+        var active: Project? = null
+
+        for (project in openProjects) {
+            if (IdeFocusManager.getInstance(project).focusOwner != null) {
+                active = project
+                break
+            }
+        }
+
+        return active
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/common/helper/ActiveProjectHelper.kt

@@ -0,0 +1,57 @@
+/*
+ * 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.helper
+
+import com.intellij.openapi.project.Project
+import com.intellij.psi.PsiClass
+import org.domaframework.doma.intellij.extension.getJavaClazz
+import org.domaframework.doma.intellij.extension.psi.psiClassType
+
+class ExpressionFunctionsHelper {
+    companion object {
+        var expressionFunction: PsiClass? = null
+
+        fun setExpressionFunctionsInterface(project: Project): PsiClass? {
+            val expressionFunctionsClass =
+                project.getJavaClazz("org.seasar.doma.expr.ExpressionFunctions")
+            if (expressionFunctionsClass != null) {
+                expressionFunction = expressionFunctionsClass
+            }
+            return expressionFunction
+        }
+
+        fun isInheritor(expressionClazz: PsiClass?): Boolean {
+            val project = expressionClazz?.project
+
+            expressionFunction?.let { functionInterface ->
+                expressionClazz?.let {
+                    if (expressionClazz.isInheritor(functionInterface, true)) return true
+
+                    val parentType =
+                        expressionClazz.superTypes.firstOrNull()?.canonicalText
+                            ?: expressionClazz.psiClassType.canonicalText
+                    return project?.let {
+                        expressionClazz.psiClassType.canonicalText
+                        project
+                            .getJavaClazz(parentType)
+                            ?.isInheritor(functionInterface, true) == true
+                    } == true
+                }
+            }
+            return false
+        }
+    }
+}

src/main/kotlin/org/domaframework/doma/intellij/common/helper/ExpressionFunctionsHelper.kt

@@ -32,7 +32,7 @@ import com.intellij.psi.PsiManager
 import com.intellij.psi.PsiMethod
 import com.intellij.psi.PsiNameValuePair
 import com.intellij.util.IncorrectOperationException
-import org.domaframework.doma.intellij.common.CommonPathParameter.Companion.RESOURCES_PATH
+import org.domaframework.doma.intellij.common.CommonPathParameterHelper.RESOURCES_PATH
 import org.domaframework.doma.intellij.common.dao.formatSqlPathFromDaoPath
 import org.domaframework.doma.intellij.common.getExtension
 import org.domaframework.doma.intellij.extension.findFile

src/main/kotlin/org/domaframework/doma/intellij/common/psi/PsiDaoMethod.kt

@@ -16,15 +16,13 @@
 package org.domaframework.doma.intellij.common.sql.directive
 
 import com.intellij.codeInsight.completion.CompletionResultSet
-import com.intellij.openapi.project.Project
 import com.intellij.psi.PsiElement
 import com.intellij.psi.PsiFile
 
 class DirectiveCompletion(
     private val originalFile: PsiFile,
     private val bindText: String,
     private val element: PsiElement,
-    private val project: Project,
     private val result: CompletionResultSet,
 ) {
     fun directiveHandle(symbol: String): Boolean {
@@ -56,7 +54,6 @@ class DirectiveCompletion(
                     element = element,
                     result = result,
                     bindText = bindText,
-                    project = project,
                 ).directiveHandle()
 
             else -> return false