vlovich updated this revision to Diff 347152.
vlovich added a comment.
Regen documentation & clang-format test cases.
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D102706/new/
https://reviews.llvm.org/D102706
Files:
clang/docs/ClangFormatStyleOptions.rst
clang/docs/ReleaseNotes.rst
clang/include/clang/Format/Format.h
clang/lib/Format/Format.cpp
clang/lib/Format/UnwrappedLineFormatter.cpp
clang/unittests/Format/FormatTest.cpp
Index: clang/unittests/Format/FormatTest.cpp
===================================================================
--- clang/unittests/Format/FormatTest.cpp
+++ clang/unittests/Format/FormatTest.cpp
@@ -17871,6 +17871,7 @@
" aaaaaaaaaaaaaaaaaaaaaaa;\n"
" });",
getLLVMStyleWithColumns(60));
+
verifyFormat("SomeFunction({[&] {\n"
" // comment\n"
" },\n"
@@ -18423,6 +18424,117 @@
" });\n"
" });",
LLVMWithBeforeLambdaBody);
+
+ // Lambdas with different indentation styles.
+ Style = getLLVMStyleWithColumns(100);
+ EXPECT_EQ("SomeResult doSomething(SomeObject promise) {\n"
+ " return promise.then(\n"
+ " [this, &someVariable, someObject = "
+ "std::mv(s)](std::vector<int> evaluated) mutable {\n"
+ " return someObject.startAsyncAction().then(\n"
+ " [this, &someVariable](AsyncActionResult result) "
+ "mutable { result.processMore(); });\n"
+ " });\n"
+ "}\n",
+ format("SomeResult doSomething(SomeObject promise) {\n"
+ " return promise.then([this, &someVariable, someObject = "
+ "std::mv(s)](std::vector<int> evaluated) mutable {\n"
+ " return someObject.startAsyncAction().then([this, "
+ "&someVariable](AsyncActionResult result) mutable {\n"
+ " result.processMore();\n"
+ " });\n"
+ " });\n"
+ "}\n",
+ Style));
+ Style.LambdaBodyIndentation = FormatStyle::LBI_OuterScope;
+ verifyFormat("test() {\n"
+ " ([]() -> {\n"
+ " int b = 32;\n"
+ " return 3;\n"
+ " }).foo();\n"
+ "}",
+ Style);
+ verifyFormat("test() {\n"
+ " []() -> {\n"
+ " int b = 32;\n"
+ " return 3;\n"
+ " }\n"
+ "}",
+ Style);
+ verifyFormat("std::sort(v.begin(), v.end(),\n"
+ " [](const auto &someLongArgumentName, const auto "
+ "&someOtherLongArgumentName) {\n"
+ " return someLongArgumentName.someMemberVariable < "
+ "someOtherLongArgumentName.someMemberVariable;\n"
+ "});",
+ Style);
+ verifyFormat("test() {\n"
+ " (\n"
+ " []() -> {\n"
+ " int b = 32;\n"
+ " return 3;\n"
+ " },\n"
+ " foo, bar)\n"
+ " .foo();\n"
+ "}",
+ Style);
+ verifyFormat("test() {\n"
+ " ([]() -> {\n"
+ " int b = 32;\n"
+ " return 3;\n"
+ " })\n"
+ " .foo()\n"
+ " .bar();\n"
+ "}",
+ Style);
+ EXPECT_EQ("SomeResult doSomething(SomeObject promise) {\n"
+ " return promise.then(\n"
+ " [this, &someVariable, someObject = "
+ "std::mv(s)](std::vector<int> evaluated) mutable {\n"
+ " return someObject.startAsyncAction().then(\n"
+ " [this, &someVariable](AsyncActionResult result) mutable { "
+ "result.processMore(); });\n"
+ " });\n"
+ "}\n",
+ format("SomeResult doSomething(SomeObject promise) {\n"
+ " return promise.then([this, &someVariable, someObject = "
+ "std::mv(s)](std::vector<int> evaluated) mutable {\n"
+ " return someObject.startAsyncAction().then([this, "
+ "&someVariable](AsyncActionResult result) mutable {\n"
+ " result.processMore();\n"
+ " });\n"
+ " });\n"
+ "}\n",
+ Style));
+ EXPECT_EQ("SomeResult doSomething(SomeObject promise) {\n"
+ " return promise.then([this, &someVariable] {\n"
+ " return someObject.startAsyncAction().then(\n"
+ " [this, &someVariable](AsyncActionResult result) mutable { "
+ "result.processMore(); });\n"
+ " });\n"
+ "}\n",
+ format("SomeResult doSomething(SomeObject promise) {\n"
+ " return promise.then([this, &someVariable] {\n"
+ " return someObject.startAsyncAction().then([this, "
+ "&someVariable](AsyncActionResult result) mutable {\n"
+ " result.processMore();\n"
+ " });\n"
+ " });\n"
+ "}\n",
+ Style));
+ Style = getGoogleStyle();
+ Style.LambdaBodyIndentation = FormatStyle::LBI_OuterScope;
+ EXPECT_EQ("#define A \\\n"
+ " [] { \\\n"
+ " xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx( \\\n"
+ " xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx); \\\n"
+ " }",
+ format("#define A [] { xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx( \\\n"
+ "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx); }",
+ Style));
+ // TODO: The current formatting has a minor issue that's not worth fixing
+ // right now whereby the closing brace is indented relative to the signature
+ // instead of being aligned. This only happens with macros.
}
TEST_F(FormatTest, LambdaWithLineComments) {
Index: clang/lib/Format/UnwrappedLineFormatter.cpp
===================================================================
--- clang/lib/Format/UnwrappedLineFormatter.cpp
+++ clang/lib/Format/UnwrappedLineFormatter.cpp
@@ -821,8 +821,20 @@
return true;
if (NewLine) {
- int AdditionalIndent = State.Stack.back().Indent -
- Previous.Children[0]->Level * Style.IndentWidth;
+ const ParenState &P = State.Stack.back();
+
+ int AdditionalIndent =
+ P.Indent - Previous.Children[0]->Level * Style.IndentWidth;
+
+ if (Style.LambdaBodyIndentation == FormatStyle::LBI_OuterScope &&
+ P.NestedBlockIndent == P.LastSpace) {
+ if (State.NextToken->MatchingParen &&
+ State.NextToken->MatchingParen->is(TT_LambdaLBrace)) {
+ State.Stack.pop_back();
+ }
+ if (LBrace->is(TT_LambdaLBrace))
+ AdditionalIndent = 0;
+ }
Penalty +=
BlockFormatter->format(Previous.Children, DryRun, AdditionalIndent,
Index: clang/lib/Format/Format.cpp
===================================================================
--- clang/lib/Format/Format.cpp
+++ clang/lib/Format/Format.cpp
@@ -85,6 +85,15 @@
}
};
+template <>
+struct ScalarEnumerationTraits<FormatStyle::LambdaBodyIndentationKind> {
+ static void enumeration(IO &IO,
+ FormatStyle::LambdaBodyIndentationKind &Value) {
+ IO.enumCase(Value, "Signature", FormatStyle::LBI_Signature);
+ IO.enumCase(Value, "OuterScope", FormatStyle::LBI_OuterScope);
+ }
+};
+
template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
IO.enumCase(Value, "Never", FormatStyle::UT_Never);
@@ -639,6 +648,7 @@
IO.mapOptional("JavaScriptWrapImports", Style.JavaScriptWrapImports);
IO.mapOptional("KeepEmptyLinesAtTheStartOfBlocks",
Style.KeepEmptyLinesAtTheStartOfBlocks);
+ IO.mapOptional("LambdaBodyIndentation", Style.LambdaBodyIndentation);
IO.mapOptional("MacroBlockBegin", Style.MacroBlockBegin);
IO.mapOptional("MacroBlockEnd", Style.MacroBlockEnd);
IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
@@ -1025,6 +1035,7 @@
LLVMStyle.JavaScriptQuotes = FormatStyle::JSQS_Leave;
LLVMStyle.JavaScriptWrapImports = true;
LLVMStyle.TabWidth = 8;
+ LLVMStyle.LambdaBodyIndentation = FormatStyle::LBI_Signature;
LLVMStyle.MaxEmptyLinesToKeep = 1;
LLVMStyle.KeepEmptyLinesAtTheStartOfBlocks = true;
LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
Index: clang/include/clang/Format/Format.h
===================================================================
--- clang/include/clang/Format/Format.h
+++ clang/include/clang/Format/Format.h
@@ -2452,6 +2452,38 @@
/// Language, this format style is targeted at.
LanguageKind Language;
+ /// Indentation logic for lambda bodies.
+ enum LambdaBodyIndentationKind : unsigned char {
+ /// Align lambda body relative to the lambda signature. This is the default.
+ /// \code
+ /// someMethod(
+ /// [](SomeReallyLongLambdaSignatureArgument foo) {
+ /// return;
+ /// });
+ /// \endcode
+ LBI_Signature,
+ /// Align lambda body relative to the indentation level of the outer scope
+ /// the lambda signature resides in.
+ /// \code
+ /// someMethod(
+ /// [](SomeReallyLongLambdaSignatureArgument foo) {
+ /// return;
+ /// });
+ /// \endcode
+ LBI_OuterScope,
+ };
+
+ /// The indentation style of lambda bodies. ``Signature`` (the default)
+ /// causes the lambda body to be indented one additional level relative to
+ /// the indentation level of the signature. ``OuterScope`` forces the lambda
+ /// body to be indented one additional level relative to the parent scope
+ /// containing the lambda signature. For callback-heavy code, it may improve
+ /// readability to have the signature indented two levels and to use
+ /// ``OuterScope``. The KJ style guide requires ``OuterScope`.
+ /// `KJ style guide
+ /// <https://github.com/capnproto/capnproto/blob/master/kjdoc/style-guide.md>`_
+ LambdaBodyIndentationKind LambdaBodyIndentation;
+
/// A regular expression matching macros that start a block.
/// \code
/// # With:
@@ -3324,6 +3356,7 @@
JavaScriptWrapImports == R.JavaScriptWrapImports &&
KeepEmptyLinesAtTheStartOfBlocks ==
R.KeepEmptyLinesAtTheStartOfBlocks &&
+ LambdaBodyIndentation == R.LambdaBodyIndentation &&
MacroBlockBegin == R.MacroBlockBegin &&
MacroBlockEnd == R.MacroBlockEnd &&
MaxEmptyLinesToKeep == R.MaxEmptyLinesToKeep &&
Index: clang/docs/ReleaseNotes.rst
===================================================================
--- clang/docs/ReleaseNotes.rst
+++ clang/docs/ReleaseNotes.rst
@@ -248,6 +248,12 @@
accepts ``AllIfsAndElse`` value that allows to put "else if" and "else" short
statements on a single line. (Fixes https://llvm.org/PR50019.)
+- Option ``LambdaBodyIndentation`` has been added to control how the body of a
+ lambda is indented. The default ``Signature`` value indents the body one level
+ relative to whatever indentation the signature has. ``OuterScope`` lets you
+ change that so that the lambda body is indented one level relative to the scope
+ containing the lambda, regardless of where the lambda signature was placed.
+
- ``git-clang-format`` no longer formats changes to symbolic links. (Fixes
https://llvm.org/PR46992.)
Index: clang/docs/ClangFormatStyleOptions.rst
===================================================================
--- clang/docs/ClangFormatStyleOptions.rst
+++ clang/docs/ClangFormatStyleOptions.rst
@@ -2753,6 +2753,42 @@
bar(); }
}
+**LambdaBodyIndentation** (``LambdaBodyIndentationKind``)
+ The indentation style of lambda bodies. ``Signature`` (the default)
+ causes the lambda body to be indented one additional level relative to
+ the indentation level of the signature. ``OuterScope`` forces the lambda
+ body to be indented one additional level relative to the parent scope
+ containing the lambda signature. For callback-heavy code, it may improve
+ readability to have the signature indented two levels and to use
+ ``OuterScope``. The KJ style guide requires ``OuterScope`.
+ `KJ style guide
+ <https://github.com/capnproto/capnproto/blob/master/kjdoc/style-guide.md>`_
+
+ Possible values:
+
+ * ``LBI_Signature`` (in configuration: ``Signature``)
+ Align lambda body relative to the lambda signature. This is the default.
+
+ .. code-block:: c++
+
+ someMethod(
+ [](SomeReallyLongLambdaSignatureArgument foo) {
+ return;
+ });
+
+ * ``LBI_OuterScope`` (in configuration: ``OuterScope``)
+ Align lambda body relative to the indentation level of the outer scope
+ the lambda signature resides in.
+
+ .. code-block:: c++
+
+ someMethod(
+ [](SomeReallyLongLambdaSignatureArgument foo) {
+ return;
+ });
+
+
+
**Language** (``LanguageKind``)
Language, this format style is targeted at.
@@ -2787,8 +2823,6 @@
Should be used for Protocol Buffer messages in text format
(https://developers.google.com/protocol-buffers/).
-
-
**MacroBlockBegin** (``std::string``)
A regular expression matching macros that start a block.
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
