Implement spacing rules within multi-line comment blocks.

Author: xterao

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

@@ -66,7 +66,7 @@ import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
 import org.domaframework.doma.intellij.formatter.util.SqlBlockGenerator
 import org.domaframework.doma.intellij.psi.SqlTypes
 
-class SqlFileBlock(
+open class SqlFileBlock(
     node: ASTNode,
     wrap: Wrap?,
     alignment: Alignment?,
@@ -221,7 +221,7 @@ class SqlFileBlock(
                 return if (lastGroup is SqlWithCommonTableGroupBlock) {
                     SqlWithCommonTableGroupBlock(child, defaultFormatCtx)
                 } else {
-                    blockUtil.getBlockCommentBlock(child, createBlockCommentSpacingBuilder())
+                    blockUtil.getBlockCommentBlock(child, createBlockDirectiveCommentSpacingBuilder())
                 }
             }
 
@@ -416,15 +416,11 @@ class SqlFileBlock(
     }
 
     /**
-     * Creates a spacing builder specifically for block comments.
+     * Creates a spacing builder specifically for directive block comments.
      */
-    private fun createBlockCommentSpacingBuilder(): SqlCustomSpacingBuilder =
+    protected fun createBlockDirectiveCommentSpacingBuilder(): SqlCustomSpacingBuilder =
         SqlCustomSpacingBuilder()
             .withSpacing(
-                SqlTypes.BLOCK_COMMENT_START,
-                SqlTypes.BLOCK_COMMENT_CONTENT,
-                Spacing.createSpacing(0, 0, 0, true, 0),
-            ).withSpacing(
                 SqlTypes.BLOCK_COMMENT_START,
                 SqlTypes.EL_ID_EXPR,
                 Spacing.createSpacing(1, 1, 0, true, 0),
@@ -572,10 +568,6 @@ class SqlFileBlock(
                 SqlTypes.EL_STATIC_FIELD_ACCESS_EXPR,
                 SqlTypes.BLOCK_COMMENT_END,
                 Spacing.createSpacing(1, 1, 0, true, 0),
-            ).withSpacing(
-                SqlTypes.BLOCK_COMMENT_CONTENT,
-                SqlTypes.BLOCK_COMMENT_END,
-                Spacing.createSpacing(0, 0, 0, true, 0),
             )
 
     /**

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

@@ -15,19 +15,57 @@
  */
 package org.domaframework.doma.intellij.formatter.block.comment
 
+import com.intellij.formatting.Block
+import com.intellij.formatting.Spacing
 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.StringUtil
 import org.domaframework.doma.intellij.formatter.block.SqlBlock
+import org.domaframework.doma.intellij.formatter.block.SqlUnknownBlock
+import org.domaframework.doma.intellij.formatter.builder.SqlCustomSpacingBuilder
 import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
+import org.domaframework.doma.intellij.psi.SqlTypes
 
 open class SqlBlockCommentBlock(
     node: ASTNode,
-    context: SqlBlockFormattingContext,
+    private val customSpacingBuilder: SqlCustomSpacingBuilder,
+    private val context: SqlBlockFormattingContext,
 ) : SqlDefaultCommentBlock(
         node,
         context,
     ) {
+    override fun buildChildren(): MutableList<AbstractBlock> {
+        val blocks = mutableListOf<AbstractBlock>()
+        var child = node.firstChildNode
+        while (child != null) {
+            if (child !is PsiWhiteSpace) {
+                val block = getBlock(child)
+                blocks.add(block)
+            }
+            child = child.treeNext
+        }
+        return blocks
+    }
+
+    override fun getBlock(child: ASTNode): SqlBlock {
+        val elementType = child.elementType
+        return when (elementType) {
+            SqlTypes.BLOCK_COMMENT_START -> SqlCommentStartBlock(child, context)
+            SqlTypes.BLOCK_COMMENT_END -> SqlCommentEndBlock(child, context)
+            SqlTypes.BLOCK_COMMENT_CONTENT -> SqlCommentContentBlock(child, context)
+            else -> SqlUnknownBlock(child, context)
+        }
+    }
+
     override fun isSaveSpace(lastGroup: SqlBlock?): Boolean =
         PsiTreeUtil.prevLeaf(node.psi)?.text?.contains(StringUtil.LINE_SEPARATE) == true
+
+    override fun getSpacing(
+        child1: Block?,
+        child2: Block,
+    ): Spacing? =
+        customSpacingBuilder.getCustomSpacing(child1, child2)
+            ?: SqlCustomSpacingBuilder.normalSpacing
 }

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

@@ -0,0 +1,16 @@
+package org.domaframework.doma.intellij.formatter.block.comment
+
+import com.intellij.lang.ASTNode
+import org.domaframework.doma.intellij.formatter.block.SqlBlock
+import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
+
+class SqlCommentContentBlock(
+    node: ASTNode,
+    context: SqlBlockFormattingContext,
+) : SqlCommentBlock(node, context) {
+    override fun isSaveSpace(lastGroup: SqlBlock?): Boolean = false
+
+    override fun createBlockIndentLen(): Int = parentBlock?.indent?.indentLen ?: 1
+
+    override fun createGroupIndentLen(): Int = indent.indentLen
+}

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

@@ -0,0 +1,21 @@
+package org.domaframework.doma.intellij.formatter.block.comment
+
+import com.intellij.lang.ASTNode
+import com.intellij.psi.PsiComment
+import com.intellij.psi.util.PsiTreeUtil
+import org.domaframework.doma.intellij.formatter.block.SqlBlock
+import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
+
+class SqlCommentEndBlock(
+    node: ASTNode,
+    context: SqlBlockFormattingContext,
+) : SqlCommentSeparateBlock(node, context) {
+    override fun isSaveSpace(lastGroup: SqlBlock?): Boolean {
+        parentBlock?.let { parent ->
+            val contents =
+                PsiTreeUtil.getChildOfType<PsiComment>(parent.node.psi, PsiComment::class.java)
+            return contents != null
+        }
+        return false
+    }
+}

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

@@ -0,0 +1,23 @@
+package org.domaframework.doma.intellij.formatter.block.comment
+
+import com.intellij.lang.ASTNode
+import org.domaframework.doma.intellij.formatter.block.SqlBlock
+import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
+
+abstract class SqlCommentSeparateBlock(
+    node: ASTNode,
+    context: SqlBlockFormattingContext,
+) : SqlBlock(
+        node,
+        context.wrap,
+        context.alignment,
+        context.spacingBuilder,
+        context.enableFormat,
+        context.formatMode,
+    ) {
+    override fun isSaveSpace(lastGroup: SqlBlock?): Boolean = false
+
+    override fun createBlockIndentLen(): Int = parentBlock?.indent?.indentLen ?: 0
+
+    override fun createGroupIndentLen(): Int = indent.indentLen
+}

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

@@ -0,0 +1,12 @@
+package org.domaframework.doma.intellij.formatter.block.comment
+
+import com.intellij.lang.ASTNode
+import org.domaframework.doma.intellij.formatter.block.SqlBlock
+import org.domaframework.doma.intellij.formatter.util.SqlBlockFormattingContext
+
+class SqlCommentStartBlock(
+    node: ASTNode,
+    context: SqlBlockFormattingContext,
+) : SqlCommentSeparateBlock(node, context) {
+    override fun isSaveSpace(lastGroup: SqlBlock?): Boolean = false
+}

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

@@ -108,6 +108,10 @@ open class SqlElBlockCommentBlock(
                     createFieldAccessSpacingBuilder(),
                 )
 
+            SqlTypes.BLOCK_COMMENT_START -> SqlCommentStartBlock(child, context)
+
+            SqlTypes.BLOCK_COMMENT_END -> SqlCommentEndBlock(child, context)
+
             SqlTypes.EL_STATIC_FIELD_ACCESS_EXPR ->
                 SqlElStaticFieldAccessBlock(
                     child,
@@ -121,7 +125,7 @@ open class SqlElBlockCommentBlock(
                 )
 
             SqlTypes.BLOCK_COMMENT_CONTENT ->
-                SqlBlockCommentBlock(child, context)
+                SqlBlockCommentBlock(child, createBlockCommentSpacingBuilder(), context)
 
             else -> SqlUnknownBlock(child, context)
         }
@@ -146,6 +150,14 @@ open class SqlElBlockCommentBlock(
                 Spacing.createSpacing(0, 0, 0, false, 0),
             )
 
+    protected fun createBlockCommentSpacingBuilder(): SqlCustomSpacingBuilder =
+        SqlCustomSpacingBuilder()
+            .withSpacing(
+                SqlTypes.BLOCK_COMMENT_START,
+                SqlTypes.BLOCK_COMMENT_CONTENT,
+                Spacing.createSpacing(1, 1, 0, false, 0),
+            )
+
     override fun getSpacing(
         child1: Block?,
         child2: Block,

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

@@ -159,9 +159,6 @@ class SqlElConditionLoopCommentBlock(
                     context,
                 )
 
-            SqlTypes.BLOCK_COMMENT_CONTENT ->
-                SqlBlockCommentBlock(child, context)
-
             else -> SqlUnknownBlock(child, context)
         }
 

src/main/kotlin/org/domaframework/doma/intellij/formatter/util/SqlBlockGenerator.kt

@@ -17,6 +17,7 @@ package org.domaframework.doma.intellij.formatter.util
 
 import com.intellij.formatting.Alignment
 import com.intellij.formatting.FormattingMode
+import com.intellij.formatting.Spacing
 import com.intellij.formatting.SpacingBuilder
 import com.intellij.formatting.Wrap
 import com.intellij.lang.ASTNode
@@ -72,6 +73,7 @@ import org.domaframework.doma.intellij.formatter.handler.NotQueryGroupHandler
 import org.domaframework.doma.intellij.formatter.handler.UpdateClauseHandler
 import org.domaframework.doma.intellij.formatter.handler.WithClauseHandler
 import org.domaframework.doma.intellij.psi.SqlCustomElCommentExpr
+import org.domaframework.doma.intellij.psi.SqlTypes
 
 data class SqlBlockFormattingContext(
     val wrap: Wrap?,
@@ -451,7 +453,7 @@ class SqlBlockGenerator(
         blockCommentSpacingBuilder: SqlCustomSpacingBuilder?,
     ): SqlCommentBlock {
         if (PsiTreeUtil.getChildOfType(child.psi, PsiComment::class.java) != null) {
-            return SqlBlockCommentBlock(child, sqlBlockFormattingCtx)
+            return SqlBlockCommentBlock(child, createBlockCommentSpacingBuilder(), sqlBlockFormattingCtx)
         }
         if (child.psi is SqlCustomElCommentExpr &&
             (child.psi as SqlCustomElCommentExpr).isConditionOrLoopDirective()
@@ -468,4 +470,16 @@ class SqlBlockGenerator(
             blockCommentSpacingBuilder,
         )
     }
+
+    private fun createBlockCommentSpacingBuilder(): SqlCustomSpacingBuilder =
+        SqlCustomSpacingBuilder()
+            .withSpacing(
+                SqlTypes.BLOCK_COMMENT_START,
+                SqlTypes.BLOCK_COMMENT_CONTENT,
+                Spacing.createSpacing(0, 0, 0, true, 0),
+            ).withSpacing(
+                SqlTypes.BLOCK_COMMENT_CONTENT,
+                SqlTypes.BLOCK_COMMENT_END,
+                Spacing.createSpacing(0, 0, 0, true, 0),
+            )
 }