Skip to content

[clang-format]: Annotate colons found in inline assembly #92617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 7, 2024
Merged

[clang-format]: Annotate colons found in inline assembly #92617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b4a8c06
[clang-format]: Annotate colons found in inline assembly
gedare May 17, 2024
835425c
TokenAnnotator: remove redundant TT_InlineASMColon and add more tests
gedare May 23, 2024
8488201
TokenAnnotator: remove last block in consumeToken colon
gedare May 24, 2024
556ef68
TokenAnnotatorTest: improve UnderstandsAsm tests
gedare May 24, 2024
41320dc
TokenAnnotaterTest: remove repetitive snippets
gedare May 25, 2024
45806d4
Update clang/unittests/Format/TokenAnnotatorTest.cpp
gedare May 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions clang/lib/Format/TokenAnnotator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1358,6 +1358,8 @@ class AnnotatingParser {
Line.First->startsSequence(tok::kw_export, Keywords.kw_module) ||
Line.First->startsSequence(tok::kw_export, Keywords.kw_import)) {
Tok->setType(TT_ModulePartitionColon);
} else if (Line.First->is(tok::kw_asm)) {
Tok->setType(TT_InlineASMColon);
} else if (Contexts.back().ColonIsDictLiteral || Style.isProto()) {
Tok->setType(TT_DictLiteral);
if (Style.Language == FormatStyle::LK_TextProto) {
Expand Down Expand Up @@ -1425,13 +1427,6 @@ class AnnotatingParser {
// This handles a special macro in ObjC code where selectors including
// the colon are passed as macro arguments.
Tok->setType(TT_ObjCMethodExpr);
} else if (Contexts.back().ContextKind == tok::l_paren &&
!Line.InPragmaDirective) {
if (Style.isTableGen() && Contexts.back().IsTableGenDAGArg) {
Tok->setType(TT_TableGenDAGArgListColon);
break;
}
Tok->setType(TT_InlineASMColon);
}
break;
case tok::pipe:
Expand Down
78 changes: 74 additions & 4 deletions clang/unittests/Format/TokenAnnotatorTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1488,12 +1488,82 @@ TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {

TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
auto Tokens = annotate("__asm{\n"
"a:\n"
"};");
ASSERT_EQ(Tokens.size(), 7u) << Tokens;
"\"a\":\n"
": x\n"
":};");
Comment on lines 1490 to +1493
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the unquoted a: in assembly code invalid? If not, please add your test instead of editing the existing one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK it's not valid, unless a is a CPP string.

ASSERT_EQ(Tokens.size(), 10u) << Tokens;
EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[7], tok::r_brace, TT_InlineASMBrace);

Tokens = annotate("__asm(\n"
"\"a\":\n"
": x\n"
":);");
ASSERT_EQ(Tokens.size(), 10u) << Tokens;
EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);

Tokens = annotate("asm volatile (\n"
"\"a_label:\"\n"
":\n"
": x\n"
":);");
ASSERT_EQ(Tokens.size(), 11u) << Tokens;
EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[7], tok::colon, TT_InlineASMColon);

Tokens = annotate("__asm__(\n"
"\"a_label:\"\n"
": x\n"
":\n"
": y);");
ASSERT_EQ(Tokens.size(), 11u) << Tokens;
EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);

Tokens = annotate("__asm volatile (\n"
"\"a_label:\"\n"
"\"a b c(%%x)\"\n"
":\n"
": x\n"
":);");
ASSERT_EQ(Tokens.size(), 12u) << Tokens;
EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[8], tok::colon, TT_InlineASMColon);

Tokens = annotate("asm(\n"
"\"insn\"\n"
": \"=r\" (var1), \"=&r\" (value)\n"
":\n"
": \"memory\");");
ASSERT_EQ(Tokens.size(), 19u) << Tokens;
EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[13], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[14], tok::colon, TT_InlineASMColon);

Tokens = annotate("__asm__ volatile (\n"
"\"ldr r1, [r0, %%[sym]]\"\n"
":\n"
": [sym] \"J\" (aaaaa(aaaa, aaaa))\n"
");");
ASSERT_EQ(Tokens.size(), 21u) << Tokens;
EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
EXPECT_TOKEN(Tokens[6], tok::l_square, TT_InlineASMSymbolicNameLSquare);
}

TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
Expand Down
Loading