llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT--> @llvm/pr-subscribers-clang-format @llvm/pr-subscribers-clang Author: Gedare Bloom (gedare) <details> <summary>Changes</summary> The use of Cpp11BracedListStyle with BinPackParameters=False avoids bin packing until reaching a hard-coded limit of 20 items. This is an arbitrary choice. Introduce a new style option to allow setting a configurable limit of items. --- Full diff: https://github.com/llvm/llvm-project/pull/112482.diff 6 Files Affected: - (modified) clang/docs/ClangFormatStyleOptions.rst (+20) - (modified) clang/docs/ReleaseNotes.rst (+2) - (modified) clang/include/clang/Format/Format.h (+19) - (modified) clang/lib/Format/Format.cpp (+3) - (modified) clang/lib/Format/FormatToken.cpp (+1-1) - (modified) clang/unittests/Format/FormatTest.cpp (+26) ``````````diff diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst index 8add0a53e5be13..d0440df388aeb0 100644 --- a/clang/docs/ClangFormatStyleOptions.rst +++ b/clang/docs/ClangFormatStyleOptions.rst @@ -3769,6 +3769,9 @@ the configuration (without a prefix: ``Auto``). the parentheses of a function call with that name. If there is no name, a zero-length name is assumed. + ``BinPackArguments`` may be ignored for initializer lists with more than + ``MaxSingleLinesInBracedList`` items. + .. code-block:: c++ true: false: @@ -4883,6 +4886,23 @@ the configuration (without a prefix: ``Auto``). return i; } +.. _MaxSingleLinesInBracedList: + +**MaxSingleLinesInBracedList** (``Unsigned``) :versionbadge:`clang-format 20` :ref:`¶ <MaxSingleLinesInBracedList>` + The maximum number of single item lines to keep in a braced list when + ``BinPackArguments`` is ``false`` before formatting items in columns. + Defaults to 20. + + .. code-block:: c++ + + MaxSingleLinesInBracedList: 5 vs. MaxSingleLinesInBracedList: 4 + vector<int> x{ vector<int> x{1, 2, 3, 4, 5}; + 1, + 2, + 3, + 4, + 5}; + .. _NamespaceIndentation: **NamespaceIndentation** (``NamespaceIndentationKind``) :versionbadge:`clang-format 3.7` :ref:`¶ <NamespaceIndentation>` diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst index 817e3abef8d566..9807d8c7bc6362 100644 --- a/clang/docs/ReleaseNotes.rst +++ b/clang/docs/ReleaseNotes.rst @@ -674,6 +674,8 @@ clang-format - 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 ``MaxSingleLinesInBracedList`` option to control the limit on how many + single lines to use when avoiding bin packing with braced list initializers. libclang -------- diff --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h index a0762b088b68ef..19a301dbc66403 100644 --- a/clang/include/clang/Format/Format.h +++ b/clang/include/clang/Format/Format.h @@ -2515,6 +2515,9 @@ struct FormatStyle { /// (e.g. a type or variable name), clang-format formats as if the ``{}`` were /// the parentheses of a function call with that name. If there is no name, /// a zero-length name is assumed. + /// + /// ``BinPackArguments`` may be ignored for initializer lists with more than + /// ``MaxSingleLinesInBracedList`` items. /// \code /// true: false: /// vector<int> x{1, 2, 3, 4}; vs. vector<int> x{ 1, 2, 3, 4 }; @@ -3391,6 +3394,21 @@ struct FormatStyle { /// \version 3.7 unsigned MaxEmptyLinesToKeep; + /// The maximum number of single item lines to keep in a braced list when + /// ``BinPackArguments`` is ``false`` before formatting items in columns. + /// Defaults to 20. + /// \code + /// MaxSingleLinesInBracedList: 5 vs. MaxSingleLinesInBracedList: 4 + /// vector<int> x{ vector<int> x{1, 2, 3, 4, 5}; + /// 1, + /// 2, + /// 3, + /// 4, + /// 5}; + /// \endcode + /// \version 20 + unsigned MaxSingleLinesInBracedList; + /// Different ways to indent namespace contents. enum NamespaceIndentationKind : int8_t { /// Don't indent in namespaces. @@ -5204,6 +5222,7 @@ struct FormatStyle { LineEnding == R.LineEnding && MacroBlockBegin == R.MacroBlockBegin && MacroBlockEnd == R.MacroBlockEnd && Macros == R.Macros && MaxEmptyLinesToKeep == R.MaxEmptyLinesToKeep && + MaxSingleLinesInBracedList == R.MaxSingleLinesInBracedList && NamespaceIndentation == R.NamespaceIndentation && NamespaceMacros == R.NamespaceMacros && ObjCBinPackProtocolList == R.ObjCBinPackProtocolList && diff --git a/clang/lib/Format/Format.cpp b/clang/lib/Format/Format.cpp index 148270795c562f..d5d74591fb593a 100644 --- a/clang/lib/Format/Format.cpp +++ b/clang/lib/Format/Format.cpp @@ -1059,6 +1059,8 @@ template <> struct MappingTraits<FormatStyle> { IO.mapOptional("Macros", Style.Macros); IO.mapOptional("MainIncludeChar", Style.IncludeStyle.MainIncludeChar); IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep); + IO.mapOptional("MaxSingleLinesInBracedList", + Style.MaxSingleLinesInBracedList); IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation); IO.mapOptional("NamespaceMacros", Style.NamespaceMacros); IO.mapOptional("ObjCBinPackProtocolList", Style.ObjCBinPackProtocolList); @@ -1569,6 +1571,7 @@ FormatStyle getLLVMStyle(FormatStyle::LanguageKind Language) { LLVMStyle.Language = Language; LLVMStyle.LineEnding = FormatStyle::LE_DeriveLF; LLVMStyle.MaxEmptyLinesToKeep = 1; + LLVMStyle.MaxSingleLinesInBracedList = 20; LLVMStyle.NamespaceIndentation = FormatStyle::NI_None; LLVMStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Auto; LLVMStyle.ObjCBlockIndentWidth = 2; diff --git a/clang/lib/Format/FormatToken.cpp b/clang/lib/Format/FormatToken.cpp index 963e8f87793fa0..31327feb4d286f 100644 --- a/clang/lib/Format/FormatToken.cpp +++ b/clang/lib/Format/FormatToken.cpp @@ -174,7 +174,7 @@ void CommaSeparatedList::precomputeFormattingInfos(const FormatToken *Token) { // have many items (20 or more) or we allow bin-packing of function call // arguments. if (Style.Cpp11BracedListStyle && !Style.BinPackArguments && - Commas.size() < 19) { + Commas.size() <= Style.MaxSingleLinesInBracedList) { return; } diff --git a/clang/unittests/Format/FormatTest.cpp b/clang/unittests/Format/FormatTest.cpp index 43513f18321bc0..a97aea878f5578 100644 --- a/clang/unittests/Format/FormatTest.cpp +++ b/clang/unittests/Format/FormatTest.cpp @@ -14038,6 +14038,32 @@ TEST_F(FormatTest, LayoutCxx11BraceInitializers) { " ffffff, ggggg, hhhhhh, iiiiii, jjjjjj, kkkkkk,\n" "};", NoBinPacking); + NoBinPacking.MaxSingleLinesInBracedList = 22; + verifyFormat("const Aaaaaa aaaaa = {\n" + " aaaaa,\n" + " bbbbb,\n" + " ccccc,\n" + " ddddd,\n" + " eeeee,\n" + " ffffff,\n" + " ggggg,\n" + " hhhhhh,\n" + " iiiiii,\n" + " jjjjjj,\n" + " kkkkkk,\n" + " aaaaa,\n" + " bbbbb,\n" + " ccccc,\n" + " ddddd,\n" + " eeeee,\n" + " ffffff,\n" + " ggggg,\n" + " hhhhhh,\n" + " iiiiii,\n" + " jjjjjj,\n" + " kkkkkk,\n" + "};", + NoBinPacking); NoBinPacking.AlignAfterOpenBracket = FormatStyle::BAS_AlwaysBreak; verifyFormat("static uint8 CddDp83848Reg[] = {\n" `````````` </details> https://github.com/llvm/llvm-project/pull/112482 _______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
