[clang] [clang-format] Disable OuterScope lambda indentation behaviour for constructor initializers (PR #66755)
Jon Phillips via cfe-commits
cfe-commits at lists.llvm.org
Tue Sep 26 10:46:28 PDT 2023
https://github.com/jp4a50 updated https://github.com/llvm/llvm-project/pull/66755
>From e07d263a37ef37a21bb5cf424b14be83088eed3d Mon Sep 17 00:00:00 2001
From: Jon Phillips <jphillips at cloudflare.com>
Date: Tue, 19 Sep 2023 10:29:57 +0100
Subject: [PATCH 1/3] [clang-format] Disable OuterScope lambda indentation
behaviour for constructor initializers
By default, OuterScope aligns lambdas to the beginning of the current
line. This makes sense for most types of statements within code blocks
but leads to unappealing and misleading indentation for lambdas within
constructor initializers.
---
clang/lib/Format/ContinuationIndenter.cpp | 3 ++-
clang/unittests/Format/FormatTest.cpp | 30 +++++++++++++++++------
2 files changed, 25 insertions(+), 8 deletions(-)
diff --git a/clang/lib/Format/ContinuationIndenter.cpp b/clang/lib/Format/ContinuationIndenter.cpp
index deb3e554fdc124b..0fa70eace90f416 100644
--- a/clang/lib/Format/ContinuationIndenter.cpp
+++ b/clang/lib/Format/ContinuationIndenter.cpp
@@ -1955,7 +1955,8 @@ void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) {
void ContinuationIndenter::moveStateToNewBlock(LineState &State) {
if (Style.LambdaBodyIndentation == FormatStyle::LBI_OuterScope &&
- State.NextToken->is(TT_LambdaLBrace)) {
+ State.NextToken->is(TT_LambdaLBrace) && State.Line &&
+ !State.Line->MightBeFunctionDecl) {
State.Stack.back().NestedBlockIndent = State.FirstIndent;
}
unsigned NestedBlockIndent = State.Stack.back().NestedBlockIndent;
diff --git a/clang/unittests/Format/FormatTest.cpp b/clang/unittests/Format/FormatTest.cpp
index 0d0fbdb84e3271b..cb6b22b32e63350 100644
--- a/clang/unittests/Format/FormatTest.cpp
+++ b/clang/unittests/Format/FormatTest.cpp
@@ -22537,10 +22537,12 @@ TEST_F(FormatTest, FormatsLambdas) {
" }\n"
"}",
Style);
- verifyFormat("std::sort(v.begin(), v.end(),\n"
- " [](const auto &foo, const auto &bar) {\n"
- " return foo.baz < bar.baz;\n"
- "});",
+ verifyFormat("void test() {\n"
+ " std::sort(v.begin(), v.end(),\n"
+ " [](const auto &foo, const auto &bar) {\n"
+ " return foo.baz < bar.baz;\n"
+ " });\n"
+ "};",
Style);
verifyFormat("void test() {\n"
" (\n"
@@ -22589,9 +22591,23 @@ TEST_F(FormatTest, FormatsLambdas) {
verifyFormat("Namespace::Foo::Foo(LongClassName bar,\n"
" AnotherLongClassName baz)\n"
" : baz{baz}, func{[&] {\n"
- " auto qux = bar;\n"
- " return aFunkyFunctionCall(qux);\n"
- "}} {}",
+ " auto qux = bar;\n"
+ " return aFunkyFunctionCall(qux);\n"
+ " }} {}",
+ Style);
+ verifyFormat("void foo() {\n"
+ " class Foo {\n"
+ " public:\n"
+ " Foo()\n"
+ " : qux{[](int quux) {\n"
+ " auto tmp = quux;\n"
+ " return tmp;\n"
+ " }} {}\n"
+ "\n"
+ " private:\n"
+ " std::function<void(int quux)> qux;\n"
+ " };\n"
+ "}\n",
Style);
Style.AlignAfterOpenBracket = FormatStyle::BAS_AlwaysBreak;
// FIXME: The following test should pass, but fails at the time of writing.
>From 7d7d8e51448f9bcb329c12d738f58e016c0f81ee Mon Sep 17 00:00:00 2001
From: Jon Phillips <jphillips at cloudflare.com>
Date: Fri, 22 Sep 2023 16:18:45 +0100
Subject: [PATCH 2/3] [clang-format] Add more tests for constructor initializer
formatting when using OuterScope lambda body indentation.
---
clang/lib/Format/ContinuationIndenter.cpp | 2 +-
clang/unittests/Format/FormatTest.cpp | 25 ++++++++++++++++++++++-
2 files changed, 25 insertions(+), 2 deletions(-)
diff --git a/clang/lib/Format/ContinuationIndenter.cpp b/clang/lib/Format/ContinuationIndenter.cpp
index 0fa70eace90f416..70abef1169751ce 100644
--- a/clang/lib/Format/ContinuationIndenter.cpp
+++ b/clang/lib/Format/ContinuationIndenter.cpp
@@ -1955,7 +1955,7 @@ void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) {
void ContinuationIndenter::moveStateToNewBlock(LineState &State) {
if (Style.LambdaBodyIndentation == FormatStyle::LBI_OuterScope &&
- State.NextToken->is(TT_LambdaLBrace) && State.Line &&
+ State.NextToken->is(TT_LambdaLBrace) &&
!State.Line->MightBeFunctionDecl) {
State.Stack.back().NestedBlockIndent = State.FirstIndent;
}
diff --git a/clang/unittests/Format/FormatTest.cpp b/clang/unittests/Format/FormatTest.cpp
index cb6b22b32e63350..6c67c4253254da1 100644
--- a/clang/unittests/Format/FormatTest.cpp
+++ b/clang/unittests/Format/FormatTest.cpp
@@ -22568,6 +22568,12 @@ TEST_F(FormatTest, FormatsLambdas) {
" xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx); \\\n"
" }",
Style);
+ verifyFormat("#define SORT(v) \\\n"
+ " std::sort(v.begin(), v.end(), \\\n"
+ " [](const auto &foo, const auto &bar) { \\\n"
+ " return foo.baz < bar.baz; \\\n"
+ " });",
+ Style);
verifyFormat("void foo() {\n"
" aFunction(1, b(c(foo, bar, baz, [](d) {\n"
" auto f = e(d);\n"
@@ -22607,7 +22613,24 @@ TEST_F(FormatTest, FormatsLambdas) {
" private:\n"
" std::function<void(int quux)> qux;\n"
" };\n"
- "}\n",
+ "}",
+ Style);
+ Style.BreakConstructorInitializers = FormatStyle::BCIS_AfterColon;
+ verifyFormat("Namespace::Foo::Foo(LongClassName bar,\n"
+ " AnotherLongClassName baz) :\n"
+ " baz{baz}, func{[&] {\n"
+ " auto qux = bar;\n"
+ " return aFunkyFunctionCall(qux);\n"
+ " }} {}",
+ Style);
+ Style.PackConstructorInitializers = FormatStyle::PCIS_Never;
+ verifyFormat("Namespace::Foo::Foo(LongClassName bar,\n"
+ " AnotherLongClassName baz) :\n"
+ " baz{baz},\n"
+ " func{[&] {\n"
+ " auto qux = bar;\n"
+ " return aFunkyFunctionCall(qux);\n"
+ " }} {}",
Style);
Style.AlignAfterOpenBracket = FormatStyle::BAS_AlwaysBreak;
// FIXME: The following test should pass, but fails at the time of writing.
>From 7c3e251fc1b06112f601bb8fc932f6b7dc563336 Mon Sep 17 00:00:00 2001
From: Jon Phillips <jphillips at cloudflare.com>
Date: Tue, 26 Sep 2023 18:45:17 +0100
Subject: [PATCH 3/3] [clang-format] Update documentation for OuterScope lambda
body indentation.
---
clang/docs/ClangFormatStyleOptions.rst | 4 ++--
clang/include/clang/Format/Format.h | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst
index fea52679585a6cb..5ebb8c82b30495a 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -3788,8 +3788,8 @@ the configuration (without a prefix: ``Auto``).
});
* ``LBI_OuterScope`` (in configuration: ``OuterScope``)
- Align lambda body relative to the indentation level of the outer scope
- the lambda signature resides in.
+ For statements within block scope, align lambda body relative to the
+ indentation level of the outer scope the lambda signature resides in.
.. code-block:: c++
diff --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h
index e78aa62f93cffe1..2707ea608c74efd 100644
--- a/clang/include/clang/Format/Format.h
+++ b/clang/include/clang/Format/Format.h
@@ -2879,8 +2879,8 @@ struct FormatStyle {
/// });
/// \endcode
LBI_Signature,
- /// Align lambda body relative to the indentation level of the outer scope
- /// the lambda signature resides in.
+ /// For statements within block scope, align lambda body relative to the
+ /// indentation level of the outer scope the lambda signature resides in.
/// \code
/// someMethod(
/// [](SomeReallyLongLambdaSignatureArgument foo) {
More information about the cfe-commits
mailing list