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(FormatTok, Kind, Type) \ 42 do { \ 43 EXPECT_TOKEN_KIND(FormatTok, Kind); \ 44 EXPECT_TOKEN_TYPE(FormatTok, Type); \ 45 } while (false) 46 47 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfStarAndAmp) { 48 auto Tokens = annotate("auto x = [](const decltype(x) &ptr) {};"); 49 EXPECT_EQ(Tokens.size(), 18u) << Tokens; 50 EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown); 51 EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen); 52 EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown); 53 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 54 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 55 56 Tokens = annotate("auto x = [](const decltype(x) *ptr) {};"); 57 EXPECT_EQ(Tokens.size(), 18u) << Tokens; 58 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 59 EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference); 60 61 Tokens = annotate("#define lambda [](const decltype(x) &ptr) {}"); 62 EXPECT_EQ(Tokens.size(), 17u) << Tokens; 63 EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown); 64 EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen); 65 EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown); 66 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 67 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 68 69 Tokens = annotate("#define lambda [](const decltype(x) *ptr) {}"); 70 EXPECT_EQ(Tokens.size(), 17u) << Tokens; 71 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 72 EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference); 73 74 Tokens = annotate("void f() {\n" 75 " while (p < a && *p == 'a')\n" 76 " p++;\n" 77 "}"); 78 EXPECT_EQ(Tokens.size(), 21u) << Tokens; 79 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 80 EXPECT_TOKEN(Tokens[11], tok::star, TT_UnaryOperator); 81 82 Tokens = annotate("case *x:"); 83 EXPECT_EQ(Tokens.size(), 5u) << Tokens; 84 EXPECT_TOKEN(Tokens[1], tok::star, TT_UnaryOperator); 85 Tokens = annotate("case &x:"); 86 EXPECT_EQ(Tokens.size(), 5u) << Tokens; 87 EXPECT_TOKEN(Tokens[1], tok::amp, TT_UnaryOperator); 88 89 Tokens = annotate("struct {\n" 90 "} *ptr;"); 91 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 92 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 93 Tokens = annotate("union {\n" 94 "} *ptr;"); 95 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 96 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 97 Tokens = annotate("class {\n" 98 "} *ptr;"); 99 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 100 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 101 102 Tokens = annotate("struct {\n" 103 "} &&ptr = {};"); 104 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 105 EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference); 106 Tokens = annotate("union {\n" 107 "} &&ptr = {};"); 108 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 109 EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference); 110 Tokens = annotate("class {\n" 111 "} &&ptr = {};"); 112 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 113 EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference); 114 Tokens = annotate("int i = int{42} * 2;"); 115 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 116 EXPECT_TOKEN(Tokens[7], tok::star, TT_BinaryOperator); 117 } 118 119 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) { 120 auto Tokens = annotate("x - 0"); 121 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 122 EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator); 123 Tokens = annotate("0 + 0"); 124 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 125 EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator); 126 Tokens = annotate("x + +0"); 127 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 128 EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator); 129 Tokens = annotate("x ? -0 : +0"); 130 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 131 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 132 EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator); 133 Tokens = annotate("(-0)"); 134 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 135 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 136 Tokens = annotate("0, -0"); 137 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 138 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 139 Tokens = annotate("for (; -1;) {\n}"); 140 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 141 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 142 Tokens = annotate("x = -1;"); 143 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 144 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 145 Tokens = annotate("x[-1]"); 146 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 147 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 148 Tokens = annotate("x = {-1};"); 149 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 150 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 151 Tokens = annotate("case -x:"); 152 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 153 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 154 Tokens = annotate("co_await -x;"); 155 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 156 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 157 Tokens = annotate("co_return -x;"); 158 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 159 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 160 Tokens = annotate("co_yield -x;"); 161 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 162 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 163 Tokens = annotate("delete -x;"); 164 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 165 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 166 Tokens = annotate("return -x;"); 167 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 168 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 169 Tokens = annotate("throw -x;"); 170 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 171 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 172 Tokens = annotate("sizeof -x"); 173 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 174 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 175 Tokens = annotate("co_await +x;"); 176 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 177 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 178 Tokens = annotate("co_return +x;"); 179 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 180 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 181 Tokens = annotate("co_yield +x;"); 182 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 183 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 184 Tokens = annotate("delete +x;"); 185 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 186 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 187 Tokens = annotate("return +x;"); 188 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 189 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 190 Tokens = annotate("throw +x;"); 191 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 192 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 193 Tokens = annotate("sizeof +x"); 194 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 195 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 196 Tokens = annotate("(int)-x"); 197 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 198 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 199 Tokens = annotate("(-x)"); 200 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 201 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 202 Tokens = annotate("!+x"); 203 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 204 EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator); 205 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 206 } 207 208 TEST_F(TokenAnnotatorTest, UnderstandsClasses) { 209 auto Tokens = annotate("class C {};"); 210 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 211 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace); 212 213 Tokens = annotate("const class C {} c;"); 214 EXPECT_EQ(Tokens.size(), 8u) << Tokens; 215 EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace); 216 217 Tokens = annotate("const class {} c;"); 218 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 219 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace); 220 } 221 222 TEST_F(TokenAnnotatorTest, UnderstandsStructs) { 223 auto Tokens = annotate("struct S {};"); 224 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 225 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace); 226 } 227 228 TEST_F(TokenAnnotatorTest, UnderstandsUnions) { 229 auto Tokens = annotate("union U {};"); 230 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 231 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace); 232 233 Tokens = annotate("union U { void f() { return; } };"); 234 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 235 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace); 236 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace); 237 } 238 239 TEST_F(TokenAnnotatorTest, UnderstandsEnums) { 240 auto Tokens = annotate("enum E {};"); 241 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 242 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace); 243 } 244 245 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) { 246 auto Tokens = annotate("auto operator<=>(const T &) const & = default;"); 247 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 248 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 249 250 Tokens = annotate("template <typename T> void F(T) && = delete;"); 251 EXPECT_EQ(Tokens.size(), 15u) << Tokens; 252 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference); 253 } 254 255 TEST_F(TokenAnnotatorTest, UnderstandsVariables) { 256 auto Tokens = 257 annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;"); 258 EXPECT_EQ(Tokens.size(), 15u) << Tokens; 259 EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator); 260 } 261 262 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) { 263 auto Tokens = 264 annotate("template <typename T> " 265 "inline bool var = is_integral_v<int> && is_signed_v<int>;"); 266 EXPECT_EQ(Tokens.size(), 20u) << Tokens; 267 EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator); 268 } 269 270 TEST_F(TokenAnnotatorTest, UnderstandsLBracesInMacroDefinition) { 271 auto Tokens = annotate("#define BEGIN NS {"); 272 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 273 EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_Unknown); 274 } 275 276 TEST_F(TokenAnnotatorTest, UnderstandsDelete) { 277 auto Tokens = annotate("delete (void *)p;"); 278 EXPECT_EQ(Tokens.size(), 8u) << Tokens; 279 EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen); 280 281 Tokens = annotate("delete[] (void *)p;"); 282 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 283 EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen); 284 285 Tokens = annotate("delete[] /*comment*/ (void *)p;"); 286 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 287 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 288 289 Tokens = annotate("delete[/*comment*/] (void *)p;"); 290 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 291 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 292 293 Tokens = annotate("delete/*comment*/[] (void *)p;"); 294 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 295 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 296 } 297 298 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) { 299 auto Tokens = annotate("void f() &;"); 300 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 301 EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference); 302 303 Tokens = annotate("void operator=(T) &&;"); 304 EXPECT_EQ(Tokens.size(), 9u) << Tokens; 305 EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference); 306 307 Tokens = annotate("template <typename T> void f() &;"); 308 EXPECT_EQ(Tokens.size(), 12u) << Tokens; 309 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 310 311 Tokens = annotate("template <typename T> void operator=(T) &;"); 312 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 313 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 314 } 315 316 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) { 317 auto Tokens = annotate("template <typename T>\n" 318 "concept C = (Foo && Bar) && (Bar && Baz);"); 319 320 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 321 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 322 EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator); 323 EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator); 324 325 Tokens = annotate("template <typename T>\n" 326 "concept C = requires(T t) {\n" 327 " { t.foo() };\n" 328 "} && Bar<T> && Baz<T>;"); 329 ASSERT_EQ(Tokens.size(), 35u) << Tokens; 330 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 331 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 332 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 333 EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator); 334 EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator); 335 336 Tokens = annotate("template<typename T>\n" 337 "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n" 338 "struct Foo;"); 339 ASSERT_EQ(Tokens.size(), 36u) << Tokens; 340 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 341 EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown); 342 EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u); 343 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 344 EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator); 345 EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator); 346 EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator); 347 EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser); 348 EXPECT_EQ(Tokens[31]->FakeRParens, 1u); 349 EXPECT_TRUE(Tokens[31]->ClosesRequiresClause); 350 351 Tokens = 352 annotate("template<typename T>\n" 353 "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n" 354 "struct Foo;"); 355 ASSERT_EQ(Tokens.size(), 38u) << Tokens; 356 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 357 EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown); 358 EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u); 359 EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator); 360 EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator); 361 EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator); 362 EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator); 363 EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser); 364 EXPECT_EQ(Tokens[32]->FakeRParens, 1u); 365 EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown); 366 EXPECT_TRUE(Tokens[33]->ClosesRequiresClause); 367 368 Tokens = annotate("template <typename T>\n" 369 "void foo(T) noexcept requires Bar<T>;"); 370 ASSERT_EQ(Tokens.size(), 18u) << Tokens; 371 EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause); 372 373 Tokens = annotate("template <typename T>\n" 374 "struct S {\n" 375 " void foo() const requires Bar<T>;\n" 376 " void bar() const & requires Baz<T>;\n" 377 " void bar() && requires Baz2<T>;\n" 378 " void baz() const & noexcept requires Baz<T>;\n" 379 " void baz() && noexcept requires Baz2<T>;\n" 380 "};\n" 381 "\n" 382 "void S::bar() const & requires Baz<T> { }"); 383 ASSERT_EQ(Tokens.size(), 85u) << Tokens; 384 EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause); 385 EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause); 386 EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause); 387 EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause); 388 EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause); 389 EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause); 390 391 Tokens = annotate("void Class::member() && requires(Constant) {}"); 392 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 393 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 394 395 Tokens = annotate("void Class::member() && requires(Constant<T>) {}"); 396 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 397 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 398 399 Tokens = 400 annotate("void Class::member() && requires(Namespace::Constant<T>) {}"); 401 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 402 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 403 404 Tokens = annotate("void Class::member() && requires(typename " 405 "Namespace::Outer<T>::Inner::Constant) {}"); 406 ASSERT_EQ(Tokens.size(), 24u) << Tokens; 407 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 408 409 Tokens = annotate("struct [[nodiscard]] zero_t {\n" 410 " template<class T>\n" 411 " requires requires { number_zero_v<T>; }\n" 412 " [[nodiscard]] constexpr operator T() const { " 413 "return number_zero_v<T>; }\n" 414 "};"); 415 ASSERT_EQ(Tokens.size(), 44u); 416 EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause); 417 EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression); 418 EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace); 419 EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown); 420 EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]); 421 EXPECT_TRUE(Tokens[21]->ClosesRequiresClause); 422 423 Tokens = 424 annotate("template <class A, class B> concept C =" 425 "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;"); 426 ASSERT_EQ(Tokens.size(), 31u) << Tokens; 427 EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown); 428 EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener); 429 EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener); 430 EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser); 431 EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener); 432 EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser); 433 EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser); 434 435 Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}"); 436 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 437 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 438 439 Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}"); 440 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 441 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 442 443 Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}"); 444 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 445 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 446 447 Tokens = 448 annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}"); 449 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 450 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 451 452 Tokens = 453 annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}"); 454 ASSERT_EQ(Tokens.size(), 18u) << Tokens; 455 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause); 456 457 Tokens = 458 annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}"); 459 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 460 EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause); 461 } 462 463 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) { 464 auto Tokens = annotate("bool b = requires(int i) { i + 5; };"); 465 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 466 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 467 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 468 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 469 470 Tokens = annotate("if (requires(int i) { i + 5; }) return;"); 471 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 472 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 473 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 474 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace); 475 476 Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;"); 477 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 478 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression); 479 EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen); 480 EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace); 481 482 Tokens = annotate("foo(requires(const T t) {});"); 483 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 484 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 485 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 486 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 487 488 Tokens = annotate("foo(requires(const int t) {});"); 489 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 490 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 491 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 492 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 493 494 Tokens = annotate("foo(requires(const T t) {});"); 495 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 496 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 497 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 498 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 499 500 Tokens = annotate("foo(requires(int const* volatile t) {});"); 501 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 502 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 503 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 504 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 505 506 Tokens = annotate("foo(requires(T const* volatile t) {});"); 507 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 508 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 509 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 510 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 511 512 Tokens = 513 annotate("foo(requires(const typename Outer<T>::Inner * const t) {});"); 514 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 515 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 516 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 517 EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace); 518 519 Tokens = annotate("template <typename T>\n" 520 "concept C = requires(T T) {\n" 521 " requires Bar<T> && Foo<T>;\n" 522 "};"); 523 ASSERT_EQ(Tokens.size(), 28u) << Tokens; 524 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 525 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 526 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 527 EXPECT_TOKEN(Tokens[14], tok::kw_requires, 528 TT_RequiresClauseInARequiresExpression); 529 530 Tokens = annotate("template <typename T>\n" 531 "concept C = requires(T T) {\n" 532 " { t.func() } -> std::same_as<int>;" 533 " requires Bar<T> && Foo<T>;\n" 534 "};"); 535 ASSERT_EQ(Tokens.size(), 43u) << Tokens; 536 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 537 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 538 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 539 EXPECT_TOKEN(Tokens[29], tok::kw_requires, 540 TT_RequiresClauseInARequiresExpression); 541 542 // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350. 543 Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { " 544 "requires true; };"); 545 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 546 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 547 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 548 EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace); 549 } 550 551 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) { 552 const char *BaseCode = nullptr; 553 const char *ConstrainedCode = nullptr; 554 auto BaseTokenCount = 0u; 555 auto RequiresTokenCount = 0u; 556 auto PrefixTokenCount = 0u; 557 558 auto TestRequires = [&](int Line) { 559 const auto BaseTokens = annotate(BaseCode); 560 const auto ConstrainedTokens = annotate(ConstrainedCode); 561 562 #define LINE " (Line " << Line << ')' 563 564 ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE; 565 ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount) 566 << LINE; 567 568 for (auto I = 0u; I < BaseTokenCount; ++I) { 569 EXPECT_EQ( 570 *BaseTokens[I], 571 *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount]) 572 << I << LINE; 573 } 574 575 #undef LINE 576 }; 577 578 BaseCode = "template<typename T>\n" 579 "T Pi = 3.14;"; 580 ConstrainedCode = "template<typename T>\n" 581 " requires Foo<T>\n" 582 "T Pi = 3.14;"; 583 BaseTokenCount = 11; 584 RequiresTokenCount = 5; 585 PrefixTokenCount = 5; 586 TestRequires(__LINE__); 587 588 BaseCode = "template<typename T>\n" 589 "struct Bar;"; 590 ConstrainedCode = "template<typename T>\n" 591 " requires Foo<T>\n" 592 "struct Bar;"; 593 BaseTokenCount = 9; 594 TestRequires(__LINE__); 595 596 BaseCode = "template<typename T>\n" 597 "struct Bar {\n" 598 " T foo();\n" 599 " T bar();\n" 600 "};"; 601 ConstrainedCode = "template<typename T>\n" 602 " requires Foo<T>\n" 603 "struct Bar {\n" 604 " T foo();\n" 605 " T bar();\n" 606 "};"; 607 BaseTokenCount = 21; 608 TestRequires(__LINE__); 609 610 BaseCode = "template<typename T>\n" 611 "Bar(T) -> Bar<T>;"; 612 ConstrainedCode = "template<typename T>\n" 613 " requires Foo<T>\n" 614 "Bar(T) -> Bar<T>;"; 615 BaseTokenCount = 16; 616 TestRequires(__LINE__); 617 618 BaseCode = "template<typename T>\n" 619 "T foo();"; 620 ConstrainedCode = "template<typename T>\n" 621 " requires Foo<T>\n" 622 "T foo();"; 623 BaseTokenCount = 11; 624 TestRequires(__LINE__); 625 626 BaseCode = "template<typename T>\n" 627 "T foo() {\n" 628 " auto bar = baz();\n" 629 " return bar + T{};\n" 630 "}"; 631 ConstrainedCode = "template<typename T>\n" 632 " requires Foo<T>\n" 633 "T foo() {\n" 634 " auto bar = baz();\n" 635 " return bar + T{};\n" 636 "}"; 637 BaseTokenCount = 26; 638 TestRequires(__LINE__); 639 640 BaseCode = "template<typename T>\n" 641 "T foo();"; 642 ConstrainedCode = "template<typename T>\n" 643 "T foo() requires Foo<T>;"; 644 BaseTokenCount = 11; 645 PrefixTokenCount = 9; 646 TestRequires(__LINE__); 647 648 BaseCode = "template<typename T>\n" 649 "T foo() {\n" 650 " auto bar = baz();\n" 651 " return bar + T{};\n" 652 "}"; 653 ConstrainedCode = "template<typename T>\n" 654 "T foo() requires Foo<T> {\n" 655 " auto bar = baz();\n" 656 " return bar + T{};\n" 657 "}"; 658 BaseTokenCount = 26; 659 TestRequires(__LINE__); 660 661 BaseCode = "template<typename T>\n" 662 "Bar(T) -> Bar<typename T::I>;"; 663 ConstrainedCode = "template<typename T>\n" 664 " requires requires(T &&t) {\n" 665 " typename T::I;\n" 666 " }\n" 667 "Bar(T) -> Bar<typename T::I>;"; 668 BaseTokenCount = 19; 669 RequiresTokenCount = 14; 670 PrefixTokenCount = 5; 671 TestRequires(__LINE__); 672 673 BaseCode = "struct [[nodiscard]] zero_t {\n" 674 " template<class T>\n" 675 " [[nodiscard]] constexpr operator T() const { return v<T>; }\n" 676 "};"; 677 ConstrainedCode = 678 "struct [[nodiscard]] zero_t {\n" 679 " template<class T>\n" 680 " requires requires { v<T>; }\n" 681 " [[nodiscard]] constexpr operator T() const { return v<T>; }\n" 682 "};"; 683 BaseTokenCount = 35; 684 RequiresTokenCount = 9; 685 PrefixTokenCount = 13; 686 TestRequires(__LINE__); 687 688 BaseCode = "constexpr Foo(Foo const &other)\n" 689 " : value{other.value} {\n" 690 " do_magic();\n" 691 " do_more_magic();\n" 692 "}"; 693 ConstrainedCode = "constexpr Foo(Foo const &other)\n" 694 " requires std::is_copy_constructible<T>\n" 695 " : value{other.value} {\n" 696 " do_magic();\n" 697 " do_more_magic();\n" 698 "}"; 699 BaseTokenCount = 26; 700 RequiresTokenCount = 7; 701 PrefixTokenCount = 8; 702 TestRequires(__LINE__); 703 704 BaseCode = "constexpr Foo(Foo const &other)\n" 705 " : value{other.value} {\n" 706 " do_magic();\n" 707 " do_more_magic();\n" 708 "}"; 709 ConstrainedCode = "constexpr Foo(Foo const &other)\n" 710 " requires (std::is_copy_constructible<T>)\n" 711 " : value{other.value} {\n" 712 " do_magic();\n" 713 " do_more_magic();\n" 714 "}"; 715 RequiresTokenCount = 9; 716 TestRequires(__LINE__); 717 } 718 719 TEST_F(TokenAnnotatorTest, UnderstandsAsm) { 720 auto Tokens = annotate("__asm{\n" 721 "a:\n" 722 "};"); 723 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 724 EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown); 725 EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace); 726 EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace); 727 } 728 729 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) { 730 auto Tokens = annotate("int (^)() = ^ ()\n" 731 " external_source_symbol() { //\n" 732 " return 1;\n" 733 "};"); 734 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 735 EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen); 736 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace); 737 738 Tokens = annotate("int *p = ^int*(){ //\n" 739 " return nullptr;\n" 740 "}();"); 741 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 742 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace); 743 } 744 745 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) { 746 auto Tokens = annotate("[]() constexpr {}"); 747 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 748 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 749 EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace); 750 } 751 752 } // namespace 753 } // namespace format 754 } // namespace clang 755