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