Merge pull request #301 from domaframework/feature/sql-format-support-cte

Support SQL Format for CTE

Author: xterao

src/main/java/org/domaframework/doma/intellij/Sql.flex

@@ -29,6 +29,7 @@ import org.domaframework.doma.intellij.psi.SqlTypes;
       "as",
       "asc",
       "between",
+      "breadth",
       "by",
       "case",
       "change",
@@ -39,6 +40,7 @@ import org.domaframework.doma.intellij.psi.SqlTypes;
       "comment",
       "create",
       "cross",
+      "cycle",
       "database",
       "default",
       "delete",
@@ -72,6 +74,7 @@ import org.domaframework.doma.intellij.psi.SqlTypes;
       "not",
       "nothing",
       "null",
+      "materialized",
       "modify",
       "offset",
       "on",
@@ -81,7 +84,10 @@ import org.domaframework.doma.intellij.psi.SqlTypes;
       "primary",
       "references",
       "rename",
+      "returning",
+      "recursive",
       "right",
+      "search",
       "select",
       "set",
       "table",
@@ -92,10 +98,12 @@ import org.domaframework.doma.intellij.psi.SqlTypes;
       "union",
       "unique",
       "update",
+      "using",
       "values",
       "view",
       "when",
-      "where"
+      "where",
+      "with"
   );
 
   // COLUMN DataTypes
@@ -128,6 +136,7 @@ import org.domaframework.doma.intellij.psi.SqlTypes;
    );
 
   private static boolean isKeyword(CharSequence word) {
+    // TODO Reads plugin settings and allows users to register arbitrary keywords
       return KEYWORDS.contains(word.toString().toLowerCase());
   }
 

src/main/kotlin/org/domaframework/doma/intellij/common/util/TypeUtil.kt

@@ -102,7 +102,7 @@ object TypeUtil {
      */
     fun isExpectedClassType(
         expectedClasses: List<KClass<*>>,
-        childBlock: SqlBlock,
+        childBlock: SqlBlock?,
     ): Boolean =
         expectedClasses.any { clazz ->
             clazz.isInstance(childBlock)

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/SqlBlock.kt

@@ -26,32 +26,27 @@ import com.intellij.formatting.Wrap
 import com.intellij.lang.ASTNode
 import com.intellij.psi.PsiWhiteSpace
 import com.intellij.psi.formatter.common.AbstractBlock
-import com.intellij.psi.util.PsiTreeUtil
-import org.domaframework.doma.intellij.common.util.TypeUtil.isExpectedClassType
 import org.domaframework.doma.intellij.formatter.block.comment.SqlBlockCommentBlock
 import org.domaframework.doma.intellij.formatter.block.comment.SqlCommentBlock
 import org.domaframework.doma.intellij.formatter.block.comment.SqlLineCommentBlock
-import org.domaframework.doma.intellij.formatter.block.conflict.SqlConflictClauseBlock
-import org.domaframework.doma.intellij.formatter.block.conflict.SqlDoGroupBlock
 import org.domaframework.doma.intellij.formatter.block.expr.SqlElBlockCommentBlock
 import org.domaframework.doma.intellij.formatter.block.expr.SqlElConditionLoopCommentBlock
 import org.domaframework.doma.intellij.formatter.block.expr.SqlElSymbolBlock
 import org.domaframework.doma.intellij.formatter.block.group.SqlNewGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.column.SqlColumnBlock
 import org.domaframework.doma.intellij.formatter.block.group.column.SqlColumnDefinitionRawGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.column.SqlColumnRawGroupBlock
-import org.domaframework.doma.intellij.formatter.block.group.column.SqlDataTypeBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.SqlInlineGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.SqlInlineSecondGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.SqlKeywordGroupBlock
-import org.domaframework.doma.intellij.formatter.block.group.keyword.create.SqlCreateTableColumnDefinitionGroupBlock
-import org.domaframework.doma.intellij.formatter.block.group.keyword.insert.SqlInsertColumnGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.update.SqlUpdateColumnAssignmentSymbolBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.update.SqlUpdateSetGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.with.SqlWithColumnGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.with.SqlWithCommonTableGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.with.SqlWithQueryGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlDataTypeParamBlock
 import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlFunctionParamBlock
-import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlParallelListBlock
-import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlRightPatternBlock
+import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlSubGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlSubQueryGroupBlock
 import org.domaframework.doma.intellij.formatter.builder.SqlBlockBuilder
 import org.domaframework.doma.intellij.formatter.builder.SqlCustomSpacingBuilder
@@ -93,6 +88,7 @@ open class SqlBlock(
     val blocks = mutableListOf<AbstractBlock>()
     open var parentBlock: SqlBlock? = null
     open val childBlocks = mutableListOf<SqlBlock>()
+
     open val indent: ElementIndent =
         ElementIndent(
             IndentType.FILE,
@@ -118,8 +114,6 @@ open class SqlBlock(
         // This method can be overridden to set additional properties on the parent block if needed.
     }
 
-    open val isNeedWhiteSpace: Boolean = true
-
     open fun addChildBlock(childBlock: SqlBlock) {
         childBlocks.add(childBlock)
     }
@@ -137,10 +131,10 @@ open class SqlBlock(
             val lastGroup = blockBuilder.getLastGroupTopNodeIndexHistory()
             if (child !is PsiWhiteSpace) {
                 val childBlock = getBlock(child)
-                updateWhiteSpaceInclude(lastBlock, childBlock, lastGroup)
                 prevNonWhiteSpaceNode = child
                 updateCommentParentAndIdent(childBlock)
                 updateBlockParentAndLAddGroup(childBlock)
+                updateWhiteSpaceInclude(lastBlock, childBlock, lastGroup)
                 blocks.add(childBlock)
             } else {
                 if (lastBlock !is SqlLineCommentBlock) {
@@ -195,88 +189,15 @@ open class SqlBlock(
         }
     }
 
+    open fun isSaveSpace(lastGroup: SqlBlock?): Boolean = false
+
     /**
      * Determines whether to retain the space (newline) based on the last registered group or the class of the currently checked element.
      */
     private fun isSaveWhiteSpace(
         childBlock: SqlBlock,
         lastGroup: SqlBlock?,
-    ): Boolean {
-        val child = childBlock.node
-
-        if (!childBlock.isNeedWhiteSpace) return false
-
-        val expectedClassTypes =
-            listOf(
-                SqlElConditionLoopCommentBlock::class,
-                SqlInsertColumnGroupBlock::class,
-                SqlColumnDefinitionRawGroupBlock::class,
-                SqlCreateTableColumnDefinitionGroupBlock::class,
-                SqlUpdateColumnAssignmentSymbolBlock::class,
-                SqlDoGroupBlock::class,
-            )
-
-        if (isExpectedClassType(expectedClassTypes, childBlock)) return true
-
-        if (isNewLineSqlComment(child, childBlock)) return true
-
-        if (lastGroup is SqlConflictClauseBlock) return false
-        if (childBlock is SqlColumnRawGroupBlock) {
-            return !childBlock.isFirstColumnGroup
-        }
-
-        return (
-            isNewLineGroupBlockAfterRegistrationChild(childBlock, lastGroup) ||
-                (childBlock is SqlRightPatternBlock && childBlock.isNewLine(lastGroup))
-        )
-    }
-
-    /**
-     * Retains the block only for comments that are broken down.
-     */
-    private fun isNewLineSqlComment(
-        child: ASTNode,
-        childBlock: SqlBlock,
-    ): Boolean {
-        val commentBlockType =
-            listOf(
-                SqlLineCommentBlock::class,
-                SqlBlockCommentBlock::class,
-            )
-        val prevSpace = PsiTreeUtil.prevLeaf(child.psi)
-        return isExpectedClassType(
-            commentBlockType,
-            childBlock,
-        ) &&
-            prevSpace?.text?.contains("\n") == true
-    }
-
-    /**
-     * Determines whether a newline is required after registering itself as a child of the parent block.
-     */
-    private fun isNewLineGroupBlockAfterRegistrationChild(
-        childBlock: SqlBlock,
-        lastGroup: SqlBlock?,
-    ): Boolean {
-        fun isParallelListRawChild(): Boolean =
-            childBlock is SqlCommaBlock &&
-                (
-                    lastGroup is SqlParallelListBlock ||
-                        lastGroup?.parentBlock is SqlParallelListBlock
-                )
-
-        if (isParallelListRawChild()) return false
-
-        if (parentSetProcessor.isNewGroupAndNotSetLineKeywords(childBlock, lastGroup)) {
-            return if (lastGroup is SqlSubQueryGroupBlock) {
-                val lastGroupChildren = lastGroup.childBlocks
-                (lastGroupChildren.isNotEmpty() && lastGroupChildren.drop(1).isNotEmpty())
-            } else {
-                true
-            }
-        }
-        return false
-    }
+    ): Boolean = childBlock.isSaveSpace(lastGroup)
 
     /**
      * Updates the parent block or registers itself as a new group block based on the class of the target block.
@@ -349,8 +270,8 @@ open class SqlBlock(
                 )
             }
 
-            is SqlSubQueryGroupBlock -> {
-                parentSetProcessor.updateGroupBlockParentAndAddGroup(
+            is SqlSubGroupBlock -> {
+                parentSetProcessor.updateSubGroupBlockParent(
                     childBlock,
                 )
             }
@@ -395,6 +316,8 @@ open class SqlBlock(
      */
     open fun createBlockIndentLen(): Int = 0
 
+    open fun createGroupIndentLen(): Int = 0
+
     /**
      * Creates a block for the given child AST node.
      */
@@ -449,13 +372,27 @@ open class SqlBlock(
             )
 
             SqlTypes.COMMA -> {
-                return blockUtil.getCommaGroupBlock(lastGroup, child)
+                return if (lastGroup is SqlWithQueryGroupBlock) {
+                    SqlWithCommonTableGroupBlock(child, defaultFormatCtx)
+                } else {
+                    blockUtil.getCommaGroupBlock(lastGroup, child)
+                }
             }
 
-            SqlTypes.WORD -> return blockUtil.getWordBlock(lastGroup, child)
+            SqlTypes.WORD -> {
+                return if (lastGroup is SqlWithQueryGroupBlock) {
+                    SqlWithCommonTableGroupBlock(child, defaultFormatCtx)
+                } else {
+                    blockUtil.getWordBlock(lastGroup, child)
+                }
+            }
 
             SqlTypes.BLOCK_COMMENT -> {
-                return blockUtil.getBlockCommentBlock(child, createBlockCommentSpacingBuilder())
+                return if (lastGroup is SqlWithCommonTableGroupBlock) {
+                    SqlWithCommonTableGroupBlock(child, defaultFormatCtx)
+                } else {
+                    blockUtil.getBlockCommentBlock(child, createBlockCommentSpacingBuilder())
+                }
             }
 
             SqlTypes.LINE_COMMENT ->
@@ -555,6 +492,14 @@ open class SqlBlock(
             return SqlCustomSpacingBuilder().getSpacing(child2)
         }
 
+        if (child2 is SqlWithColumnGroupBlock) {
+            return SqlCustomSpacingBuilder.normalSpacing
+        }
+
+        if (child1 is SqlSubGroupBlock && child2 is SqlSubGroupBlock) {
+            return SqlCustomSpacingBuilder.nonSpacing
+        }
+
         // Do not leave a space after the comment block of the bind variable
         if (child1 is SqlElBlockCommentBlock && child1 !is SqlElConditionLoopCommentBlock && child2 !is SqlCommentBlock) {
             return SqlCustomSpacingBuilder.nonSpacing
@@ -587,6 +532,9 @@ open class SqlBlock(
         }
 
         if (child2 is SqlNewGroupBlock) {
+            if (child1 is SqlSubGroupBlock && child2.indent.indentLevel == IndentType.ATTACHED) {
+                return SqlCustomSpacingBuilder.nonSpacing
+            }
             when (child2) {
                 is SqlSubQueryGroupBlock -> {
                     if (child1 is SqlNewGroupBlock) {

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/SqlCommaBlock.kt

@@ -19,10 +19,15 @@ import com.intellij.lang.ASTNode
 import com.intellij.psi.formatter.common.AbstractBlock
 import org.domaframework.doma.intellij.common.util.TypeUtil
 import org.domaframework.doma.intellij.formatter.block.group.column.SqlColumnRawGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.SqlKeywordGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.create.SqlCreateKeywordGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.insert.SqlInsertColumnGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.insert.SqlInsertValueGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.update.SqlUpdateColumnGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.update.SqlUpdateSetGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.update.SqlUpdateValueGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.keyword.with.SqlWithColumnGroupBlock
+import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlFunctionParamBlock
 import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlParallelListBlock
 import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlSubGroupBlock
 import org.domaframework.doma.intellij.formatter.util.IndentType
@@ -67,27 +72,38 @@ open class SqlCommaBlock(
                 val parentIndentSyncBlockTypes =
                     listOf(
                         SqlUpdateColumnGroupBlock::class,
-                        SqlUpdateValueGroupBlock::class,
                         SqlInsertColumnGroupBlock::class,
+                        SqlWithColumnGroupBlock::class,
                     )
                 val parentIndentLen = parent.indent.groupIndentLen
                 if (TypeUtil.isExpectedClassType(parentIndentSyncBlockTypes, parent)) {
                     return parentIndentLen
                 }
 
+                // TODO Indent each comma in a value group so that it aligns with the position of the first value row.
+                val parentIndentSingleSpaceTypes =
+                    listOf(
+                        SqlInsertValueGroupBlock::class,
+                        SqlUpdateValueGroupBlock::class,
+                    )
+                if (TypeUtil.isExpectedClassType(parentIndentSingleSpaceTypes, parent)) {
+                    return parentIndentLen.plus(1)
+                }
+
                 val grand = parent.parentBlock
                 grand?.let { grand ->
                     if (grand is SqlCreateKeywordGroupBlock) {
                         val grandIndentLen = grand.indent.groupIndentLen
                         return grandIndentLen.plus(parentIndentLen).minus(1)
                     }
 
+                    val grandIndent = grand.indent.indentLen
+                    val groupIndent = parentBlock?.indent?.groupIndentLen ?: 0
+
                     if (grand is SqlColumnRawGroupBlock) {
-                        val grandIndentLen = grand.indent.groupIndentLen
-                        var prevTextLen = 1
-                        parent.prevChildren?.dropLast(1)?.forEach { prev -> prevTextLen = prevTextLen.plus(prev.getNodeText().length) }
-                        return grandIndentLen.plus(prevTextLen).plus(1)
+                        return groupIndent.plus(grandIndent)
                     }
+                    return groupIndent.plus(grandIndent).minus(1)
                 }
                 return parentIndentLen.plus(1)
             } else {
@@ -104,10 +120,24 @@ open class SqlCommaBlock(
                             )
                     }
                 return parent.indent.groupIndentLen
-                    .plus(prevLen)
                     .plus(1)
             }
         }
         return 1
     }
+
+    override fun isSaveSpace(lastGroup: SqlBlock?): Boolean {
+        val exceptionTypes =
+            listOf(
+                SqlInsertColumnGroupBlock::class,
+                SqlInsertValueGroupBlock::class,
+                SqlUpdateSetGroupBlock::class,
+                SqlUpdateColumnGroupBlock::class,
+                SqlUpdateValueGroupBlock::class,
+                SqlFunctionParamBlock::class,
+                SqlWithColumnGroupBlock::class,
+                SqlKeywordGroupBlock::class,
+            )
+        return TypeUtil.isExpectedClassType(exceptionTypes, parentBlock)
+    }
 }

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/SqlDataTypeBlock.kt

@@ -13,11 +13,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.domaframework.doma.intellij.formatter.block.group.column
+package org.domaframework.doma.intellij.formatter.block
 
 import com.intellij.lang.ASTNode
 import com.intellij.psi.formatter.common.AbstractBlock
-import org.domaframework.doma.intellij.formatter.block.SqlBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.create.SqlCreateTableColumnDefinitionRawGroupBlock
 import org.domaframework.doma.intellij.formatter.util.IndentType
 import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext