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 395 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) { 396 auto Tokens = annotate("bool b = requires(int i) { i + 5; };"); 397 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 398 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 399 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 400 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 401 402 Tokens = annotate("if (requires(int i) { i + 5; }) return;"); 403 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 404 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 405 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 406 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace); 407 408 Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;"); 409 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 410 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression); 411 EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen); 412 EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace); 413 414 Tokens = annotate("foo(requires(const T t) {});"); 415 ASSERT_EQ(Tokens.size(), 13u) << 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[8], tok::l_brace, TT_RequiresExpressionLBrace); 419 420 Tokens = annotate("foo(requires(const int t) {});"); 421 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 422 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 423 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 424 EXPECT_TOKEN(Tokens[8], 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(int const* volatile t) {});"); 433 ASSERT_EQ(Tokens.size(), 15u) << 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[10], tok::l_brace, TT_RequiresExpressionLBrace); 437 438 Tokens = annotate("foo(requires(T const* volatile t) {});"); 439 ASSERT_EQ(Tokens.size(), 15u) << 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[10], tok::l_brace, TT_RequiresExpressionLBrace); 443 444 Tokens = 445 annotate("foo(requires(const typename Outer<T>::Inner * const t) {});"); 446 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 447 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 448 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 449 EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace); 450 451 Tokens = annotate("template <typename T>\n" 452 "concept C = requires(T T) {\n" 453 " requires Bar<T> && Foo<T>;\n" 454 "};"); 455 ASSERT_EQ(Tokens.size(), 28u) << Tokens; 456 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 457 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 458 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 459 EXPECT_TOKEN(Tokens[14], tok::kw_requires, 460 TT_RequiresClauseInARequiresExpression); 461 462 Tokens = annotate("template <typename T>\n" 463 "concept C = requires(T T) {\n" 464 " { t.func() } -> std::same_as<int>;" 465 " requires Bar<T> && Foo<T>;\n" 466 "};"); 467 ASSERT_EQ(Tokens.size(), 43u) << 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[29], tok::kw_requires, 472 TT_RequiresClauseInARequiresExpression); 473 474 // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350. 475 Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { " 476 "requires true; };"); 477 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 478 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 479 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 480 EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace); 481 } 482 483 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) { 484 auto NumberOfAdditionalRequiresClauseTokens = 5u; 485 auto NumberOfTokensBeforeRequires = 5u; 486 487 auto BaseTokens = annotate("template<typename T>\n" 488 "T Pi = 3.14;"); 489 auto ConstrainedTokens = annotate("template<typename T>\n" 490 " requires Foo<T>\n" 491 "T Pi = 3.14;"); 492 493 auto NumberOfBaseTokens = 11u; 494 495 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 496 ASSERT_EQ(ConstrainedTokens.size(), 497 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 498 << ConstrainedTokens; 499 500 for (auto I = 0u; I < NumberOfBaseTokens; ++I) 501 if (I < NumberOfTokensBeforeRequires) 502 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 503 else 504 EXPECT_EQ(*BaseTokens[I], 505 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 506 << I; 507 508 BaseTokens = annotate("template<typename T>\n" 509 "struct Bar;"); 510 ConstrainedTokens = annotate("template<typename T>\n" 511 " requires Foo<T>\n" 512 "struct Bar;"); 513 NumberOfBaseTokens = 9u; 514 515 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 516 ASSERT_EQ(ConstrainedTokens.size(), 517 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 518 << ConstrainedTokens; 519 520 for (auto I = 0u; I < NumberOfBaseTokens; ++I) 521 if (I < NumberOfTokensBeforeRequires) 522 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 523 else 524 EXPECT_EQ(*BaseTokens[I], 525 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 526 << I; 527 528 BaseTokens = annotate("template<typename T>\n" 529 "struct Bar {" 530 " T foo();\n" 531 " T bar();\n" 532 "};"); 533 ConstrainedTokens = annotate("template<typename T>\n" 534 " requires Foo<T>\n" 535 "struct Bar {" 536 " T foo();\n" 537 " T bar();\n" 538 "};"); 539 NumberOfBaseTokens = 21u; 540 541 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 542 ASSERT_EQ(ConstrainedTokens.size(), 543 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 544 << ConstrainedTokens; 545 546 for (auto I = 0u; I < NumberOfBaseTokens; ++I) 547 if (I < NumberOfTokensBeforeRequires) 548 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 549 else 550 EXPECT_EQ(*BaseTokens[I], 551 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 552 << I; 553 554 BaseTokens = annotate("template<typename T>\n" 555 "Bar(T) -> Bar<T>;"); 556 ConstrainedTokens = annotate("template<typename T>\n" 557 " requires Foo<T>\n" 558 "Bar(T) -> Bar<T>;"); 559 NumberOfBaseTokens = 16u; 560 561 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 562 ASSERT_EQ(ConstrainedTokens.size(), 563 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 564 << ConstrainedTokens; 565 566 for (auto I = 0u; I < NumberOfBaseTokens; ++I) 567 if (I < NumberOfTokensBeforeRequires) 568 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 569 else 570 EXPECT_EQ(*BaseTokens[I], 571 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 572 << I; 573 574 BaseTokens = annotate("template<typename T>\n" 575 "T foo();"); 576 ConstrainedTokens = annotate("template<typename T>\n" 577 " requires Foo<T>\n" 578 "T foo();"); 579 NumberOfBaseTokens = 11u; 580 581 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 582 ASSERT_EQ(ConstrainedTokens.size(), 583 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 584 << ConstrainedTokens; 585 586 for (auto I = 0u; I < NumberOfBaseTokens; ++I) 587 if (I < NumberOfTokensBeforeRequires) 588 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 589 else 590 EXPECT_EQ(*BaseTokens[I], 591 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 592 << I; 593 594 BaseTokens = annotate("template<typename T>\n" 595 "T foo() {\n" 596 " auto bar = baz();\n" 597 " return bar + T{};\n" 598 "}"); 599 ConstrainedTokens = annotate("template<typename T>\n" 600 " requires Foo<T>\n" 601 "T foo() {\n" 602 " auto bar = baz();\n" 603 " return bar + T{};\n" 604 "}"); 605 NumberOfBaseTokens = 26u; 606 607 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 608 ASSERT_EQ(ConstrainedTokens.size(), 609 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 610 << ConstrainedTokens; 611 612 for (auto I = 0u; I < NumberOfBaseTokens; ++I) 613 if (I < NumberOfTokensBeforeRequires) 614 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 615 else 616 EXPECT_EQ(*BaseTokens[I], 617 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 618 << I; 619 620 BaseTokens = annotate("template<typename T>\n" 621 "T foo();"); 622 ConstrainedTokens = annotate("template<typename T>\n" 623 "T foo() requires Foo<T>;"); 624 NumberOfBaseTokens = 11u; 625 NumberOfTokensBeforeRequires = 9u; 626 627 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 628 ASSERT_EQ(ConstrainedTokens.size(), 629 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 630 << ConstrainedTokens; 631 632 for (auto I = 0u; I < NumberOfBaseTokens; ++I) 633 if (I < NumberOfTokensBeforeRequires) 634 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 635 else 636 EXPECT_EQ(*BaseTokens[I], 637 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 638 << I; 639 640 BaseTokens = annotate("template<typename T>\n" 641 "T foo() {\n" 642 " auto bar = baz();\n" 643 " return bar + T{};\n" 644 "}"); 645 ConstrainedTokens = annotate("template<typename T>\n" 646 "T foo() requires Foo<T> {\n" 647 " auto bar = baz();\n" 648 " return bar + T{};\n" 649 "}"); 650 NumberOfBaseTokens = 26u; 651 652 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 653 ASSERT_EQ(ConstrainedTokens.size(), 654 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 655 << ConstrainedTokens; 656 657 for (auto I = 0u; I < NumberOfBaseTokens; ++I) 658 if (I < NumberOfTokensBeforeRequires) 659 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 660 else 661 EXPECT_EQ(*BaseTokens[I], 662 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 663 << I; 664 665 BaseTokens = annotate("template<typename T>\n" 666 "Bar(T) -> Bar<typename T::I>;"); 667 ConstrainedTokens = annotate("template<typename T>\n" 668 " requires requires(T &&t) {\n" 669 " typename T::I;\n" 670 " }\n" 671 "Bar(T) -> Bar<typename T::I>;"); 672 NumberOfBaseTokens = 19u; 673 NumberOfAdditionalRequiresClauseTokens = 14u; 674 NumberOfTokensBeforeRequires = 5u; 675 676 ASSERT_EQ(BaseTokens.size(), NumberOfBaseTokens) << BaseTokens; 677 ASSERT_EQ(ConstrainedTokens.size(), 678 NumberOfBaseTokens + NumberOfAdditionalRequiresClauseTokens) 679 << ConstrainedTokens; 680 681 for (auto I = 0u; I < NumberOfBaseTokens; ++I) 682 if (I < NumberOfTokensBeforeRequires) 683 EXPECT_EQ(*BaseTokens[I], *ConstrainedTokens[I]) << I; 684 else 685 EXPECT_EQ(*BaseTokens[I], 686 *ConstrainedTokens[I + NumberOfAdditionalRequiresClauseTokens]) 687 << I; 688 689 BaseTokens = annotate("struct [[nodiscard]] zero_t {\n" 690 " template<class T>\n" 691 " [[nodiscard]] constexpr operator T() const { " 692 "return number_zero_v<T>; }\n" 693 "};"); 694 695 ConstrainedTokens = annotate("struct [[nodiscard]] zero_t {\n" 696 " template<class T>\n" 697 " requires requires { number_zero_v<T>; }\n" 698 " [[nodiscard]] constexpr operator T() const { " 699 "return number_zero_v<T>; }\n" 700 "};"); 701 NumberOfBaseTokens = 35u; 702 NumberOfAdditionalRequiresClauseTokens = 9u; 703 NumberOfTokensBeforeRequires = 13u; 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 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 } // namespace 746 } // namespace format 747 } // namespace clang 748