https://github.com/bradh352 updated
https://github.com/llvm/llvm-project/pull/108241
>From 00cbf31807ca8d8e1c0c86c6a691c47835522fe9 Mon Sep 17 00:00:00 2001
From: Brad House <b...@brad-house.com>
Date: Wed, 11 Sep 2024 10:27:50 -0400
Subject: [PATCH] Add AlignFunctionDeclarations attribute to
AlignConsecutiveDeclarations
Enabling AlignConsecutiveDeclarations also aligns function prototypes
or declarations. This is often unexpected as typically function
prototypes, especially in public headers, don't use any padding.
Setting AlignFunctionDeclarations to false will skip this alignment.
It is by default set to true to keep compatibility with prior
versions to not make unexpected changes.
Signed-off-by: Brad House <b...@brad-house.com>
---
clang/docs/ClangFormatStyleOptions.rst | 112 +++++++++++++++++++++
clang/include/clang/Format/Format.h | 16 +++
clang/lib/Format/Format.cpp | 31 ++++--
clang/lib/Format/WhitespaceManager.cpp | 2 +-
clang/unittests/Format/ConfigParseTest.cpp | 6 ++
clang/unittests/Format/FormatTest.cpp | 22 +++-
6 files changed, 179 insertions(+), 10 deletions(-)
diff --git a/clang/docs/ClangFormatStyleOptions.rst
b/clang/docs/ClangFormatStyleOptions.rst
index a427d7cd40fcdd..042c5f1b5f15b0 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -392,6 +392,22 @@ the configuration (without a prefix: ``Auto``).
a &= 2;
bbb = 2;
+ * ``bool AlignFunctionDeclarations`` :versionbadge:`clang-format 20`
+ Only for ``AlignConsecutiveDeclarations``. Whether function declarations
+ are aligned.
+
+ .. code-block:: c++
+
+ true:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
+ false:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``.
Whether function pointers are
aligned.
@@ -534,6 +550,22 @@ the configuration (without a prefix: ``Auto``).
a &= 2;
bbb = 2;
+ * ``bool AlignFunctionDeclarations`` :versionbadge:`clang-format 20`
+ Only for ``AlignConsecutiveDeclarations``. Whether function declarations
+ are aligned.
+
+ .. code-block:: c++
+
+ true:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
+ false:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``.
Whether function pointers are
aligned.
@@ -676,6 +708,22 @@ the configuration (without a prefix: ``Auto``).
a &= 2;
bbb = 2;
+ * ``bool AlignFunctionDeclarations`` :versionbadge:`clang-format 20`
+ Only for ``AlignConsecutiveDeclarations``. Whether function declarations
+ are aligned.
+
+ .. code-block:: c++
+
+ true:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
+ false:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``.
Whether function pointers are
aligned.
@@ -819,6 +867,22 @@ the configuration (without a prefix: ``Auto``).
a &= 2;
bbb = 2;
+ * ``bool AlignFunctionDeclarations`` :versionbadge:`clang-format 20`
+ Only for ``AlignConsecutiveDeclarations``. Whether function declarations
+ are aligned.
+
+ .. code-block:: c++
+
+ true:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
+ false:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``.
Whether function pointers are
aligned.
@@ -1081,6 +1145,22 @@ the configuration (without a prefix: ``Auto``).
a &= 2;
bbb = 2;
+ * ``bool AlignFunctionDeclarations`` :versionbadge:`clang-format 20`
+ Only for ``AlignConsecutiveDeclarations``. Whether function declarations
+ are aligned.
+
+ .. code-block:: c++
+
+ true:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
+ false:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``.
Whether function pointers are
aligned.
@@ -1221,6 +1301,22 @@ the configuration (without a prefix: ``Auto``).
a &= 2;
bbb = 2;
+ * ``bool AlignFunctionDeclarations`` :versionbadge:`clang-format 20`
+ Only for ``AlignConsecutiveDeclarations``. Whether function declarations
+ are aligned.
+
+ .. code-block:: c++
+
+ true:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
+ false:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``.
Whether function pointers are
aligned.
@@ -1361,6 +1457,22 @@ the configuration (without a prefix: ``Auto``).
a &= 2;
bbb = 2;
+ * ``bool AlignFunctionDeclarations`` :versionbadge:`clang-format 20`
+ Only for ``AlignConsecutiveDeclarations``. Whether function declarations
+ are aligned.
+
+ .. code-block:: c++
+
+ true:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
+ false:
+ unsigned int f1(void);
+ void f2(void);
+ size_t f3(void);
+
* ``bool AlignFunctionPointers`` Only for ``AlignConsecutiveDeclarations``.
Whether function pointers are
aligned.
diff --git a/clang/include/clang/Format/Format.h
b/clang/include/clang/Format/Format.h
index d8b62c7652a0f6..759a7dc7ce8165 100644
--- a/clang/include/clang/Format/Format.h
+++ b/clang/include/clang/Format/Format.h
@@ -225,6 +225,21 @@ struct FormatStyle {
/// bbb = 2;
/// \endcode
bool AlignCompound;
+ /// Only for ``AlignConsecutiveDeclarations``. Whether function
declarations
+ /// are aligned.
+ /// \code
+ /// true:
+ /// unsigned int f1(void);
+ /// void f2(void);
+ /// size_t f3(void);
+ ///
+ /// false:
+ /// unsigned int f1(void);
+ /// void f2(void);
+ /// size_t f3(void);
+ /// \endcode
+ /// \version 20
+ bool AlignFunctionDeclarations;
/// Only for ``AlignConsecutiveDeclarations``. Whether function pointers
are
/// aligned.
/// \code
@@ -264,6 +279,7 @@ struct FormatStyle {
return Enabled == R.Enabled && AcrossEmptyLines == R.AcrossEmptyLines &&
AcrossComments == R.AcrossComments &&
AlignCompound == R.AlignCompound &&
+ AlignFunctionDeclarations == R.AlignFunctionDeclarations &&
AlignFunctionPointers == R.AlignFunctionPointers &&
PadOperators == R.PadOperators;
}
diff --git a/clang/lib/Format/Format.cpp b/clang/lib/Format/Format.cpp
index d2463b892fbb96..9bd12dd6b4dc71 100644
--- a/clang/lib/Format/Format.cpp
+++ b/clang/lib/Format/Format.cpp
@@ -48,39 +48,53 @@ template <> struct
MappingTraits<FormatStyle::AlignConsecutiveStyle> {
FormatStyle::AlignConsecutiveStyle(
{/*Enabled=*/false, /*AcrossEmptyLines=*/false,
/*AcrossComments=*/false, /*AlignCompound=*/false,
- /*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
+ /*AlignFunctionDeclarations=*/true,
+ /*AlignFunctionPointers=*/false,
+ /*PadOperators=*/true}));
IO.enumCase(Value, "Consecutive",
FormatStyle::AlignConsecutiveStyle(
{/*Enabled=*/true, /*AcrossEmptyLines=*/false,
/*AcrossComments=*/false, /*AlignCompound=*/false,
- /*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
+ /*AlignFunctionDeclarations=*/true,
+ /*AlignFunctionPointers=*/false,
+ /*PadOperators=*/true}));
IO.enumCase(Value, "AcrossEmptyLines",
FormatStyle::AlignConsecutiveStyle(
{/*Enabled=*/true, /*AcrossEmptyLines=*/true,
/*AcrossComments=*/false, /*AlignCompound=*/false,
- /*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
+ /*AlignFunctionDeclarations=*/true,
+ /*AlignFunctionPointers=*/false,
+ /*PadOperators=*/true}));
IO.enumCase(Value, "AcrossComments",
FormatStyle::AlignConsecutiveStyle(
{/*Enabled=*/true, /*AcrossEmptyLines=*/false,
/*AcrossComments=*/true, /*AlignCompound=*/false,
- /*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
+ /*AlignFunctionDeclarations=*/true,
+ /*AlignFunctionPointers=*/false,
+ /*PadOperators=*/true}));
IO.enumCase(Value, "AcrossEmptyLinesAndComments",
FormatStyle::AlignConsecutiveStyle(
{/*Enabled=*/true, /*AcrossEmptyLines=*/true,
/*AcrossComments=*/true, /*AlignCompound=*/false,
- /*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
+ /*AlignFunctionDeclarations=*/true,
+ /*AlignFunctionPointers=*/false,
+ /*PadOperators=*/true}));
// For backward compatibility.
IO.enumCase(Value, "true",
FormatStyle::AlignConsecutiveStyle(
{/*Enabled=*/true, /*AcrossEmptyLines=*/false,
/*AcrossComments=*/false, /*AlignCompound=*/false,
- /*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
+ /*AlignFunctionDeclarations=*/true,
+ /*AlignFunctionPointers=*/false,
+ /*PadOperators=*/true}));
IO.enumCase(Value, "false",
FormatStyle::AlignConsecutiveStyle(
{/*Enabled=*/false, /*AcrossEmptyLines=*/false,
/*AcrossComments=*/false, /*AlignCompound=*/false,
- /*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
+ /*AlignFunctionDeclarations=*/true,
+ /*AlignFunctionPointers=*/false,
+ /*PadOperators=*/true}));
}
static void mapping(IO &IO, FormatStyle::AlignConsecutiveStyle &Value) {
@@ -88,6 +102,8 @@ template <> struct
MappingTraits<FormatStyle::AlignConsecutiveStyle> {
IO.mapOptional("AcrossEmptyLines", Value.AcrossEmptyLines);
IO.mapOptional("AcrossComments", Value.AcrossComments);
IO.mapOptional("AlignCompound", Value.AlignCompound);
+ IO.mapOptional("AlignFunctionDeclarations",
+ Value.AlignFunctionDeclarations);
IO.mapOptional("AlignFunctionPointers", Value.AlignFunctionPointers);
IO.mapOptional("PadOperators", Value.PadOperators);
}
@@ -1448,6 +1464,7 @@ FormatStyle getLLVMStyle(FormatStyle::LanguageKind
Language) {
LLVMStyle.AlignConsecutiveAssignments.PadOperators = true;
LLVMStyle.AlignConsecutiveBitFields = {};
LLVMStyle.AlignConsecutiveDeclarations = {};
+ LLVMStyle.AlignConsecutiveDeclarations.AlignFunctionDeclarations = true;
LLVMStyle.AlignConsecutiveMacros = {};
LLVMStyle.AlignConsecutiveShortCaseStatements = {};
LLVMStyle.AlignConsecutiveTableGenBreakingDAGArgColons = {};
diff --git a/clang/lib/Format/WhitespaceManager.cpp
b/clang/lib/Format/WhitespaceManager.cpp
index fd4a40a86082e2..b6b24672f6a39d 100644
--- a/clang/lib/Format/WhitespaceManager.cpp
+++ b/clang/lib/Format/WhitespaceManager.cpp
@@ -1020,7 +1020,7 @@ void WhitespaceManager::alignConsecutiveDeclarations() {
return true;
}
if (C.Tok->is(TT_FunctionDeclarationName))
- return true;
+ return Style.AlignConsecutiveDeclarations.AlignFunctionDeclarations;
if (C.Tok->isNot(TT_StartOfName))
return false;
if (C.Tok->Previous &&
diff --git a/clang/unittests/Format/ConfigParseTest.cpp
b/clang/unittests/Format/ConfigParseTest.cpp
index b8bdfaaa74e10e..938eac99114a36 100644
--- a/clang/unittests/Format/ConfigParseTest.cpp
+++ b/clang/unittests/Format/ConfigParseTest.cpp
@@ -305,24 +305,28 @@ TEST(ConfigParseTest, ParsesConfiguration) {
FormatStyle::AlignConsecutiveStyle(
\
{/*Enabled=*/false, /*AcrossEmptyLines=*/false,
\
/*AcrossComments=*/false, /*AlignCompound=*/false,
\
+ /*AlignFunctionDeclarations=*/true,
\
/*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
\
CHECK_PARSE(
\
#FIELD ": Consecutive", FIELD,
\
FormatStyle::AlignConsecutiveStyle(
\
{/*Enabled=*/true, /*AcrossEmptyLines=*/false,
\
/*AcrossComments=*/false, /*AlignCompound=*/false,
\
+ /*AlignFunctionDeclarations=*/true,
\
/*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
\
CHECK_PARSE(
\
#FIELD ": AcrossEmptyLines", FIELD,
\
FormatStyle::AlignConsecutiveStyle(
\
{/*Enabled=*/true, /*AcrossEmptyLines=*/true,
\
/*AcrossComments=*/false, /*AlignCompound=*/false,
\
+ /*AlignFunctionDeclarations=*/true,
\
/*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
\
CHECK_PARSE(
\
#FIELD ": AcrossEmptyLinesAndComments", FIELD,
\
FormatStyle::AlignConsecutiveStyle(
\
{/*Enabled=*/true, /*AcrossEmptyLines=*/true,
\
/*AcrossComments=*/true, /*AlignCompound=*/false,
\
+ /*AlignFunctionDeclarations=*/true,
\
/*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
\
/* For backwards compability, false / true should still parse */
\
CHECK_PARSE(
\
@@ -330,12 +334,14 @@ TEST(ConfigParseTest, ParsesConfiguration) {
FormatStyle::AlignConsecutiveStyle(
\
{/*Enabled=*/false, /*AcrossEmptyLines=*/false,
\
/*AcrossComments=*/false, /*AlignCompound=*/false,
\
+ /*AlignFunctionDeclarations=*/true,
\
/*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
\
CHECK_PARSE(
\
#FIELD ": true", FIELD,
\
FormatStyle::AlignConsecutiveStyle(
\
{/*Enabled=*/true, /*AcrossEmptyLines=*/false,
\
/*AcrossComments=*/false, /*AlignCompound=*/false,
\
+ /*AlignFunctionDeclarations=*/true,
\
/*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
\
\
CHECK_PARSE_NESTED_BOOL(FIELD, Enabled);
\
diff --git a/clang/unittests/Format/FormatTest.cpp
b/clang/unittests/Format/FormatTest.cpp
index 5ebf0d7068dd6c..22cecc01484693 100644
--- a/clang/unittests/Format/FormatTest.cpp
+++ b/clang/unittests/Format/FormatTest.cpp
@@ -20010,6 +20010,17 @@ TEST_F(FormatTest, AlignConsecutiveDeclarations) {
" return 0;\n"
"}() };",
BracedAlign);
+
+ Alignment.AlignConsecutiveDeclarations.AlignFunctionDeclarations = false;
+ verifyFormat("unsigned int f1(void);\n"
+ "void f2(void);\n"
+ "size_t f3(void);\n",
+ Alignment);
+ Alignment.AlignConsecutiveDeclarations.AlignFunctionDeclarations = true;
+ verifyFormat("unsigned int f1(void);\n"
+ "void f2(void);\n"
+ "size_t f3(void);\n",
+ Alignment);
}
TEST_F(FormatTest, AlignConsecutiveShortCaseStatements) {
@@ -20253,9 +20264,16 @@ TEST_F(FormatTest, AlignWithLineBreaks) {
FormatStyle::AlignConsecutiveStyle(
{/*Enabled=*/false, /*AcrossEmptyLines=*/false,
/*AcrossComments=*/false, /*AlignCompound=*/false,
- /*AlignFunctionPointers=*/false, /*PadOperators=*/true}));
+ /*AlignFunctionDeclarations=*/false,
+ /*AlignFunctionPointers=*/false,
+ /*PadOperators=*/true}));
EXPECT_EQ(Style.AlignConsecutiveDeclarations,
- FormatStyle::AlignConsecutiveStyle({}));
+ FormatStyle::AlignConsecutiveStyle(
+ {/*Enabled=*/false, /*AcrossEmptyLines=*/false,
+ /*AcrossComments=*/false, /*AlignCompound=*/false,
+ /*AlignFunctionDeclarations=*/true,
+ /*AlignFunctionPointers=*/false,
+ /*PadOperators=*/false}));
verifyFormat("void foo() {\n"
" int myVar = 5;\n"
" double x = 3.14;\n"
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
