[clang] [clang-format] Fix SeparateDefinitionBlocks for scoped enums (PR #239167)

via cfe-commits cfe-commits at lists.llvm.org
Thu Nov 5 02:14:45 PST 2026


llvmorg-github-actions[bot] wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang-format

Author: woruyu (woruyu)

<details>
<summary>Changes</summary>

This fixes https://github.com/llvm/llvm-project/issues/238675. Do not treat the class or struct keyword in a scoped enum as a record definition when excluding enums. This allows scoped enums to use the enum-specific logic for inserting and removing definition separators.

Assisted-by: OpenAI Codex

---
Full diff: https://github.com/llvm/llvm-project/pull/239167.diff


3 Files Affected:

- (modified) clang/docs/ReleaseNotes.md (+2) 
- (modified) clang/lib/Format/DefinitionBlockSeparator.cpp (+5-1) 
- (modified) clang/unittests/Format/DefinitionBlockSeparatorTest.cpp (+43) 


``````````diff
diff --git a/clang/docs/ReleaseNotes.md b/clang/docs/ReleaseNotes.md
index 456c861307cb8..d5b645f4433ea 100644
--- a/clang/docs/ReleaseNotes.md
+++ b/clang/docs/ReleaseNotes.md
@@ -1429,6 +1429,8 @@ documentation](CIR/index.md) for more information regarding ClangIR's status and
 
 ### clang-format
 
+- Fix `SeparateDefinitionBlocks` not inserting or removing empty lines around
+  scoped enum definitions.
 - Add `RegroupByDirectory` value to `IncludeBlocks` to group includes by
   category priority and top-level directory.
 - Add `SpacesInBlockComments` option to control spacing after `/*` and
diff --git a/clang/lib/Format/DefinitionBlockSeparator.cpp b/clang/lib/Format/DefinitionBlockSeparator.cpp
index 5fc5ba04529b5..a5bd8341dcb40 100644
--- a/clang/lib/Format/DefinitionBlockSeparator.cpp
+++ b/clang/lib/Format/DefinitionBlockSeparator.cpp
@@ -55,7 +55,11 @@ void DefinitionBlockSeparator::separateBlocks(
                                   tok::kw_union) ||
             (Style.isJavaScript() &&
              CurrentToken->is(ExtraKeywords.kw_function))) {
-          return true;
+          // The class/struct keyword in a scoped enum is not a record
+          // definition.
+          const auto *Previous = CurrentToken->getPreviousNonComment();
+          if (!ExcludeEnum || !Previous || Previous->isNot(tok::kw_enum))
+            return true;
         }
         if (!ExcludeEnum && CurrentToken->is(tok::kw_enum))
           return true;
diff --git a/clang/unittests/Format/DefinitionBlockSeparatorTest.cpp b/clang/unittests/Format/DefinitionBlockSeparatorTest.cpp
index d18ab4e5f7965..8e367cc5bed53 100644
--- a/clang/unittests/Format/DefinitionBlockSeparatorTest.cpp
+++ b/clang/unittests/Format/DefinitionBlockSeparatorTest.cpp
@@ -191,6 +191,49 @@ TEST_F(DefinitionBlockSeparatorTest, Basic) {
                BreakAfterReturnTypeStyle);
 }
 
+TEST_F(DefinitionBlockSeparatorTest, ScopedEnums) {
+  FormatStyle Style = getLLVMStyle();
+  for (StringRef Enum :
+       {"enum class", "enum struct", "enum /* comment */ class",
+        "enum /* comment */ struct"}) {
+    for (bool WrapBrace : {false, true}) {
+      Style.BreakBeforeBraces = FormatStyle::BS_Custom;
+      Style.BraceWrapping.AfterEnum = WrapBrace;
+      Style.AllowShortEnumsOnASingleLine = false;
+      std::string Code = "struct A {};\n"
+                         "\n" +
+                         Enum.str() + " E : char" + (WrapBrace ? "\n" : " ") +
+                         "{\n"
+                         "  k\n"
+                         "};\n"
+                         "\n" +
+                         Enum.str() + " F" + (WrapBrace ? "\n" : " ") +
+                         "{\n"
+                         "  l\n"
+                         "};\n"
+                         "\n"
+                         "struct B {};";
+      Style.SeparateDefinitionBlocks = FormatStyle::SDS_Always;
+      verifyFormat(Code, Style);
+      Style.SeparateDefinitionBlocks = FormatStyle::SDS_Never;
+      verifyFormat(Code, Style, removeEmptyLines(Code));
+    }
+
+    Style.BreakBeforeBraces = FormatStyle::BS_Attach;
+    Style.AllowShortEnumsOnASingleLine = true;
+    std::string Code = "int i;\n"
+                       "\n" +
+                       Enum.str() +
+                       " E { k };\n"
+                       "\n"
+                       "int j;";
+    Style.SeparateDefinitionBlocks = FormatStyle::SDS_Always;
+    verifyFormat(Code, Style);
+    Style.SeparateDefinitionBlocks = FormatStyle::SDS_Never;
+    verifyFormat(Code, Style, removeEmptyLines(Code));
+  }
+}
+
 TEST_F(DefinitionBlockSeparatorTest, FormatConflict) {
   FormatStyle Style = getLLVMStyle();
   Style.SeparateDefinitionBlocks = FormatStyle::SDS_Always;

``````````

</details>


https://github.com/llvm/llvm-project/pull/239167


More information about the cfe-commits mailing list