1 //===- unittest/Format/TokenAnnotatorTest.cpp - Formatting unit tests -----===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "clang/Format/Format.h" 10 11 #include "FormatTestUtils.h" 12 #include "TestLexer.h" 13 #include "gtest/gtest.h" 14 15 namespace clang { 16 namespace format { 17 18 // Not really the equality, but everything we need. 19 static bool operator==(const FormatToken &LHS, 20 const FormatToken &RHS) noexcept { 21 return LHS.Tok.getKind() == RHS.Tok.getKind() && 22 LHS.getType() == RHS.getType(); 23 } 24 25 namespace { 26 27 class TokenAnnotatorTest : public ::testing::Test { 28 protected: 29 TokenList annotate(llvm::StringRef Code, 30 const FormatStyle &Style = getLLVMStyle()) { 31 return TestLexer(Allocator, Buffers, Style).annotate(Code); 32 } 33 llvm::SpecificBumpPtrAllocator<FormatToken> Allocator; 34 std::vector<std::unique_ptr<llvm::MemoryBuffer>> Buffers; 35 }; 36 37 #define EXPECT_TOKEN_KIND(FormatTok, Kind) \ 38 EXPECT_EQ((FormatTok)->Tok.getKind(), Kind) << *(FormatTok) 39 #define EXPECT_TOKEN_TYPE(FormatTok, Type) \ 40 EXPECT_EQ((FormatTok)->getType(), Type) << *(FormatTok) 41 #define EXPECT_TOKEN_PRECEDENCE(FormatTok, Prec) \ 42 EXPECT_EQ((FormatTok)->getPrecedence(), Prec) << *(FormatTok) 43 #define EXPECT_TOKEN(FormatTok, Kind, Type) \ 44 do { \ 45 EXPECT_TOKEN_KIND(FormatTok, Kind); \ 46 EXPECT_TOKEN_TYPE(FormatTok, Type); \ 47 } while (false) 48 49 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfStarAndAmp) { 50 auto Tokens = annotate("auto x = [](const decltype(x) &ptr) {};"); 51 EXPECT_EQ(Tokens.size(), 18u) << Tokens; 52 EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown); 53 EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen); 54 EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown); 55 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 56 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 57 58 Tokens = annotate("auto x = [](const decltype(x) *ptr) {};"); 59 EXPECT_EQ(Tokens.size(), 18u) << Tokens; 60 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 61 EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference); 62 63 Tokens = annotate("#define lambda [](const decltype(x) &ptr) {}"); 64 EXPECT_EQ(Tokens.size(), 17u) << Tokens; 65 EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown); 66 EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen); 67 EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown); 68 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 69 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 70 71 Tokens = annotate("#define lambda [](const decltype(x) *ptr) {}"); 72 EXPECT_EQ(Tokens.size(), 17u) << Tokens; 73 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 74 EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference); 75 76 Tokens = annotate("void f() {\n" 77 " while (p < a && *p == 'a')\n" 78 " p++;\n" 79 "}"); 80 EXPECT_EQ(Tokens.size(), 21u) << Tokens; 81 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 82 EXPECT_TOKEN(Tokens[11], tok::star, TT_UnaryOperator); 83 84 Tokens = annotate("case *x:"); 85 EXPECT_EQ(Tokens.size(), 5u) << Tokens; 86 EXPECT_TOKEN(Tokens[1], tok::star, TT_UnaryOperator); 87 Tokens = annotate("case &x:"); 88 EXPECT_EQ(Tokens.size(), 5u) << Tokens; 89 EXPECT_TOKEN(Tokens[1], tok::amp, TT_UnaryOperator); 90 91 Tokens = annotate("struct {\n" 92 "} *ptr;"); 93 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 94 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 95 Tokens = annotate("union {\n" 96 "} *ptr;"); 97 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 98 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 99 Tokens = annotate("class {\n" 100 "} *ptr;"); 101 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 102 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 103 104 Tokens = annotate("struct {\n" 105 "} &&ptr = {};"); 106 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 107 EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference); 108 Tokens = annotate("union {\n" 109 "} &&ptr = {};"); 110 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 111 EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference); 112 Tokens = annotate("class {\n" 113 "} &&ptr = {};"); 114 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 115 EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference); 116 Tokens = annotate("int i = int{42} * 2;"); 117 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 118 EXPECT_TOKEN(Tokens[7], tok::star, TT_BinaryOperator); 119 } 120 121 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) { 122 auto Tokens = annotate("x - 0"); 123 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 124 EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator); 125 Tokens = annotate("0 + 0"); 126 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 127 EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator); 128 Tokens = annotate("x + +0"); 129 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 130 EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator); 131 Tokens = annotate("x ? -0 : +0"); 132 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 133 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 134 EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator); 135 Tokens = annotate("(-0)"); 136 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 137 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 138 Tokens = annotate("0, -0"); 139 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 140 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 141 Tokens = annotate("for (; -1;) {\n}"); 142 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 143 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 144 Tokens = annotate("x = -1;"); 145 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 146 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 147 Tokens = annotate("x[-1]"); 148 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 149 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 150 Tokens = annotate("x = {-1};"); 151 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 152 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 153 Tokens = annotate("case -x:"); 154 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 155 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 156 Tokens = annotate("co_await -x;"); 157 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 158 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 159 Tokens = annotate("co_return -x;"); 160 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 161 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 162 Tokens = annotate("co_yield -x;"); 163 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 164 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 165 Tokens = annotate("delete -x;"); 166 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 167 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 168 Tokens = annotate("return -x;"); 169 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 170 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 171 Tokens = annotate("throw -x;"); 172 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 173 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 174 Tokens = annotate("sizeof -x"); 175 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 176 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 177 Tokens = annotate("co_await +x;"); 178 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 179 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 180 Tokens = annotate("co_return +x;"); 181 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 182 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 183 Tokens = annotate("co_yield +x;"); 184 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 185 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 186 Tokens = annotate("delete +x;"); 187 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 188 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 189 Tokens = annotate("return +x;"); 190 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 191 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 192 Tokens = annotate("throw +x;"); 193 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 194 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 195 Tokens = annotate("sizeof +x"); 196 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 197 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 198 Tokens = annotate("(int)-x"); 199 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 200 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 201 Tokens = annotate("(-x)"); 202 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 203 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 204 Tokens = annotate("!+x"); 205 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 206 EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator); 207 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 208 } 209 210 TEST_F(TokenAnnotatorTest, UnderstandsClasses) { 211 auto Tokens = annotate("class C {};"); 212 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 213 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace); 214 215 Tokens = annotate("const class C {} c;"); 216 EXPECT_EQ(Tokens.size(), 8u) << Tokens; 217 EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace); 218 219 Tokens = annotate("const class {} c;"); 220 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 221 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace); 222 } 223 224 TEST_F(TokenAnnotatorTest, UnderstandsStructs) { 225 auto Tokens = annotate("struct S {};"); 226 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 227 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace); 228 } 229 230 TEST_F(TokenAnnotatorTest, UnderstandsUnions) { 231 auto Tokens = annotate("union U {};"); 232 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 233 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace); 234 235 Tokens = annotate("union U { void f() { return; } };"); 236 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 237 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace); 238 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace); 239 } 240 241 TEST_F(TokenAnnotatorTest, UnderstandsEnums) { 242 auto Tokens = annotate("enum E {};"); 243 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 244 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace); 245 } 246 247 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) { 248 auto Tokens = annotate("auto operator<=>(const T &) const & = default;"); 249 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 250 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 251 252 Tokens = annotate("template <typename T> void F(T) && = delete;"); 253 EXPECT_EQ(Tokens.size(), 15u) << Tokens; 254 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference); 255 } 256 257 TEST_F(TokenAnnotatorTest, UnderstandsVariables) { 258 auto Tokens = 259 annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;"); 260 EXPECT_EQ(Tokens.size(), 15u) << Tokens; 261 EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator); 262 } 263 264 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) { 265 auto Tokens = 266 annotate("template <typename T> " 267 "inline bool var = is_integral_v<int> && is_signed_v<int>;"); 268 EXPECT_EQ(Tokens.size(), 20u) << Tokens; 269 EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator); 270 } 271 272 TEST_F(TokenAnnotatorTest, UnderstandsLBracesInMacroDefinition) { 273 auto Tokens = annotate("#define BEGIN NS {"); 274 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 275 EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_Unknown); 276 } 277 278 TEST_F(TokenAnnotatorTest, UnderstandsDelete) { 279 auto Tokens = annotate("delete (void *)p;"); 280 EXPECT_EQ(Tokens.size(), 8u) << Tokens; 281 EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen); 282 283 Tokens = annotate("delete[] (void *)p;"); 284 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 285 EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen); 286 287 Tokens = annotate("delete[] /*comment*/ (void *)p;"); 288 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 289 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 290 291 Tokens = annotate("delete[/*comment*/] (void *)p;"); 292 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 293 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 294 295 Tokens = annotate("delete/*comment*/[] (void *)p;"); 296 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 297 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 298 } 299 300 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) { 301 auto Tokens = annotate("void f() &;"); 302 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 303 EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference); 304 305 Tokens = annotate("void operator=(T) &&;"); 306 EXPECT_EQ(Tokens.size(), 9u) << Tokens; 307 EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference); 308 309 Tokens = annotate("template <typename T> void f() &;"); 310 EXPECT_EQ(Tokens.size(), 12u) << Tokens; 311 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 312 313 Tokens = annotate("template <typename T> void operator=(T) &;"); 314 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 315 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 316 } 317 318 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) { 319 auto Tokens = annotate("template <typename T>\n" 320 "concept C = (Foo && Bar) && (Bar && Baz);"); 321 322 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 323 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 324 EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator); 325 EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator); 326 327 Tokens = annotate("template <typename T>\n" 328 "concept C = requires(T t) {\n" 329 " { t.foo() };\n" 330 "} && Bar<T> && Baz<T>;"); 331 ASSERT_EQ(Tokens.size(), 35u) << Tokens; 332 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 333 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 334 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 335 EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator); 336 EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator); 337 338 Tokens = annotate("template<typename T>\n" 339 "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n" 340 "struct Foo;"); 341 ASSERT_EQ(Tokens.size(), 36u) << Tokens; 342 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 343 EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown); 344 EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u); 345 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 346 EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator); 347 EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator); 348 EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator); 349 EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser); 350 EXPECT_EQ(Tokens[31]->FakeRParens, 1u); 351 EXPECT_TRUE(Tokens[31]->ClosesRequiresClause); 352 353 Tokens = 354 annotate("template<typename T>\n" 355 "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n" 356 "struct Foo;"); 357 ASSERT_EQ(Tokens.size(), 38u) << Tokens; 358 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 359 EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown); 360 EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u); 361 EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator); 362 EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator); 363 EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator); 364 EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator); 365 EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser); 366 EXPECT_EQ(Tokens[32]->FakeRParens, 1u); 367 EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown); 368 EXPECT_TRUE(Tokens[33]->ClosesRequiresClause); 369 370 Tokens = annotate("template <typename T>\n" 371 "void foo(T) noexcept requires Bar<T>;"); 372 ASSERT_EQ(Tokens.size(), 18u) << Tokens; 373 EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause); 374 375 Tokens = annotate("template <typename T>\n" 376 "struct S {\n" 377 " void foo() const requires Bar<T>;\n" 378 " void bar() const & requires Baz<T>;\n" 379 " void bar() && requires Baz2<T>;\n" 380 " void baz() const & noexcept requires Baz<T>;\n" 381 " void baz() && noexcept requires Baz2<T>;\n" 382 "};\n" 383 "\n" 384 "void S::bar() const & requires Baz<T> { }"); 385 ASSERT_EQ(Tokens.size(), 85u) << Tokens; 386 EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause); 387 EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause); 388 EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause); 389 EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause); 390 EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause); 391 EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause); 392 393 Tokens = annotate("void Class::member() && requires(Constant) {}"); 394 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 395 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 396 397 Tokens = annotate("void Class::member() && requires(Constant<T>) {}"); 398 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 399 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 400 401 Tokens = 402 annotate("void Class::member() && requires(Namespace::Constant<T>) {}"); 403 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 404 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 405 406 Tokens = annotate("void Class::member() && requires(typename " 407 "Namespace::Outer<T>::Inner::Constant) {}"); 408 ASSERT_EQ(Tokens.size(), 24u) << Tokens; 409 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 410 411 Tokens = annotate("struct [[nodiscard]] zero_t {\n" 412 " template<class T>\n" 413 " requires requires { number_zero_v<T>; }\n" 414 " [[nodiscard]] constexpr operator T() const { " 415 "return number_zero_v<T>; }\n" 416 "};"); 417 ASSERT_EQ(Tokens.size(), 44u); 418 EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause); 419 EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression); 420 EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace); 421 EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown); 422 EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]); 423 EXPECT_TRUE(Tokens[21]->ClosesRequiresClause); 424 425 Tokens = 426 annotate("template <class A, class B> concept C =" 427 "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;"); 428 ASSERT_EQ(Tokens.size(), 31u) << Tokens; 429 EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown); 430 EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener); 431 EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener); 432 EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser); 433 EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener); 434 EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser); 435 EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser); 436 437 Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}"); 438 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 439 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 440 441 Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}"); 442 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 443 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 444 445 Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}"); 446 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 447 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 448 449 Tokens = 450 annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}"); 451 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 452 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 453 454 Tokens = 455 annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}"); 456 ASSERT_EQ(Tokens.size(), 18u) << Tokens; 457 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause); 458 459 Tokens = 460 annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}"); 461 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 462 EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause); 463 } 464 465 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) { 466 auto Tokens = annotate("bool b = requires(int i) { i + 5; };"); 467 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 468 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 469 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 470 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 471 472 Tokens = annotate("if (requires(int i) { i + 5; }) return;"); 473 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 474 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 475 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 476 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace); 477 478 Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;"); 479 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 480 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression); 481 EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen); 482 EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace); 483 484 Tokens = annotate("foo(requires(const T t) {});"); 485 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 486 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 487 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 488 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 489 490 Tokens = annotate("foo(requires(const int t) {});"); 491 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 492 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 493 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 494 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 495 496 Tokens = annotate("foo(requires(const T t) {});"); 497 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 498 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 499 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 500 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 501 502 Tokens = annotate("foo(requires(int const* volatile t) {});"); 503 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 504 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 505 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 506 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 507 508 Tokens = annotate("foo(requires(T const* volatile t) {});"); 509 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 510 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 511 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 512 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 513 514 Tokens = 515 annotate("foo(requires(const typename Outer<T>::Inner * const t) {});"); 516 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 517 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 518 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 519 EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace); 520 521 Tokens = annotate("template <typename T>\n" 522 "concept C = requires(T T) {\n" 523 " requires Bar<T> && Foo<T>;\n" 524 "};"); 525 ASSERT_EQ(Tokens.size(), 28u) << Tokens; 526 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 527 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 528 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 529 EXPECT_TOKEN(Tokens[14], tok::kw_requires, 530 TT_RequiresClauseInARequiresExpression); 531 532 Tokens = annotate("template <typename T>\n" 533 "concept C = requires(T T) {\n" 534 " { t.func() } -> std::same_as<int>;" 535 " requires Bar<T> && Foo<T>;\n" 536 "};"); 537 ASSERT_EQ(Tokens.size(), 43u) << Tokens; 538 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 539 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 540 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 541 EXPECT_TOKEN(Tokens[29], tok::kw_requires, 542 TT_RequiresClauseInARequiresExpression); 543 544 // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350. 545 Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { " 546 "requires true; };"); 547 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 548 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 549 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 550 EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace); 551 } 552 553 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) { 554 const char *BaseCode = nullptr; 555 const char *ConstrainedCode = nullptr; 556 auto BaseTokenCount = 0u; 557 auto RequiresTokenCount = 0u; 558 auto PrefixTokenCount = 0u; 559 560 auto TestRequires = [&](int Line) { 561 const auto BaseTokens = annotate(BaseCode); 562 const auto ConstrainedTokens = annotate(ConstrainedCode); 563 564 #define LINE " (Line " << Line << ')' 565 566 ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE; 567 ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount) 568 << LINE; 569 570 for (auto I = 0u; I < BaseTokenCount; ++I) { 571 EXPECT_EQ( 572 *BaseTokens[I], 573 *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount]) 574 << I << LINE; 575 } 576 577 #undef LINE 578 }; 579 580 BaseCode = "template<typename T>\n" 581 "T Pi = 3.14;"; 582 ConstrainedCode = "template<typename T>\n" 583 " requires Foo<T>\n" 584 "T Pi = 3.14;"; 585 BaseTokenCount = 11; 586 RequiresTokenCount = 5; 587 PrefixTokenCount = 5; 588 TestRequires(__LINE__); 589 590 BaseCode = "template<typename T>\n" 591 "struct Bar;"; 592 ConstrainedCode = "template<typename T>\n" 593 " requires Foo<T>\n" 594 "struct Bar;"; 595 BaseTokenCount = 9; 596 TestRequires(__LINE__); 597 598 BaseCode = "template<typename T>\n" 599 "struct Bar {\n" 600 " T foo();\n" 601 " T bar();\n" 602 "};"; 603 ConstrainedCode = "template<typename T>\n" 604 " requires Foo<T>\n" 605 "struct Bar {\n" 606 " T foo();\n" 607 " T bar();\n" 608 "};"; 609 BaseTokenCount = 21; 610 TestRequires(__LINE__); 611 612 BaseCode = "template<typename T>\n" 613 "Bar(T) -> Bar<T>;"; 614 ConstrainedCode = "template<typename T>\n" 615 " requires Foo<T>\n" 616 "Bar(T) -> Bar<T>;"; 617 BaseTokenCount = 16; 618 TestRequires(__LINE__); 619 620 BaseCode = "template<typename T>\n" 621 "T foo();"; 622 ConstrainedCode = "template<typename T>\n" 623 " requires Foo<T>\n" 624 "T foo();"; 625 BaseTokenCount = 11; 626 TestRequires(__LINE__); 627 628 BaseCode = "template<typename T>\n" 629 "T foo() {\n" 630 " auto bar = baz();\n" 631 " return bar + T{};\n" 632 "}"; 633 ConstrainedCode = "template<typename T>\n" 634 " requires Foo<T>\n" 635 "T foo() {\n" 636 " auto bar = baz();\n" 637 " return bar + T{};\n" 638 "}"; 639 BaseTokenCount = 26; 640 TestRequires(__LINE__); 641 642 BaseCode = "template<typename T>\n" 643 "T foo();"; 644 ConstrainedCode = "template<typename T>\n" 645 "T foo() requires Foo<T>;"; 646 BaseTokenCount = 11; 647 PrefixTokenCount = 9; 648 TestRequires(__LINE__); 649 650 BaseCode = "template<typename T>\n" 651 "T foo() {\n" 652 " auto bar = baz();\n" 653 " return bar + T{};\n" 654 "}"; 655 ConstrainedCode = "template<typename T>\n" 656 "T foo() requires Foo<T> {\n" 657 " auto bar = baz();\n" 658 " return bar + T{};\n" 659 "}"; 660 BaseTokenCount = 26; 661 TestRequires(__LINE__); 662 663 BaseCode = "template<typename T>\n" 664 "Bar(T) -> Bar<typename T::I>;"; 665 ConstrainedCode = "template<typename T>\n" 666 " requires requires(T &&t) {\n" 667 " typename T::I;\n" 668 " }\n" 669 "Bar(T) -> Bar<typename T::I>;"; 670 BaseTokenCount = 19; 671 RequiresTokenCount = 14; 672 PrefixTokenCount = 5; 673 TestRequires(__LINE__); 674 675 BaseCode = "struct [[nodiscard]] zero_t {\n" 676 " template<class T>\n" 677 " [[nodiscard]] constexpr operator T() const { return v<T>; }\n" 678 "};"; 679 ConstrainedCode = 680 "struct [[nodiscard]] zero_t {\n" 681 " template<class T>\n" 682 " requires requires { v<T>; }\n" 683 " [[nodiscard]] constexpr operator T() const { return v<T>; }\n" 684 "};"; 685 BaseTokenCount = 35; 686 RequiresTokenCount = 9; 687 PrefixTokenCount = 13; 688 TestRequires(__LINE__); 689 690 BaseCode = "constexpr Foo(Foo const &other)\n" 691 " : value{other.value} {\n" 692 " do_magic();\n" 693 " do_more_magic();\n" 694 "}"; 695 ConstrainedCode = "constexpr Foo(Foo const &other)\n" 696 " requires std::is_copy_constructible<T>\n" 697 " : value{other.value} {\n" 698 " do_magic();\n" 699 " do_more_magic();\n" 700 "}"; 701 BaseTokenCount = 26; 702 RequiresTokenCount = 7; 703 PrefixTokenCount = 8; 704 TestRequires(__LINE__); 705 706 BaseCode = "constexpr Foo(Foo const &other)\n" 707 " : value{other.value} {\n" 708 " do_magic();\n" 709 " do_more_magic();\n" 710 "}"; 711 ConstrainedCode = "constexpr Foo(Foo const &other)\n" 712 " requires (std::is_copy_constructible<T>)\n" 713 " : value{other.value} {\n" 714 " do_magic();\n" 715 " do_more_magic();\n" 716 "}"; 717 RequiresTokenCount = 9; 718 TestRequires(__LINE__); 719 } 720 721 TEST_F(TokenAnnotatorTest, UnderstandsAsm) { 722 auto Tokens = annotate("__asm{\n" 723 "a:\n" 724 "};"); 725 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 726 EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown); 727 EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace); 728 EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace); 729 } 730 731 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) { 732 auto Tokens = annotate("int (^)() = ^ ()\n" 733 " external_source_symbol() { //\n" 734 " return 1;\n" 735 "};"); 736 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 737 EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen); 738 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace); 739 740 Tokens = annotate("int *p = ^int*(){ //\n" 741 " return nullptr;\n" 742 "}();"); 743 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 744 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace); 745 } 746 747 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) { 748 auto Tokens = annotate("[]() constexpr {}"); 749 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 750 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 751 EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace); 752 753 Tokens = annotate("[]() -> auto {}"); 754 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 755 EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow); 756 EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace); 757 758 Tokens = annotate("[]() -> auto & {}"); 759 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 760 EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow); 761 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 762 763 Tokens = annotate("[]() -> auto * {}"); 764 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 765 EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow); 766 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 767 } 768 769 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) { 770 auto Annotate = [this](llvm::StringRef Code) { 771 return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog)); 772 }; 773 // Test that unary operators get labeled as such and that operators like '++' 774 // don't get split. 775 tok::TokenKind Unary[] = {tok::plus, tok::minus, tok::exclaim, 776 tok::tilde, tok::amp, tok::pipe, 777 tok::caret, tok::plusplus, tok::minusminus}; 778 for (auto Kind : Unary) { 779 auto Tokens = 780 Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;"); 781 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 782 EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator); 783 } 784 // Operators formed by joining two operators like '^~'. For some of these 785 // joined operators, we don't have a separate type, so we only test for their 786 // precedence. 787 std::pair<prec::Level, std::string> JoinedBinary[] = { 788 {prec::Comma, "<->"}, {prec::Assignment, "+="}, 789 {prec::Assignment, "-="}, {prec::Assignment, "*="}, 790 {prec::Assignment, "/="}, {prec::Assignment, "%="}, 791 {prec::Assignment, "&="}, {prec::Assignment, "^="}, 792 {prec::Assignment, "<<="}, {prec::Assignment, ">>="}, 793 {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="}, 794 {prec::LogicalOr, "||"}, {prec::LogicalAnd, "&&"}, 795 {prec::Equality, "=="}, {prec::Equality, "!="}, 796 {prec::Equality, "==="}, {prec::Equality, "!=="}, 797 {prec::Equality, "==?"}, {prec::Equality, "!=?"}, 798 {prec::ExclusiveOr, "~^"}, {prec::ExclusiveOr, "^~"}, 799 }; 800 for (auto Operator : JoinedBinary) { 801 auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;"); 802 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 803 EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator); 804 EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first); 805 } 806 // '~^' and '^~' can be unary as well as binary operators. 807 auto Tokens = Annotate("x = ~^x;"); 808 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 809 EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator); 810 Tokens = Annotate("x = ^~x;"); 811 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 812 EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator); 813 // The unary operators '~&' and '~|' can only be unary operators. The current 814 // implementation treats each of them as separate unary '~' and '&' or '|' 815 // operators, which is enough for formatting purposes. In FormatTestVerilog, 816 // there is a test that there is no space in between. And even if a new line 817 // is inserted between the '~' and '|', the semantic meaning is the same as 818 // the joined operator, so the CanBreakBefore property doesn't need to be 819 // false for the second operator. 820 Tokens = Annotate("x = ~&x;"); 821 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 822 EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator); 823 EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator); 824 Tokens = Annotate("x = ~|x;"); 825 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 826 EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator); 827 EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator); 828 // Test for block label colons. 829 Tokens = Annotate("begin : x\n" 830 "end : x"); 831 ASSERT_EQ(Tokens.size(), 7u); 832 EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon); 833 EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon); 834 // Test that the dimension colon is annotated correctly. 835 Tokens = Annotate("var [1 : 0] x;"); 836 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 837 EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon); 838 Tokens = Annotate("extern function [1 : 0] x;"); 839 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 840 EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon); 841 } 842 843 } // namespace 844 } // namespace format 845 } // namespace clang 846