[clang] [clang-format] Add RemoveEmptyLinesInUnwrappedLines option (PR #112325)
Owen Pan via cfe-commits
cfe-commits at lists.llvm.org
Tue Oct 15 00:54:09 PDT 2024
https://github.com/owenca updated https://github.com/llvm/llvm-project/pull/112325
>From ca1b950315b5fd098ead7bcbe582935bf2c2b3bd Mon Sep 17 00:00:00 2001
From: Owen Pan <owenpiano at gmail.com>
Date: Tue, 15 Oct 2024 00:21:11 -0700
Subject: [PATCH 1/3] [clang-format] Add RemoveEmptyLinesInUnwrappedLines
option
Fixes #111340.
---
clang/docs/ClangFormatStyleOptions.rst | 25 +++++++
clang/docs/ReleaseNotes.rst | 6 +-
clang/include/clang/Format/Format.h | 25 +++++++
clang/lib/Format/Format.cpp | 3 +
clang/lib/Format/TokenAnnotator.cpp | 4 +-
clang/unittests/Format/ConfigParseTest.cpp | 1 +
clang/unittests/Format/FormatTest.cpp | 77 ++++++++++++++++++++++
7 files changed, 138 insertions(+), 3 deletions(-)
diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst
index 8add0a53e5be13..7885bb91f22302 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -5505,6 +5505,31 @@ the configuration (without a prefix: ``Auto``).
}
}
+.. _RemoveEmptyLinesInUnwrappedLines:
+
+**RemoveEmptyLinesInUnwrappedLines** (``Boolean``) :versionbadge:`clang-format 20` :ref:`¶ <RemoveEmptyLinesInUnwrappedLines>`
+ Remove empty lines within unwrapped lines.
+
+ .. code-block:: c++
+
+ false: true:
+
+ int c vs. int c = a + b;
+
+ = a + b;
+
+ enum : unsigned vs. enum : unsigned
+ {
+ { AA = 0,
+ AA = 0, BB
+ BB } myEnum;
+ } myEnum;
+
+ while ( vs. while (true) {
+ }
+ true) {
+ }
+
.. _RemoveParentheses:
**RemoveParentheses** (``RemoveParenthesesStyle``) :versionbadge:`clang-format 17` :ref:`¶ <RemoveParentheses>`
diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst
index b430b2b0ee3187..22df7e114083a8 100644
--- a/clang/docs/ReleaseNotes.rst
+++ b/clang/docs/ReleaseNotes.rst
@@ -668,8 +668,10 @@ clang-format
- Adds ``BreakBinaryOperations`` option.
- Adds ``TemplateNames`` option.
- Adds ``AlignFunctionDeclarations`` option to ``AlignConsecutiveDeclarations``.
-- Adds ``IndentOnly`` suboption to ``ReflowComments`` to fix the indentation of multi-line comments
- without touching their contents, renames ``false`` to ``Never``, and ``true`` to ``Always``.
+- Adds ``IndentOnly`` suboption to ``ReflowComments`` to fix the indentation of
+ multi-line comments without touching their contents, renames ``false`` to
+ ``Never``, and ``true`` to ``Always``.
+- Adds ``RemoveEmptyLinesInUnwrappedLines`` option.
libclang
--------
diff --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h
index a0762b088b68ef..e9c4ce7cba828a 100644
--- a/clang/include/clang/Format/Format.h
+++ b/clang/include/clang/Format/Format.h
@@ -3938,6 +3938,29 @@ struct FormatStyle {
/// \version 14
bool RemoveBracesLLVM;
+ /// Remove empty lines within unwrapped lines.
+ /// \code
+ /// false: true:
+ ///
+ /// int c vs. int c = a + b;
+ ///
+ /// = a + b;
+ ///
+ /// enum : unsigned vs. enum : unsigned
+ /// {
+ /// { AA = 0,
+ /// AA = 0, BB
+ /// BB } myEnum;
+ /// } myEnum;
+ ///
+ /// while ( vs. while (true) {
+ /// }
+ /// true) {
+ /// }
+ /// \endcode
+ /// \version 20
+ bool RemoveEmptyLinesInUnwrappedLines;
+
/// Types of redundant parentheses to remove.
enum RemoveParenthesesStyle : int8_t {
/// Do not remove parentheses.
@@ -5232,6 +5255,8 @@ struct FormatStyle {
RawStringFormats == R.RawStringFormats &&
ReferenceAlignment == R.ReferenceAlignment &&
RemoveBracesLLVM == R.RemoveBracesLLVM &&
+ RemoveEmptyLinesInUnwrappedLines ==
+ R.RemoveEmptyLinesInUnwrappedLines &&
RemoveParentheses == R.RemoveParentheses &&
RemoveSemicolon == R.RemoveSemicolon &&
RequiresClausePosition == R.RequiresClausePosition &&
diff --git a/clang/lib/Format/Format.cpp b/clang/lib/Format/Format.cpp
index 148270795c562f..c612960ff37ac8 100644
--- a/clang/lib/Format/Format.cpp
+++ b/clang/lib/Format/Format.cpp
@@ -1104,6 +1104,8 @@ template <> struct MappingTraits<FormatStyle> {
IO.mapOptional("ReferenceAlignment", Style.ReferenceAlignment);
IO.mapOptional("ReflowComments", Style.ReflowComments);
IO.mapOptional("RemoveBracesLLVM", Style.RemoveBracesLLVM);
+ IO.mapOptional("RemoveEmptyLinesInUnwrappedLines",
+ Style.RemoveEmptyLinesInUnwrappedLines);
IO.mapOptional("RemoveParentheses", Style.RemoveParentheses);
IO.mapOptional("RemoveSemicolon", Style.RemoveSemicolon);
IO.mapOptional("RequiresClausePosition", Style.RequiresClausePosition);
@@ -1582,6 +1584,7 @@ FormatStyle getLLVMStyle(FormatStyle::LanguageKind Language) {
LLVMStyle.ReferenceAlignment = FormatStyle::RAS_Pointer;
LLVMStyle.ReflowComments = FormatStyle::RCS_Always;
LLVMStyle.RemoveBracesLLVM = false;
+ LLVMStyle.RemoveEmptyLinesInUnwrappedLines = false;
LLVMStyle.RemoveParentheses = FormatStyle::RPS_Leave;
LLVMStyle.RemoveSemicolon = false;
LLVMStyle.RequiresClausePosition = FormatStyle::RCPS_OwnLine;
diff --git a/clang/lib/Format/TokenAnnotator.cpp b/clang/lib/Format/TokenAnnotator.cpp
index fcefaa7bb298ea..13037b6d00604b 100644
--- a/clang/lib/Format/TokenAnnotator.cpp
+++ b/clang/lib/Format/TokenAnnotator.cpp
@@ -5509,8 +5509,10 @@ static bool isAllmanLambdaBrace(const FormatToken &Tok) {
bool TokenAnnotator::mustBreakBefore(const AnnotatedLine &Line,
const FormatToken &Right) const {
const FormatToken &Left = *Right.Previous;
- if (Right.NewlinesBefore > 1 && Style.MaxEmptyLinesToKeep > 0)
+ if (Right.NewlinesBefore > 1 && Style.MaxEmptyLinesToKeep > 0 &&
+ (!Style.RemoveEmptyLinesInUnwrappedLines || &Right == Line.First)) {
return true;
+ }
if (Style.BreakFunctionDefinitionParameters && Line.MightBeFunctionDecl &&
Line.mightBeFunctionDefinition() && Left.MightBeFunctionDeclParen &&
diff --git a/clang/unittests/Format/ConfigParseTest.cpp b/clang/unittests/Format/ConfigParseTest.cpp
index 318f08c04759b9..9e8529050ed83d 100644
--- a/clang/unittests/Format/ConfigParseTest.cpp
+++ b/clang/unittests/Format/ConfigParseTest.cpp
@@ -184,6 +184,7 @@ TEST(ConfigParseTest, ParsesConfigurationBools) {
CHECK_PARSE_BOOL(ObjCSpaceBeforeProtocolList);
CHECK_PARSE_BOOL(Cpp11BracedListStyle);
CHECK_PARSE_BOOL(RemoveBracesLLVM);
+ CHECK_PARSE_BOOL(RemoveEmptyLinesInUnwrappedLines);
CHECK_PARSE_BOOL(RemoveSemicolon);
CHECK_PARSE_BOOL(SkipMacroDefinitionBody);
CHECK_PARSE_BOOL(SpacesInSquareBrackets);
diff --git a/clang/unittests/Format/FormatTest.cpp b/clang/unittests/Format/FormatTest.cpp
index 43513f18321bc0..01d8f031cf40d3 100644
--- a/clang/unittests/Format/FormatTest.cpp
+++ b/clang/unittests/Format/FormatTest.cpp
@@ -28135,6 +28135,83 @@ TEST_F(FormatTest, BreakBinaryOperations) {
Style);
}
+TEST_F(FormatTest, RemovesEmptyLinesInUnwrappedLines) {
+ auto Style = getLLVMStyle();
+ Style.RemoveEmptyLinesInUnwrappedLines = true;
+
+ verifyFormat("int c = a + b;",
+ "int c\n"
+ "\n"
+ " = a + b;",
+ Style);
+
+ verifyFormat("enum : unsigned { AA = 0, BB } myEnum;",
+ "enum : unsigned\n"
+ "\n"
+ "{\n"
+ " AA = 0,\n"
+ " BB\n"
+ "} myEnum;",
+ Style);
+
+ verifyFormat("class B : public E {\n"
+ "private:\n"
+ "};",
+ "class B : public E\n"
+ "\n"
+ "{\n"
+ "private:\n"
+ "};",
+ Style);
+
+ verifyFormat(
+ "struct AAAAAAAAAAAAAAA test[3] = {{56, 23, \"hello\"}, {7, 5, \"!!\"}};",
+ "struct AAAAAAAAAAAAAAA test[3] = {{56,\n"
+ "\n"
+ " 23, \"hello\"},\n"
+ " {7, 5, \"!!\"}};",
+ Style);
+
+ verifyFormat("int myFunction(int aaaaaaaaaaaaa, int ccccccccccccc, int d);",
+ "int myFunction(\n"
+ "\n"
+ " int aaaaaaaaaaaaa,\n"
+ "\n"
+ " int ccccccccccccc, int d);",
+ Style);
+
+ verifyFormat("switch (e) {\n"
+ "case 1:\n"
+ " return e;\n"
+ "case 2:\n"
+ " return 2;\n"
+ "}",
+ "switch (\n"
+ "\n"
+ " e) {\n"
+ "case 1:\n"
+ " return e;\n"
+ "case 2:\n"
+ " return 2;\n"
+ "}",
+ Style);
+
+ verifyFormat("while (true) {\n"
+ "}",
+ "while (\n"
+ "\n"
+ " true) {\n"
+ "}",
+ Style);
+
+ verifyFormat("void loooonFunctionIsVeryLongButNotAsLongAsJavaTypeNames(\n"
+ " std::map<int, std::string> *outputMap);\n",
+ "void loooonFunctionIsVeryLongButNotAsLongAsJavaTypeNames\n"
+ "\n"
+ " (std::map<int, std::string> *outputMap);\n",
+ Style);
+}
+
} // namespace
} // namespace test
} // namespace format
>From 925da66b8785e9000f792c26c4b237cecfec8cc2 Mon Sep 17 00:00:00 2001
From: Owen Pan <owenpiano at gmail.com>
Date: Tue, 15 Oct 2024 00:32:23 -0700
Subject: [PATCH 2/3] Fix the `enum` example in doc
---
clang/docs/ClangFormatStyleOptions.rst | 10 +++++-----
clang/include/clang/Format/Format.h | 10 +++++-----
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst
index 7885bb91f22302..f36a5472b7e17d 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -5518,11 +5518,11 @@ the configuration (without a prefix: ``Auto``).
= a + b;
- enum : unsigned vs. enum : unsigned
- {
- { AA = 0,
- AA = 0, BB
- BB } myEnum;
+ enum : unsigned vs. enum : unsigned {
+ AA = 0,
+ { BB
+ AA = 0, } myEnum;
+ BB
} myEnum;
while ( vs. while (true) {
diff --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h
index e9c4ce7cba828a..debba1c7822839 100644
--- a/clang/include/clang/Format/Format.h
+++ b/clang/include/clang/Format/Format.h
@@ -3946,11 +3946,11 @@ struct FormatStyle {
///
/// = a + b;
///
- /// enum : unsigned vs. enum : unsigned
- /// {
- /// { AA = 0,
- /// AA = 0, BB
- /// BB } myEnum;
+ /// enum : unsigned vs. enum : unsigned {
+ /// AA = 0,
+ /// { BB
+ /// AA = 0, } myEnum;
+ /// BB
/// } myEnum;
///
/// while ( vs. while (true) {
>From c43819ae7fe4434757e50120dd285c948dfe9081 Mon Sep 17 00:00:00 2001
From: Owen Pan <owenpiano at gmail.com>
Date: Tue, 15 Oct 2024 00:52:59 -0700
Subject: [PATCH 3/3] Remove trailing newlines in tests
---
clang/unittests/Format/FormatTest.cpp | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/clang/unittests/Format/FormatTest.cpp b/clang/unittests/Format/FormatTest.cpp
index 01d8f031cf40d3..8f4c92148adae4 100644
--- a/clang/unittests/Format/FormatTest.cpp
+++ b/clang/unittests/Format/FormatTest.cpp
@@ -28205,10 +28205,10 @@ TEST_F(FormatTest, RemovesEmptyLinesInUnwrappedLines) {
Style);
verifyFormat("void loooonFunctionIsVeryLongButNotAsLongAsJavaTypeNames(\n"
- " std::map<int, std::string> *outputMap);\n",
+ " std::map<int, std::string> *outputMap);",
"void loooonFunctionIsVeryLongButNotAsLongAsJavaTypeNames\n"
"\n"
- " (std::map<int, std::string> *outputMap);\n",
+ " (std::map<int, std::string> *outputMap);",
Style);
}
More information about the cfe-commits
mailing list