[clang] d54c4df - [clang-format] Fix namespace format when the name is followed by a macro
Zequan Wu via cfe-commits
cfe-commits at lists.llvm.org
Thu Mar 10 15:00:37 PST 2022
Author: Zequan Wu
Date: 2022-03-10T15:00:32-08:00
New Revision: d54c4df31470044a66605ebb8a2f936e8dd552af
URL: https://github.com/llvm/llvm-project/commit/d54c4df31470044a66605ebb8a2f936e8dd552af
DIFF: https://github.com/llvm/llvm-project/commit/d54c4df31470044a66605ebb8a2f936e8dd552af.diff
LOG: [clang-format] Fix namespace format when the name is followed by a macro
Example:
```
$ cat a.cpp
namespace my_namespace::yeah API_AVAILABLE(macos(10.15)) {
void test() {}
}
$ clang-format a.cpp
namespace my_namespace::yeah API_AVAILABLE(macos(10.15)) {
void test() {}
}// namespace my_namespace::yeahAPI_AVAILABLE(macos(10.15))
```
After:
```
$ clang-format a.cpp
namespace my_namespace::yeah API_AVAILABLE(macos(10.15)) {
void test() {}
}// namespace my_namespace::yeah
```
Reviewed By: MyDeveloperDay, owenpan, curdeius
Differential Revision: https://reviews.llvm.org/D121269
Added:
Modified:
clang/lib/Format/NamespaceEndCommentsFixer.cpp
clang/unittests/Format/NamespaceEndCommentsFixerTest.cpp
Removed:
################################################################################
diff --git a/clang/lib/Format/NamespaceEndCommentsFixer.cpp b/clang/lib/Format/NamespaceEndCommentsFixer.cpp
index e527402e33074..2615a499f7abf 100644
--- a/clang/lib/Format/NamespaceEndCommentsFixer.cpp
+++ b/clang/lib/Format/NamespaceEndCommentsFixer.cpp
@@ -13,6 +13,7 @@
//===----------------------------------------------------------------------===//
#include "NamespaceEndCommentsFixer.h"
+#include "clang/Basic/TokenKinds.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/Regex.h"
@@ -22,6 +23,40 @@ namespace clang {
namespace format {
namespace {
+// Iterates all tokens starting from StartTok to EndTok and apply Fn to all
+// tokens between them including StartTok and EndTok. Returns the token after
+// EndTok.
+const FormatToken *
+processTokens(const FormatToken *Tok, tok::TokenKind StartTok,
+ tok::TokenKind EndTok,
+ llvm::function_ref<void(const FormatToken *)> Fn) {
+ if (!Tok || Tok->isNot(StartTok))
+ return Tok;
+ int NestLevel = 0;
+ do {
+ if (Tok->is(StartTok))
+ ++NestLevel;
+ else if (Tok->is(EndTok))
+ --NestLevel;
+ if (Fn)
+ Fn(Tok);
+ Tok = Tok->getNextNonComment();
+ } while (Tok && NestLevel > 0);
+ return Tok;
+}
+
+const FormatToken *skipAttribute(const FormatToken *Tok) {
+ if (!Tok)
+ return nullptr;
+ if (Tok->is(tok::kw___attribute)) {
+ Tok = Tok->getNextNonComment();
+ Tok = processTokens(Tok, tok::l_paren, tok::r_paren, nullptr);
+ } else if (Tok->is(tok::l_square)) {
+ Tok = processTokens(Tok, tok::l_square, tok::r_square, nullptr);
+ }
+ return Tok;
+}
+
// Computes the name of a namespace given the namespace token.
// Returns "" for anonymous namespace.
std::string computeName(const FormatToken *NamespaceTok) {
@@ -39,48 +74,69 @@ std::string computeName(const FormatToken *NamespaceTok) {
name += Tok->TokenText;
Tok = Tok->getNextNonComment();
}
- } else {
- // Skip attributes.
- if (Tok && Tok->is(tok::l_square)) {
- for (int NestLevel = 1; NestLevel > 0;) {
- Tok = Tok->getNextNonComment();
- if (!Tok)
- break;
- if (Tok->is(tok::l_square))
- ++NestLevel;
- else if (Tok->is(tok::r_square))
- --NestLevel;
- }
- if (Tok)
- Tok = Tok->getNextNonComment();
- }
+ return name;
+ }
+ Tok = skipAttribute(Tok);
- // Use the string after `namespace` as a name candidate until `{` or `::` or
- // `(`. If the name is empty, use the candicate.
- std::string FirstNSName;
- // For `namespace [[foo]] A::B::inline C {` or
- // `namespace MACRO1 MACRO2 A::B::inline C {`, returns "A::B::inline C".
- // Peek for the first '::' (or '{' or '(')) and then return all tokens from
- // one token before that up until the '{'. A '(' might be a macro with
- // arguments.
- const FormatToken *FirstNSTok = Tok;
- while (Tok && !Tok->isOneOf(tok::l_brace, tok::coloncolon, tok::l_paren)) {
+ std::string FirstNSName;
+ // For `namespace [[foo]] A::B::inline C {` or
+ // `namespace MACRO1 MACRO2 A::B::inline C {`, returns "A::B::inline C".
+ // Peek for the first '::' (or '{' or '(')) and then return all tokens from
+ // one token before that up until the '{'. A '(' might be a macro with
+ // arguments.
+ const FormatToken *FirstNSTok = nullptr;
+ while (Tok && !Tok->isOneOf(tok::l_brace, tok::coloncolon, tok::l_paren)) {
+ if (FirstNSTok)
FirstNSName += FirstNSTok->TokenText;
- FirstNSTok = Tok;
- Tok = Tok->getNextNonComment();
- }
+ FirstNSTok = Tok;
+ Tok = Tok->getNextNonComment();
+ }
+ if (FirstNSTok)
Tok = FirstNSTok;
- while (Tok && !Tok->is(tok::l_brace)) {
- name += Tok->TokenText;
- if (Tok->is(tok::kw_inline))
+ Tok = skipAttribute(Tok);
+
+ FirstNSTok = nullptr;
+ // Add everything from '(' to ')'.
+ auto AddToken = [&name](const FormatToken *Tok) { name += Tok->TokenText; };
+ bool IsPrevColoncolon = false;
+ bool HasColoncolon = false;
+ bool IsPrevInline = false;
+ bool NameFinished = false;
+ // If we found '::' in name, then it's the name. Otherwise, we can't tell
+ // which one is name. For example, `namespace A B {`.
+ while (Tok && Tok->isNot(tok::l_brace)) {
+ if (FirstNSTok) {
+ if (!IsPrevInline && HasColoncolon && !IsPrevColoncolon) {
+ if (FirstNSTok->is(tok::l_paren)) {
+ FirstNSTok = Tok =
+ processTokens(FirstNSTok, tok::l_paren, tok::r_paren, AddToken);
+ continue;
+ }
+ if (FirstNSTok->isNot(tok::coloncolon)) {
+ NameFinished = true;
+ break;
+ }
+ }
+ name += FirstNSTok->TokenText;
+ IsPrevColoncolon = FirstNSTok->is(tok::coloncolon);
+ HasColoncolon = HasColoncolon || IsPrevColoncolon;
+ if (FirstNSTok->is(tok::kw_inline)) {
name += " ";
- Tok = Tok->getNextNonComment();
+ IsPrevInline = true;
+ }
}
- if (name.empty())
- name = FirstNSName;
+ FirstNSTok = Tok;
+ Tok = Tok->getNextNonComment();
+ const FormatToken *TokAfterAttr = skipAttribute(Tok);
+ if (TokAfterAttr != Tok)
+ FirstNSTok = Tok = TokAfterAttr;
}
- return name;
+ if (!NameFinished && FirstNSTok && FirstNSTok->isNot(tok::l_brace))
+ name += FirstNSTok->TokenText;
+ if (FirstNSName.empty() || HasColoncolon)
+ return name;
+ return name.empty() ? FirstNSName : FirstNSName + " " + name;
}
std::string computeEndCommentText(StringRef NamespaceName, bool AddNewline,
diff --git a/clang/unittests/Format/NamespaceEndCommentsFixerTest.cpp b/clang/unittests/Format/NamespaceEndCommentsFixerTest.cpp
index 5b98590a65554..50b861fea1daf 100644
--- a/clang/unittests/Format/NamespaceEndCommentsFixerTest.cpp
+++ b/clang/unittests/Format/NamespaceEndCommentsFixerTest.cpp
@@ -189,6 +189,49 @@ TEST_F(NamespaceEndCommentsFixerTest, AddsEndComment) {
"int i;\n"
"int j;\n"
"}"));
+ EXPECT_EQ("#define M(x) x##x\n"
+ "namespace A M(x) {\n"
+ "int i;\n"
+ "int j;\n"
+ "}// namespace A M(x)",
+ fixNamespaceEndComments("#define M(x) x##x\n"
+ "namespace A M(x) {\n"
+ "int i;\n"
+ "int j;\n"
+ "}"));
+ EXPECT_EQ(
+ "#define B __attribute__((availability(macos, introduced=10.15)))\n"
+ "namespace A B {\n"
+ "int i;\n"
+ "int j;\n"
+ "}// namespace A B",
+ fixNamespaceEndComments(
+ "#define B __attribute__((availability(macos, introduced=10.15)))\n"
+ "namespace A B {\n"
+ "int i;\n"
+ "int j;\n"
+ "}"));
+ EXPECT_EQ("#define M(x) x##x\n"
+ "namespace A::B M(x) {\n"
+ "int i;\n"
+ "int j;\n"
+ "}// namespace A::B",
+ fixNamespaceEndComments("#define M(x) x##x\n"
+ "namespace A::B M(x) {\n"
+ "int i;\n"
+ "int j;\n"
+ "}"));
+ EXPECT_EQ(
+ "namespace A __attribute__((availability(macos, introduced=10.15))) {\n"
+ "int i;\n"
+ "int j;\n"
+ "}// namespace A",
+ fixNamespaceEndComments(
+ "namespace A __attribute__((availability(macos, introduced=10.15))) "
+ "{\n"
+ "int i;\n"
+ "int j;\n"
+ "}"));
EXPECT_EQ("inline namespace A {\n"
"int i;\n"
"int j;\n"
More information about the cfe-commits
mailing list