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 407 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) { 408 auto Tokens = annotate("bool b = requires(int i) { i + 5; };"); 409 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 410 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 411 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 412 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 413 414 Tokens = annotate("if (requires(int i) { i + 5; }) return;"); 415 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 416 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 417 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 418 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace); 419 420 Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;"); 421 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 422 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression); 423 EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen); 424 EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace); 425 426 Tokens = annotate("foo(requires(const T t) {});"); 427 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 428 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 429 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 430 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 431 432 Tokens = annotate("foo(requires(const int t) {});"); 433 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 434 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 435 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 436 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 437 438 Tokens = annotate("foo(requires(const T t) {});"); 439 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 440 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 441 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 442 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 443 444 Tokens = annotate("foo(requires(int const* volatile t) {});"); 445 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 446 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 447 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 448 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 449 450 Tokens = annotate("foo(requires(T const* volatile t) {});"); 451 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 452 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 453 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 454 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 455 456 Tokens = 457 annotate("foo(requires(const typename Outer<T>::Inner * const t) {});"); 458 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 459 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 460 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 461 EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace); 462 463 Tokens = annotate("template <typename T>\n" 464 "concept C = requires(T T) {\n" 465 " requires Bar<T> && Foo<T>;\n" 466 "};"); 467 ASSERT_EQ(Tokens.size(), 28u) << Tokens; 468 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 469 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 470 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 471 EXPECT_TOKEN(Tokens[14], tok::kw_requires, 472 TT_RequiresClauseInARequiresExpression); 473 474 Tokens = annotate("template <typename T>\n" 475 "concept C = requires(T T) {\n" 476 " { t.func() } -> std::same_as<int>;" 477 " requires Bar<T> && Foo<T>;\n" 478 "};"); 479 ASSERT_EQ(Tokens.size(), 43u) << Tokens; 480 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 481 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 482 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 483 EXPECT_TOKEN(Tokens[29], tok::kw_requires, 484 TT_RequiresClauseInARequiresExpression); 485 486 // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350. 487 Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { " 488 "requires true; };"); 489 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 490 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 491 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 492 EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace); 493 } 494 495 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) { 496 auto NumberOfAdditionalRequiresClauseTokens = 5u; 497 auto NumberOfTokensBeforeRequires = 5u; 498 499 auto BaseTokens = annotate("template<typename T>\n" 500 "T Pi = 3.14;"); 501 auto ConstrainedTokens = annotate("template<typename T>\n" 502 " requires Foo<T>\n" 503 "T Pi = 3.14;"); 504 505 auto NumberOfBaseTokens = 11u; 506 507 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 508 ASSERT_EQ(ConstrainedTokens.size(), 509 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 510 << ConstrainedTokens; 511 512 for (auto I = 0u; I < NumberOfBaseTokens; ++I) { 513 if (I < NumberOfTokensBeforeRequires) { 514 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 515 } else { 516 EXPECT_EQ(*BaseTokens[I], 517 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 518 << I; 519 } 520 } 521 522 BaseTokens = annotate("template<typename T>\n" 523 "struct Bar;"); 524 ConstrainedTokens = annotate("template<typename T>\n" 525 " requires Foo<T>\n" 526 "struct Bar;"); 527 NumberOfBaseTokens = 9u; 528 529 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 530 ASSERT_EQ(ConstrainedTokens.size(), 531 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 532 << ConstrainedTokens; 533 534 for (auto I = 0u; I < NumberOfBaseTokens; ++I) { 535 if (I < NumberOfTokensBeforeRequires) { 536 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 537 } else { 538 EXPECT_EQ(*BaseTokens[I], 539 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 540 << I; 541 } 542 } 543 544 BaseTokens = annotate("template<typename T>\n" 545 "struct Bar {" 546 " T foo();\n" 547 " T bar();\n" 548 "};"); 549 ConstrainedTokens = annotate("template<typename T>\n" 550 " requires Foo<T>\n" 551 "struct Bar {" 552 " T foo();\n" 553 " T bar();\n" 554 "};"); 555 NumberOfBaseTokens = 21u; 556 557 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 558 ASSERT_EQ(ConstrainedTokens.size(), 559 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 560 << ConstrainedTokens; 561 562 for (auto I = 0u; I < NumberOfBaseTokens; ++I) { 563 if (I < NumberOfTokensBeforeRequires) { 564 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 565 } else { 566 EXPECT_EQ(*BaseTokens[I], 567 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 568 << I; 569 } 570 } 571 572 BaseTokens = annotate("template<typename T>\n" 573 "Bar(T) -> Bar<T>;"); 574 ConstrainedTokens = annotate("template<typename T>\n" 575 " requires Foo<T>\n" 576 "Bar(T) -> Bar<T>;"); 577 NumberOfBaseTokens = 16u; 578 579 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 580 ASSERT_EQ(ConstrainedTokens.size(), 581 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 582 << ConstrainedTokens; 583 584 for (auto I = 0u; I < NumberOfBaseTokens; ++I) { 585 if (I < NumberOfTokensBeforeRequires) { 586 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 587 } else { 588 EXPECT_EQ(*BaseTokens[I], 589 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 590 << I; 591 } 592 } 593 594 BaseTokens = annotate("template<typename T>\n" 595 "T foo();"); 596 ConstrainedTokens = annotate("template<typename T>\n" 597 " requires Foo<T>\n" 598 "T foo();"); 599 NumberOfBaseTokens = 11u; 600 601 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 602 ASSERT_EQ(ConstrainedTokens.size(), 603 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 604 << ConstrainedTokens; 605 606 for (auto I = 0u; I < NumberOfBaseTokens; ++I) { 607 if (I < NumberOfTokensBeforeRequires) { 608 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 609 } else { 610 EXPECT_EQ(*BaseTokens[I], 611 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 612 << I; 613 } 614 } 615 616 BaseTokens = annotate("template<typename T>\n" 617 "T foo() {\n" 618 " auto bar = baz();\n" 619 " return bar + T{};\n" 620 "}"); 621 ConstrainedTokens = annotate("template<typename T>\n" 622 " requires Foo<T>\n" 623 "T foo() {\n" 624 " auto bar = baz();\n" 625 " return bar + T{};\n" 626 "}"); 627 NumberOfBaseTokens = 26u; 628 629 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 630 ASSERT_EQ(ConstrainedTokens.size(), 631 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 632 << ConstrainedTokens; 633 634 for (auto I = 0u; I < NumberOfBaseTokens; ++I) { 635 if (I < NumberOfTokensBeforeRequires) { 636 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 637 } else { 638 EXPECT_EQ(*BaseTokens[I], 639 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 640 << I; 641 } 642 } 643 644 BaseTokens = annotate("template<typename T>\n" 645 "T foo();"); 646 ConstrainedTokens = annotate("template<typename T>\n" 647 "T foo() requires Foo<T>;"); 648 NumberOfBaseTokens = 11u; 649 NumberOfTokensBeforeRequires = 9u; 650 651 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 652 ASSERT_EQ(ConstrainedTokens.size(), 653 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 654 << ConstrainedTokens; 655 656 for (auto I = 0u; I < NumberOfBaseTokens; ++I) { 657 if (I < NumberOfTokensBeforeRequires) { 658 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 659 } else { 660 EXPECT_EQ(*BaseTokens[I], 661 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 662 << I; 663 } 664 } 665 666 BaseTokens = annotate("template<typename T>\n" 667 "T foo() {\n" 668 " auto bar = baz();\n" 669 " return bar + T{};\n" 670 "}"); 671 ConstrainedTokens = annotate("template<typename T>\n" 672 "T foo() requires Foo<T> {\n" 673 " auto bar = baz();\n" 674 " return bar + T{};\n" 675 "}"); 676 NumberOfBaseTokens = 26u; 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 "Bar(T) -> Bar<typename T::I>;"); 695 ConstrainedTokens = annotate("template<typename T>\n" 696 " requires requires(T &&t) {\n" 697 " typename T::I;\n" 698 " }\n" 699 "Bar(T) -> Bar<typename T::I>;"); 700 NumberOfBaseTokens = 19u; 701 NumberOfAdditionalRequiresClauseTokens = 14u; 702 NumberOfTokensBeforeRequires = 5u; 703 704 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 705 ASSERT_EQ(ConstrainedTokens.size(), 706 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 707 << ConstrainedTokens; 708 709 for (auto I = 0u; I < NumberOfBaseTokens; ++I) { 710 if (I < NumberOfTokensBeforeRequires) { 711 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 712 } else { 713 EXPECT_EQ(*BaseTokens[I], 714 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 715 << I; 716 } 717 } 718 719 BaseTokens = annotate("struct [[nodiscard]] zero_t {\n" 720 " template<class T>\n" 721 " [[nodiscard]] constexpr operator T() const { " 722 "return number_zero_v<T>; }\n" 723 "};"); 724 725 ConstrainedTokens = annotate("struct [[nodiscard]] zero_t {\n" 726 " template<class T>\n" 727 " requires requires { number_zero_v<T>; }\n" 728 " [[nodiscard]] constexpr operator T() const { " 729 "return number_zero_v<T>; }\n" 730 "};"); 731 NumberOfBaseTokens = 35u; 732 NumberOfAdditionalRequiresClauseTokens = 9u; 733 NumberOfTokensBeforeRequires = 13u; 734 735 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 736 ASSERT_EQ(ConstrainedTokens.size(), 737 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 738 << ConstrainedTokens; 739 740 for (auto I = 0u; I < NumberOfBaseTokens; ++I) { 741 if (I < NumberOfTokensBeforeRequires) { 742 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 743 } else { 744 EXPECT_EQ(*BaseTokens[I], 745 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 746 << I; 747 } 748 } 749 } 750 751 TEST_F(TokenAnnotatorTest, UnderstandsAsm) { 752 auto Tokens = annotate("__asm{\n" 753 "a:\n" 754 "};"); 755 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 756 EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown); 757 EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace); 758 EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace); 759 } 760 761 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) { 762 auto Tokens = annotate("int (^)() = ^ ()\n" 763 " external_source_symbol() { //\n" 764 " return 1;\n" 765 "};"); 766 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 767 EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen); 768 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace); 769 770 Tokens = annotate("int *p = ^int*(){ //\n" 771 " return nullptr;\n" 772 "}();"); 773 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 774 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace); 775 } 776 777 } // namespace 778 } // namespace format 779 } // namespace clang 780