Merge pull request #308 from domaframework/feature/sql-format-support-lateral

Implement Formatting Rules for `LATERAL`

Author: xterao

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

@@ -69,6 +69,7 @@ import org.domaframework.doma.intellij.psi.SqlTypes;
       "is",
       "join",
       "key",
+      "lateral",
       "left",
       "like",
       "limit",

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

@@ -22,8 +22,7 @@ import org.jetbrains.jps.model.java.JavaResourceRootType
 import org.jetbrains.jps.model.java.JavaSourceRootType
 import java.util.concurrent.ConcurrentHashMap
 
-val RESOURCES_META_INF_PATH: String
-    get() = "META-INF"
+const val RESOURCES_META_INF_PATH: String = "META-INF"
 
 /**
  * A utility for caching directory information on a per-module basis.

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

@@ -32,7 +32,6 @@ import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlParalle
 import org.domaframework.doma.intellij.formatter.block.group.subgroup.SqlSubGroupBlock
 import org.domaframework.doma.intellij.formatter.util.IndentType
 import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
-import org.domaframework.doma.intellij.psi.SqlTypes
 
 open class SqlCommaBlock(
     node: ASTNode,
@@ -107,27 +106,14 @@ open class SqlCommaBlock(
                 }
                 return parentIndentLen.plus(1)
             } else {
-                var prevLen = 0
-                parent.childBlocks
-                    .filter { it.node.elementType == SqlTypes.KEYWORD }
-                    .forEach { prev ->
-                        prevLen =
-                            prevLen.plus(
-                                prev
-                                    .getNodeText()
-                                    .length
-                                    .plus(1),
-                            )
-                    }
-                return parent.indent.groupIndentLen
-                    .plus(1)
+                return parent.indent.groupIndentLen.plus(1)
             }
         }
         return 1
     }
 
     override fun isSaveSpace(lastGroup: SqlBlock?): Boolean {
-        val exceptionTypes =
+        val expectedTypes =
             listOf(
                 SqlInsertColumnGroupBlock::class,
                 SqlInsertValueGroupBlock::class,
@@ -138,6 +124,6 @@ open class SqlCommaBlock(
                 SqlWithColumnGroupBlock::class,
                 SqlKeywordGroupBlock::class,
             )
-        return TypeUtil.isExpectedClassType(exceptionTypes, parentBlock)
+        return TypeUtil.isExpectedClassType(expectedTypes, parentBlock)
     }
 }

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

@@ -15,7 +15,6 @@
  */
 package org.domaframework.doma.intellij.formatter.block
 
-import com.intellij.formatting.Indent
 import com.intellij.lang.ASTNode
 import com.intellij.psi.formatter.common.AbstractBlock
 import org.domaframework.doma.intellij.formatter.block.conflict.SqlDoGroupBlock
@@ -67,13 +66,6 @@ open class SqlKeywordBlock(
 
     override fun buildChildren(): MutableList<AbstractBlock> = mutableListOf()
 
-    override fun getIndent(): Indent? {
-        if (!isAdjustIndentOnEnter() && parentBlock?.indent?.indentLevel == IndentType.SUB) {
-            return Indent.getIndent(Indent.Type.SPACES, 0, false, true)
-        }
-        return Indent.getNoneIndent()
-    }
-
     override fun createBlockIndentLen(): Int =
         when (indentLevel) {
             IndentType.TOP -> {

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

@@ -42,13 +42,11 @@ open class SqlOtherBlock(
     override fun setParentGroupBlock(lastGroup: SqlBlock?) {
         super.setParentGroupBlock(lastGroup)
         indent.indentLevel = IndentType.NONE
-        indent.indentLen = createIndentLen()
+        indent.indentLen = 1
         indent.groupIndentLen = 0
     }
 
     override fun buildChildren(): MutableList<AbstractBlock> = mutableListOf()
 
-    private fun createIndentLen(): Int = 1
-
     override fun isLeaf(): Boolean = true
 }

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

@@ -18,7 +18,6 @@ package org.domaframework.doma.intellij.formatter.block
 import com.intellij.formatting.Alignment
 import com.intellij.formatting.Block
 import com.intellij.formatting.FormattingMode
-import com.intellij.formatting.Indent
 import com.intellij.formatting.Spacing
 import com.intellij.formatting.SpacingBuilder
 import com.intellij.formatting.Wrap
@@ -42,8 +41,6 @@ class SqlWhitespaceBlock(
     ) {
     override fun buildChildren(): MutableList<AbstractBlock> = mutableListOf()
 
-    override fun getIndent(): Indent? = Indent.getNoneIndent()
-
     override fun isLeaf(): Boolean = true
 
     override fun getSpacing(

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/keyword/SqlInlineGroupBlock.kt

@@ -15,7 +15,6 @@
  */
 package org.domaframework.doma.intellij.formatter.block.group.keyword
 
-import com.intellij.formatting.Indent
 import com.intellij.lang.ASTNode
 import com.intellij.psi.formatter.common.AbstractBlock
 import org.domaframework.doma.intellij.formatter.block.SqlBlock
@@ -46,13 +45,6 @@ open class SqlInlineGroupBlock(
 
     override fun buildChildren(): MutableList<AbstractBlock> = mutableListOf()
 
-    override fun getIndent(): Indent? {
-        if (!isAdjustIndentOnEnter() && parentBlock?.indent?.indentLevel == IndentType.SUB) {
-            return Indent.getSpaceIndent(0)
-        }
-        return Indent.getNoneIndent()
-    }
-
     override fun createBlockIndentLen(): Int =
         parentBlock?.let {
             it.indent.groupIndentLen

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/keyword/SqlInlineSecondGroupBlock.kt

@@ -15,7 +15,6 @@
  */
 package org.domaframework.doma.intellij.formatter.block.group.keyword
 
-import com.intellij.formatting.Indent
 import com.intellij.lang.ASTNode
 import com.intellij.psi.formatter.common.AbstractBlock
 import org.domaframework.doma.intellij.formatter.block.SqlBlock
@@ -48,13 +47,6 @@ open class SqlInlineSecondGroupBlock(
 
     override fun buildChildren(): MutableList<AbstractBlock> = mutableListOf()
 
-    override fun getIndent(): Indent? =
-        if (isAdjustIndentOnEnter()) {
-            null
-        } else {
-            Indent.getSpaceIndent(indent.indentLen)
-        }
-
     override fun createBlockIndentLen(): Int =
         parentBlock?.let {
             // TODO:Customize indentation within an inline group

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/keyword/SqlJoinGroupBlock.kt

@@ -15,7 +15,6 @@
  */
 package org.domaframework.doma.intellij.formatter.block.group.keyword
 
-import com.intellij.formatting.Indent
 import com.intellij.lang.ASTNode
 import com.intellij.psi.formatter.common.AbstractBlock
 import org.domaframework.doma.intellij.formatter.block.SqlBlock
@@ -41,24 +40,26 @@ open class SqlJoinGroupBlock(
         parentBlock = lastGroup
         parentBlock?.childBlocks?.add(this)
         indent.indentLevel = IndentType.JOIN
-        indent.indentLen = createBlockIndentLen(null)
+        indent.indentLen = createBlockIndentLen()
         indent.groupIndentLen = createGroupIndentLen()
     }
 
     override fun buildChildren(): MutableList<AbstractBlock> = mutableListOf()
 
-    override fun getIndent(): Indent? =
-        if (isAdjustIndentOnEnter()) {
-            null
-        } else {
-            Indent.getSpaceIndent(indent.indentLen)
-        }
-
-    override fun createBlockIndentLen(preChildBlock: SqlBlock?): Int =
+    override fun createBlockIndentLen(): Int =
         parentBlock
             ?.indent
             ?.groupIndentLen
             ?.plus(1) ?: 1
 
+    override fun createGroupIndentLen(): Int =
+        indent.indentLen
+            .plus(
+                topKeywordBlocks
+                    .drop(1)
+                    .filter { it !is SqlLateralGroupBlock }
+                    .sumOf { it.getNodeText().length.plus(1) },
+            ).plus(getNodeText().length)
+
     override fun isSaveSpace(lastGroup: SqlBlock?): Boolean = true
 }

src/main/kotlin/org/domaframework/doma/intellij/formatter/block/group/keyword/SqlKeywordGroupBlock.kt

@@ -15,10 +15,13 @@
  */
 package org.domaframework.doma.intellij.formatter.block.group.keyword
 
-import com.intellij.formatting.Indent
 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.SqlBlock
+import org.domaframework.doma.intellij.formatter.block.SqlKeywordBlock
+import org.domaframework.doma.intellij.formatter.block.comment.SqlBlockCommentBlock
+import org.domaframework.doma.intellij.formatter.block.comment.SqlLineCommentBlock
 import org.domaframework.doma.intellij.formatter.block.group.SqlNewGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.top.SqlSelectQueryGroupBlock
 import org.domaframework.doma.intellij.formatter.block.group.keyword.with.SqlWithCommonTableGroupBlock
@@ -33,9 +36,24 @@ open class SqlKeywordGroupBlock(
     context: SqlBlockFormattingContext,
 ) : SqlNewGroupBlock(node, context) {
     val topKeywordBlocks: MutableList<SqlBlock> = mutableListOf(this)
+    var canAddTopKeyword = true
 
     fun updateTopKeywordBlocks(block: SqlBlock) {
-        topKeywordBlocks.add(block)
+        val lastChild =
+            getChildBlocksDropLast()
+                .findLast { it !is SqlLineCommentBlock && it !is SqlBlockCommentBlock }
+        val topKeywordTypes =
+            listOf(
+                SqlKeywordBlock::class,
+                SqlKeywordGroupBlock::class,
+            )
+
+        if (lastChild == null || TypeUtil.isExpectedClassType(topKeywordTypes, lastChild) && canAddTopKeyword) {
+            topKeywordBlocks.add(block)
+        } else {
+            canAddTopKeyword = false
+        }
+
         indent.groupIndentLen = createGroupIndentLen()
     }
 
@@ -85,27 +103,15 @@ open class SqlKeywordGroupBlock(
         if (preChildBlock.indent.indentLevel == this.indent.indentLevel &&
             !SqlKeywordUtil.isSetLineKeyword(getNodeText(), preChildBlock.getNodeText())
         ) {
-            if (indent.indentLevel == IndentType.SECOND) {
-                val diffPreBlockTextLen = getNodeText().length.minus(preChildBlock.getNodeText().length)
-                return preChildBlock.indent.indentLen.minus(diffPreBlockTextLen)
-            } else {
-                val diffPretextLen = getNodeText().length.minus(preChildBlock.getNodeText().length)
-                return preChildBlock.indent.indentLen.minus(diffPretextLen)
-            }
+            val diffPretextLen = getNodeText().length.minus(preChildBlock.getNodeText().length)
+            return preChildBlock.indent.indentLen.minus(diffPretextLen)
         } else {
             return createBlockIndentLen(preChildBlock)
         }
     }
 
     override fun buildChildren(): MutableList<AbstractBlock> = mutableListOf()
 
-    override fun getIndent(): Indent? {
-        if (!isAdjustIndentOnEnter() && parentBlock?.indent?.indentLevel == IndentType.SUB) {
-            return Indent.getSpaceIndent(0)
-        }
-        return Indent.getNoneIndent()
-    }
-
     /**
      * Adjust the indent position of the subgroup block element itself if it has a comment
      */
@@ -157,10 +163,7 @@ open class SqlKeywordGroupBlock(
         return 1
     }
 
-    override fun createGroupIndentLen(): Int =
-        indent.indentLen
-            .plus(topKeywordBlocks.drop(1).sumOf { it.getNodeText().length.plus(1) })
-            .plus(getNodeText().length)
+    override fun createGroupIndentLen(): Int = indent.indentLen.plus(topKeywordBlocks.sumOf { it.getNodeText().length.plus(1) }.minus(1))
 
     override fun isSaveSpace(lastGroup: SqlBlock?): Boolean = true
 }