1 //===- unittest/Format/TokenAnnotatorTest.cpp - Formatting unit tests -----===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #include "clang/Format/Format.h" 10 11 #include "FormatTestUtils.h" 12 #include "TestLexer.h" 13 #include "gtest/gtest.h" 14 15 namespace clang { 16 namespace format { 17 18 // Not really the equality, but everything we need. 19 static bool operator==(const FormatToken &LHS, 20 const FormatToken &RHS) noexcept { 21 return LHS.Tok.getKind() == RHS.Tok.getKind() && 22 LHS.getType() == RHS.getType(); 23 } 24 25 namespace { 26 27 class TokenAnnotatorTest : public ::testing::Test { 28 protected: 29 TokenList annotate(llvm::StringRef Code, 30 const FormatStyle &Style = getLLVMStyle()) { 31 return TestLexer(Allocator, Buffers, Style).annotate(Code); 32 } 33 llvm::SpecificBumpPtrAllocator<FormatToken> Allocator; 34 std::vector<std::unique_ptr<llvm::MemoryBuffer>> Buffers; 35 }; 36 37 #define EXPECT_TOKEN_KIND(FormatTok, Kind) \ 38 EXPECT_EQ((FormatTok)->Tok.getKind(), Kind) << *(FormatTok) 39 #define EXPECT_TOKEN_TYPE(FormatTok, Type) \ 40 EXPECT_EQ((FormatTok)->getType(), Type) << *(FormatTok) 41 #define EXPECT_TOKEN_PRECEDENCE(FormatTok, Prec) \ 42 EXPECT_EQ((FormatTok)->getPrecedence(), Prec) << *(FormatTok) 43 #define EXPECT_TOKEN(FormatTok, Kind, Type) \ 44 do { \ 45 EXPECT_TOKEN_KIND(FormatTok, Kind); \ 46 EXPECT_TOKEN_TYPE(FormatTok, Type); \ 47 } while (false) 48 49 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfStarAndAmp) { 50 auto Tokens = annotate("auto x = [](const decltype(x) &ptr) {};"); 51 EXPECT_EQ(Tokens.size(), 18u) << Tokens; 52 EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown); 53 EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen); 54 EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown); 55 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 56 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 57 58 Tokens = annotate("auto x = [](const decltype(x) *ptr) {};"); 59 EXPECT_EQ(Tokens.size(), 18u) << Tokens; 60 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 61 EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference); 62 63 Tokens = annotate("#define lambda [](const decltype(x) &ptr) {}"); 64 EXPECT_EQ(Tokens.size(), 17u) << Tokens; 65 EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown); 66 EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen); 67 EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown); 68 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 69 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 70 71 Tokens = annotate("#define lambda [](const decltype(x) *ptr) {}"); 72 EXPECT_EQ(Tokens.size(), 17u) << Tokens; 73 EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen); 74 EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference); 75 76 Tokens = annotate("void f() {\n" 77 " while (p < a && *p == 'a')\n" 78 " p++;\n" 79 "}"); 80 EXPECT_EQ(Tokens.size(), 21u) << Tokens; 81 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 82 EXPECT_TOKEN(Tokens[11], tok::star, TT_UnaryOperator); 83 84 Tokens = annotate("case *x:"); 85 EXPECT_EQ(Tokens.size(), 5u) << Tokens; 86 EXPECT_TOKEN(Tokens[1], tok::star, TT_UnaryOperator); 87 Tokens = annotate("case &x:"); 88 EXPECT_EQ(Tokens.size(), 5u) << Tokens; 89 EXPECT_TOKEN(Tokens[1], tok::amp, TT_UnaryOperator); 90 91 Tokens = annotate("bool b = 3 == int{3} && true;\n"); 92 EXPECT_EQ(Tokens.size(), 13u) << Tokens; 93 EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator); 94 95 Tokens = annotate("struct {\n" 96 "} *ptr;"); 97 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 98 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 99 Tokens = annotate("union {\n" 100 "} *ptr;"); 101 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 102 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 103 Tokens = annotate("class {\n" 104 "} *ptr;"); 105 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 106 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 107 108 Tokens = annotate("struct {\n" 109 "} &&ptr = {};"); 110 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 111 EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference); 112 Tokens = annotate("union {\n" 113 "} &&ptr = {};"); 114 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 115 EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference); 116 Tokens = annotate("class {\n" 117 "} &&ptr = {};"); 118 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 119 EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference); 120 Tokens = annotate("int i = int{42} * 2;"); 121 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 122 EXPECT_TOKEN(Tokens[7], tok::star, TT_BinaryOperator); 123 124 Tokens = annotate("delete[] *ptr;"); 125 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 126 EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator); 127 Tokens = annotate("delete[] **ptr;"); 128 EXPECT_EQ(Tokens.size(), 8u) << Tokens; 129 EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator); 130 EXPECT_TOKEN(Tokens[4], tok::star, TT_UnaryOperator); 131 Tokens = annotate("delete[] *(ptr);"); 132 EXPECT_EQ(Tokens.size(), 9u) << Tokens; 133 EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator); 134 135 Tokens = annotate("void f() { void (*fnptr)(char* foo); }"); 136 EXPECT_EQ(Tokens.size(), 18u) << Tokens; 137 EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_FunctionTypeLParen); 138 // FIXME: The star of a function pointer probably makes more sense as 139 // TT_PointerOrReference. 140 EXPECT_TOKEN(Tokens[7], tok::star, TT_UnaryOperator); 141 EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference); 142 143 Tokens = annotate("void f() { void (*fnptr)(t* foo); }"); 144 EXPECT_EQ(Tokens.size(), 18u) << Tokens; 145 EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_FunctionTypeLParen); 146 EXPECT_TOKEN(Tokens[7], tok::star, TT_UnaryOperator); 147 EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference); 148 149 Tokens = annotate("if (Foo * Bar / Test)"); 150 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 151 EXPECT_TOKEN(Tokens[3], tok::star, TT_BinaryOperator); 152 153 Tokens = annotate("if (Class* obj {getObj()})"); 154 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 155 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 156 157 Tokens = annotate("if (Foo* Bar = getObj())"); 158 ASSERT_EQ(Tokens.size(), 11u) << Tokens; 159 EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference); 160 161 Tokens = annotate("int f3() { return sizeof(Foo&); }"); 162 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 163 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 164 165 Tokens = annotate("int f4() { return sizeof(Foo&&); }"); 166 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 167 EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_PointerOrReference); 168 169 Tokens = annotate("void f5() { int f6(Foo&, Bar&); }"); 170 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 171 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 172 EXPECT_TOKEN(Tokens[12], tok::amp, TT_PointerOrReference); 173 174 Tokens = annotate("void f7() { int f8(Foo&&, Bar&&); }"); 175 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 176 EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_PointerOrReference); 177 EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_PointerOrReference); 178 179 Tokens = annotate("Type1 &val1 = val2;"); 180 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 181 EXPECT_TOKEN(Tokens[1], tok::amp, TT_PointerOrReference); 182 183 Tokens = annotate("Type1 *val1 = &val2;"); 184 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 185 EXPECT_TOKEN(Tokens[1], tok::star, TT_PointerOrReference); 186 EXPECT_TOKEN(Tokens[4], tok::amp, TT_UnaryOperator); 187 188 Tokens = annotate("val1 & val2;"); 189 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 190 EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator); 191 192 Tokens = annotate("val1 & val2.member;"); 193 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 194 EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator); 195 196 Tokens = annotate("val1 & val2.*member;"); 197 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 198 EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator); 199 200 Tokens = annotate("val1.*member & val2;"); 201 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 202 EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator); 203 204 Tokens = annotate("val1 & val2->*member;"); 205 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 206 EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator); 207 208 Tokens = annotate("val1->member & val2;"); 209 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 210 EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator); 211 212 Tokens = annotate("val1 & val2 & val3;"); 213 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 214 EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator); 215 EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator); 216 217 Tokens = annotate("val1 & val2 // comment\n" 218 " & val3;"); 219 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 220 EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator); 221 EXPECT_TOKEN(Tokens[4], tok::amp, TT_BinaryOperator); 222 223 Tokens = 224 annotate("val1 & val2.member & val3.member() & val4 & val5->member;"); 225 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 226 EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator); 227 EXPECT_TOKEN(Tokens[5], tok::amp, TT_BinaryOperator); 228 EXPECT_TOKEN(Tokens[11], tok::amp, TT_BinaryOperator); 229 EXPECT_TOKEN(Tokens[13], tok::amp, TT_BinaryOperator); 230 231 Tokens = annotate("class c {\n" 232 " void func(type &a) { a & member; }\n" 233 " anotherType &member;\n" 234 "}"); 235 ASSERT_EQ(Tokens.size(), 22u) << Tokens; 236 EXPECT_TOKEN(Tokens[7], tok::amp, TT_PointerOrReference); 237 EXPECT_TOKEN(Tokens[12], tok::amp, TT_BinaryOperator); 238 EXPECT_TOKEN(Tokens[17], tok::amp, TT_PointerOrReference); 239 240 Tokens = annotate("struct S {\n" 241 " auto Mem = C & D;\n" 242 "}"); 243 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 244 EXPECT_TOKEN(Tokens[7], tok::amp, TT_BinaryOperator); 245 } 246 247 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) { 248 auto Tokens = annotate("x - 0"); 249 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 250 EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator); 251 Tokens = annotate("0 + 0"); 252 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 253 EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator); 254 Tokens = annotate("x + +0"); 255 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 256 EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator); 257 Tokens = annotate("x ? -0 : +0"); 258 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 259 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 260 EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator); 261 Tokens = annotate("(-0)"); 262 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 263 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 264 Tokens = annotate("0, -0"); 265 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 266 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 267 Tokens = annotate("for (; -1;) {\n}"); 268 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 269 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 270 Tokens = annotate("x = -1;"); 271 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 272 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 273 Tokens = annotate("x[-1]"); 274 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 275 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 276 Tokens = annotate("x = {-1};"); 277 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 278 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 279 Tokens = annotate("case -x:"); 280 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 281 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 282 Tokens = annotate("co_await -x;"); 283 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 284 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 285 Tokens = annotate("co_return -x;"); 286 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 287 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 288 Tokens = annotate("co_yield -x;"); 289 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 290 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 291 Tokens = annotate("delete -x;"); 292 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 293 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 294 Tokens = annotate("return -x;"); 295 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 296 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 297 Tokens = annotate("throw -x;"); 298 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 299 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 300 Tokens = annotate("sizeof -x"); 301 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 302 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 303 Tokens = annotate("co_await +x;"); 304 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 305 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 306 Tokens = annotate("co_return +x;"); 307 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 308 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 309 Tokens = annotate("co_yield +x;"); 310 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 311 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 312 Tokens = annotate("delete +x;"); 313 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 314 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 315 Tokens = annotate("return +x;"); 316 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 317 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 318 Tokens = annotate("throw +x;"); 319 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 320 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 321 Tokens = annotate("sizeof +x"); 322 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 323 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 324 Tokens = annotate("(int)-x"); 325 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 326 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 327 Tokens = annotate("(-x)"); 328 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 329 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 330 Tokens = annotate("!+x"); 331 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 332 EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator); 333 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 334 } 335 336 TEST_F(TokenAnnotatorTest, UnderstandsClasses) { 337 auto Tokens = annotate("class C {};"); 338 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 339 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace); 340 341 Tokens = annotate("const class C {} c;"); 342 EXPECT_EQ(Tokens.size(), 8u) << Tokens; 343 EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace); 344 345 Tokens = annotate("const class {} c;"); 346 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 347 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace); 348 349 Tokens = annotate("class [[deprecated(\"\")]] C { int i; };"); 350 EXPECT_EQ(Tokens.size(), 17u) << Tokens; 351 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_ClassLBrace); 352 } 353 354 TEST_F(TokenAnnotatorTest, UnderstandsStructs) { 355 auto Tokens = annotate("struct S {};"); 356 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 357 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace); 358 } 359 360 TEST_F(TokenAnnotatorTest, UnderstandsUnions) { 361 auto Tokens = annotate("union U {};"); 362 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 363 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace); 364 365 Tokens = annotate("union U { void f() { return; } };"); 366 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 367 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace); 368 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace); 369 } 370 371 TEST_F(TokenAnnotatorTest, UnderstandsEnums) { 372 auto Tokens = annotate("enum E {};"); 373 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 374 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace); 375 } 376 377 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) { 378 auto Tokens = annotate("auto operator<=>(const T &) const & = default;"); 379 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 380 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 381 382 Tokens = annotate("template <typename T> void F(T) && = delete;"); 383 EXPECT_EQ(Tokens.size(), 15u) << Tokens; 384 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference); 385 } 386 387 TEST_F(TokenAnnotatorTest, UnderstandsVariables) { 388 auto Tokens = 389 annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;"); 390 EXPECT_EQ(Tokens.size(), 15u) << Tokens; 391 EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator); 392 } 393 394 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) { 395 auto Tokens = 396 annotate("template <typename T> " 397 "inline bool var = is_integral_v<int> && is_signed_v<int>;"); 398 EXPECT_EQ(Tokens.size(), 20u) << Tokens; 399 EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator); 400 } 401 402 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) { 403 auto Tokens = 404 annotate("#define FOO(typeName) \\\n" 405 " { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }"); 406 ASSERT_EQ(Tokens.size(), 27u) << Tokens; 407 EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener); 408 EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser); 409 EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener); 410 EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser); 411 } 412 413 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) { 414 auto Tokens = annotate("if (std::tuple_size_v<T> > 0)"); 415 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 416 EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener); 417 EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser); 418 EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator); 419 } 420 421 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) { 422 FormatStyle Style = getLLVMStyle(); 423 Style.WhitespaceSensitiveMacros.push_back("FOO"); 424 425 auto Tokens = annotate("FOO(1+2 )\n", Style); 426 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 427 EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc); 428 429 Tokens = annotate("FOO(a:b:c)\n", Style); 430 EXPECT_EQ(Tokens.size(), 9u) << Tokens; 431 EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc); 432 } 433 434 TEST_F(TokenAnnotatorTest, UnderstandsDelete) { 435 auto Tokens = annotate("delete (void *)p;"); 436 EXPECT_EQ(Tokens.size(), 8u) << Tokens; 437 EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen); 438 439 Tokens = annotate("delete[] (void *)p;"); 440 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 441 EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen); 442 443 Tokens = annotate("delete[] /*comment*/ (void *)p;"); 444 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 445 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 446 447 Tokens = annotate("delete[/*comment*/] (void *)p;"); 448 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 449 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 450 451 Tokens = annotate("delete/*comment*/[] (void *)p;"); 452 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 453 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 454 } 455 456 TEST_F(TokenAnnotatorTest, UnderstandsCasts) { 457 auto Tokens = annotate("(void)p;"); 458 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 459 EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen); 460 461 Tokens = annotate("auto x = (Foo)p;"); 462 EXPECT_EQ(Tokens.size(), 9u) << Tokens; 463 EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen); 464 465 Tokens = annotate("(std::vector<int>)p;"); 466 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 467 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 468 469 Tokens = annotate("return (Foo)p;"); 470 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 471 EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen); 472 473 Tokens = annotate("throw (Foo)p;"); 474 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 475 EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen); 476 } 477 478 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) { 479 auto Tokens = annotate("void f() throw(int);"); 480 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 481 EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown); 482 } 483 484 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) { 485 auto Tokens = annotate("void f() &;"); 486 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 487 EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference); 488 489 Tokens = annotate("void operator=(T) &&;"); 490 EXPECT_EQ(Tokens.size(), 9u) << Tokens; 491 EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference); 492 493 Tokens = annotate("template <typename T> void f() &;"); 494 EXPECT_EQ(Tokens.size(), 12u) << Tokens; 495 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 496 497 Tokens = annotate("template <typename T> void operator=(T) &;"); 498 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 499 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 500 } 501 502 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) { 503 auto Tokens = annotate("x.operator+()"); 504 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 505 EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 506 EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator); 507 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen); 508 Tokens = annotate("x.operator=()"); 509 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 510 EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 511 EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator); 512 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen); 513 Tokens = annotate("x.operator+=()"); 514 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 515 EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 516 EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator); 517 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen); 518 Tokens = annotate("x.operator,()"); 519 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 520 EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 521 EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator); 522 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen); 523 Tokens = annotate("x.operator()()"); 524 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 525 EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 526 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator); 527 EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator); 528 EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen); 529 Tokens = annotate("x.operator[]()"); 530 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 531 EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 532 // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator); 533 // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator); 534 EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen); 535 Tokens = annotate("x.operator\"\"_a()"); 536 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 537 EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 538 EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator); 539 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen); 540 Tokens = annotate("x.operator\"\" _a()"); 541 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 542 // FIXME 543 // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 544 EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator); 545 EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen); 546 Tokens = annotate("x.operator\"\"if()"); 547 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 548 EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 549 EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator); 550 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen); 551 Tokens = annotate("x.operator\"\"s()"); 552 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 553 EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 554 EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator); 555 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen); 556 Tokens = annotate("x.operator\"\" s()"); 557 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 558 // FIXME 559 // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName); 560 EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator); 561 EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen); 562 563 Tokens = annotate("int operator+(int);"); 564 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 565 EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName); 566 EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator); 567 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen); 568 Tokens = annotate("auto operator=(T&) {}"); 569 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 570 EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName); 571 EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator); 572 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen); 573 Tokens = annotate("auto operator()() {}"); 574 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 575 EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName); 576 EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator); 577 EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator); 578 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen); 579 } 580 581 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) { 582 struct { 583 const char *Text; 584 tok::TokenKind Kind; 585 } Operators[] = {{"+", tok::plus}, 586 {"-", tok::minus}, 587 // FIXME: 588 // {"*", tok::star}, 589 {"/", tok::slash}, 590 {"%", tok::percent}, 591 {"^", tok::caret}, 592 // FIXME: 593 // {"&", tok::amp}, 594 {"|", tok::pipe}, 595 {"~", tok::tilde}, 596 {"!", tok::exclaim}, 597 {"=", tok::equal}, 598 // FIXME: 599 // {"<", tok::less}, 600 {">", tok::greater}, 601 {"+=", tok::plusequal}, 602 {"-=", tok::minusequal}, 603 {"*=", tok::starequal}, 604 {"/=", tok::slashequal}, 605 {"%=", tok::percentequal}, 606 {"^=", tok::caretequal}, 607 {"&=", tok::ampequal}, 608 {"|=", tok::pipeequal}, 609 {"<<", tok::lessless}, 610 {">>", tok::greatergreater}, 611 {">>=", tok::greatergreaterequal}, 612 {"<<=", tok::lesslessequal}, 613 {"==", tok::equalequal}, 614 {"!=", tok::exclaimequal}, 615 {"<=", tok::lessequal}, 616 {">=", tok::greaterequal}, 617 {"<=>", tok::spaceship}, 618 {"&&", tok::ampamp}, 619 {"||", tok::pipepipe}, 620 {"++", tok::plusplus}, 621 {"--", tok::minusminus}, 622 {",", tok::comma}, 623 {"->*", tok::arrowstar}, 624 {"->", tok::arrow}}; 625 626 for (const auto &Operator : Operators) { 627 std::string Input("C<&operator"); 628 Input += Operator.Text; 629 Input += " > a;"; 630 auto Tokens = annotate(std::string(Input)); 631 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 632 EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener); 633 EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator); 634 EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser); 635 } 636 637 auto Tokens = annotate("C<&operator< <X>> lt;"); 638 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 639 EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener); 640 EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator); 641 EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener); 642 EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser); 643 EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser); 644 } 645 646 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) { 647 auto Tokens = annotate("template <typename T>\n" 648 "concept C = (Foo && Bar) && (Bar && Baz);"); 649 650 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 651 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 652 EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator); 653 EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator); 654 655 Tokens = annotate("template <typename T>\n" 656 "concept C = Foo && !Bar;"); 657 658 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 659 EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator); 660 EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator); 661 662 Tokens = annotate("template <typename T>\n" 663 "concept C = requires(T t) {\n" 664 " { t.foo() };\n" 665 "} && Bar<T> && Baz<T>;"); 666 ASSERT_EQ(Tokens.size(), 35u) << Tokens; 667 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 668 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 669 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 670 EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator); 671 EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator); 672 673 Tokens = annotate("template<typename T>\n" 674 "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n" 675 "struct Foo;"); 676 ASSERT_EQ(Tokens.size(), 36u) << Tokens; 677 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 678 EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown); 679 EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u); 680 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 681 EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator); 682 EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator); 683 EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator); 684 EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser); 685 EXPECT_EQ(Tokens[31]->FakeRParens, 1u); 686 EXPECT_TRUE(Tokens[31]->ClosesRequiresClause); 687 688 Tokens = 689 annotate("template<typename T>\n" 690 "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n" 691 "struct Foo;"); 692 ASSERT_EQ(Tokens.size(), 38u) << Tokens; 693 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 694 EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown); 695 EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u); 696 EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator); 697 EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator); 698 EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator); 699 EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator); 700 EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser); 701 EXPECT_EQ(Tokens[32]->FakeRParens, 1u); 702 EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown); 703 EXPECT_TRUE(Tokens[33]->ClosesRequiresClause); 704 705 Tokens = annotate("template <typename T>\n" 706 "void foo(T) noexcept requires Bar<T>;"); 707 ASSERT_EQ(Tokens.size(), 18u) << Tokens; 708 EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause); 709 710 Tokens = annotate("template <typename T>\n" 711 "requires Bar<T> || Baz<T>\n" 712 "auto foo(T) -> int;"); 713 ASSERT_EQ(Tokens.size(), 24u) << Tokens; 714 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 715 EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u); 716 EXPECT_TRUE(Tokens[14]->ClosesRequiresClause); 717 EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow); 718 719 Tokens = annotate("template <typename T>\n" 720 "requires Bar<T>\n" 721 "bool foo(T) { return false; }"); 722 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 723 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 724 EXPECT_TRUE(Tokens[9]->ClosesRequiresClause); 725 EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName); 726 727 Tokens = annotate("template <typename T>\n" 728 "requires Bar<T>\n" 729 "decltype(auto) foo(T) { return false; }"); 730 ASSERT_EQ(Tokens.size(), 24u) << Tokens; 731 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 732 EXPECT_TRUE(Tokens[9]->ClosesRequiresClause); 733 EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName); 734 735 Tokens = annotate("template <typename T>\n" 736 "struct S {\n" 737 " void foo() const requires Bar<T>;\n" 738 " void bar() const & requires Baz<T>;\n" 739 " void bar() && requires Baz2<T>;\n" 740 " void baz() const & noexcept requires Baz<T>;\n" 741 " void baz() && noexcept requires Baz2<T>;\n" 742 "};\n" 743 "\n" 744 "void S::bar() const & requires Baz<T> { }"); 745 ASSERT_EQ(Tokens.size(), 85u) << Tokens; 746 EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause); 747 EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference); 748 EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause); 749 EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference); 750 EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause); 751 EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference); 752 EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause); 753 EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference); 754 EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause); 755 EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference); 756 EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause); 757 758 Tokens = annotate("void Class::member() && requires(Constant) {}"); 759 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 760 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 761 762 Tokens = annotate("void Class::member() && requires(Constant<T>) {}"); 763 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 764 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 765 766 Tokens = 767 annotate("void Class::member() && requires(Namespace::Constant<T>) {}"); 768 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 769 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 770 771 Tokens = annotate("void Class::member() && requires(typename " 772 "Namespace::Outer<T>::Inner::Constant) {}"); 773 ASSERT_EQ(Tokens.size(), 24u) << Tokens; 774 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 775 776 Tokens = annotate("struct [[nodiscard]] zero_t {\n" 777 " template<class T>\n" 778 " requires requires { number_zero_v<T>; }\n" 779 " [[nodiscard]] constexpr operator T() const { " 780 "return number_zero_v<T>; }\n" 781 "};"); 782 ASSERT_EQ(Tokens.size(), 44u); 783 EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause); 784 EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression); 785 EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace); 786 EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown); 787 EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]); 788 EXPECT_TRUE(Tokens[21]->ClosesRequiresClause); 789 790 Tokens = 791 annotate("template <class A, class B> concept C =" 792 "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;"); 793 ASSERT_EQ(Tokens.size(), 31u) << Tokens; 794 EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown); 795 EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener); 796 EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener); 797 EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser); 798 EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener); 799 EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser); 800 EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser); 801 802 Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}"); 803 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 804 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 805 806 Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}"); 807 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 808 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 809 810 Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}"); 811 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 812 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 813 814 Tokens = 815 annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}"); 816 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 817 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 818 819 Tokens = 820 annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}"); 821 ASSERT_EQ(Tokens.size(), 18u) << Tokens; 822 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause); 823 824 Tokens = 825 annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}"); 826 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 827 EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause); 828 } 829 830 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) { 831 auto Tokens = annotate("bool b = requires(int i) { i + 5; };"); 832 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 833 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 834 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 835 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 836 837 Tokens = annotate("if (requires(int i) { i + 5; }) return;"); 838 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 839 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 840 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 841 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace); 842 843 Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;"); 844 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 845 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression); 846 EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen); 847 EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace); 848 849 Tokens = annotate("foo(requires(const T t) {});"); 850 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 851 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 852 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 853 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 854 855 Tokens = annotate("foo(requires(const int t) {});"); 856 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 857 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 858 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 859 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 860 861 Tokens = annotate("foo(requires(const T t) {});"); 862 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 863 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 864 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 865 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 866 867 Tokens = annotate("foo(requires(int const* volatile t) {});"); 868 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 869 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 870 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 871 EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference); 872 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 873 874 Tokens = annotate("foo(requires(T const* volatile t) {});"); 875 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 876 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 877 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 878 EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference); 879 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 880 881 Tokens = annotate("foo(requires(T& t) {});"); 882 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 883 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 884 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 885 EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference); 886 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 887 888 Tokens = annotate("foo(requires(T&& t) {});"); 889 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 890 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 891 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 892 EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference); 893 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 894 895 Tokens = annotate("bool foo = requires(T& t) {};"); 896 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 897 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 898 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 899 EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference); 900 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace); 901 902 Tokens = annotate("bool foo = requires(T&& t) {};"); 903 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 904 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 905 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 906 EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference); 907 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace); 908 909 Tokens = 910 annotate("foo(requires(const typename Outer<T>::Inner * const t) {});"); 911 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 912 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 913 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 914 EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference); 915 EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace); 916 917 Tokens = annotate("template <typename T>\n" 918 "concept C = requires(T T) {\n" 919 " requires Bar<T> && Foo<T>;\n" 920 "};"); 921 ASSERT_EQ(Tokens.size(), 28u) << Tokens; 922 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 923 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 924 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 925 EXPECT_TOKEN(Tokens[14], tok::kw_requires, 926 TT_RequiresClauseInARequiresExpression); 927 928 Tokens = annotate("template <typename T>\n" 929 "concept C = requires(T T) {\n" 930 " { t.func() } -> std::same_as<int>;" 931 " requires Bar<T> && Foo<T>;\n" 932 "};"); 933 ASSERT_EQ(Tokens.size(), 43u) << Tokens; 934 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 935 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 936 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 937 EXPECT_TOKEN(Tokens[29], tok::kw_requires, 938 TT_RequiresClauseInARequiresExpression); 939 940 // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350. 941 Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { " 942 "requires true; };"); 943 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 944 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 945 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 946 EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace); 947 } 948 949 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) { 950 // Everything after #pragma region should be ImplicitStringLiteral 951 auto Tokens = annotate("#pragma region Foo(Bar: Hello)"); 952 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 953 EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral); 954 EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral); 955 EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral); 956 957 // Make sure it's annotated correctly inside a function as well 958 Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}"); 959 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 960 EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral); 961 EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral); 962 EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral); 963 } 964 965 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) { 966 const char *BaseCode = nullptr; 967 const char *ConstrainedCode = nullptr; 968 auto BaseTokenCount = 0u; 969 auto RequiresTokenCount = 0u; 970 auto PrefixTokenCount = 0u; 971 972 auto TestRequires = [&](int Line) { 973 const auto BaseTokens = annotate(BaseCode); 974 const auto ConstrainedTokens = annotate(ConstrainedCode); 975 976 #define LINE " (Line " << Line << ')' 977 978 ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE; 979 ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount) 980 << LINE; 981 982 for (auto I = 0u; I < BaseTokenCount; ++I) { 983 EXPECT_EQ( 984 *BaseTokens[I], 985 *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount]) 986 << I << LINE; 987 } 988 989 #undef LINE 990 }; 991 992 BaseCode = "template<typename T>\n" 993 "T Pi = 3.14;"; 994 ConstrainedCode = "template<typename T>\n" 995 " requires Foo<T>\n" 996 "T Pi = 3.14;"; 997 BaseTokenCount = 11; 998 RequiresTokenCount = 5; 999 PrefixTokenCount = 5; 1000 TestRequires(__LINE__); 1001 1002 BaseCode = "template<typename T>\n" 1003 "struct Bar;"; 1004 ConstrainedCode = "template<typename T>\n" 1005 " requires Foo<T>\n" 1006 "struct Bar;"; 1007 BaseTokenCount = 9; 1008 TestRequires(__LINE__); 1009 1010 BaseCode = "template<typename T>\n" 1011 "struct Bar {\n" 1012 " T foo();\n" 1013 " T bar();\n" 1014 "};"; 1015 ConstrainedCode = "template<typename T>\n" 1016 " requires Foo<T>\n" 1017 "struct Bar {\n" 1018 " T foo();\n" 1019 " T bar();\n" 1020 "};"; 1021 BaseTokenCount = 21; 1022 TestRequires(__LINE__); 1023 1024 BaseCode = "template<typename T>\n" 1025 "Bar(T) -> Bar<T>;"; 1026 ConstrainedCode = "template<typename T>\n" 1027 " requires Foo<T>\n" 1028 "Bar(T) -> Bar<T>;"; 1029 BaseTokenCount = 16; 1030 TestRequires(__LINE__); 1031 1032 BaseCode = "template<typename T>\n" 1033 "T foo();"; 1034 ConstrainedCode = "template<typename T>\n" 1035 " requires Foo<T>\n" 1036 "T foo();"; 1037 BaseTokenCount = 11; 1038 TestRequires(__LINE__); 1039 1040 BaseCode = "template<typename T>\n" 1041 "T foo() {\n" 1042 " auto bar = baz();\n" 1043 " return bar + T{};\n" 1044 "}"; 1045 ConstrainedCode = "template<typename T>\n" 1046 " requires Foo<T>\n" 1047 "T foo() {\n" 1048 " auto bar = baz();\n" 1049 " return bar + T{};\n" 1050 "}"; 1051 BaseTokenCount = 26; 1052 TestRequires(__LINE__); 1053 1054 BaseCode = "template<typename T>\n" 1055 "T foo();"; 1056 ConstrainedCode = "template<typename T>\n" 1057 "T foo() requires Foo<T>;"; 1058 BaseTokenCount = 11; 1059 PrefixTokenCount = 9; 1060 TestRequires(__LINE__); 1061 1062 BaseCode = "template<typename T>\n" 1063 "T foo() {\n" 1064 " auto bar = baz();\n" 1065 " return bar + T{};\n" 1066 "}"; 1067 ConstrainedCode = "template<typename T>\n" 1068 "T foo() requires Foo<T> {\n" 1069 " auto bar = baz();\n" 1070 " return bar + T{};\n" 1071 "}"; 1072 BaseTokenCount = 26; 1073 TestRequires(__LINE__); 1074 1075 BaseCode = "template<typename T>\n" 1076 "T foo();"; 1077 ConstrainedCode = "template<typename T>\n" 1078 " requires(Foo<T>)\n" 1079 "T foo();"; 1080 BaseTokenCount = 11; 1081 RequiresTokenCount = 7; 1082 PrefixTokenCount = 5; 1083 TestRequires(__LINE__); 1084 1085 BaseCode = "template<typename T>\n" 1086 "Bar(T) -> Bar<typename T::I>;"; 1087 ConstrainedCode = "template<typename T>\n" 1088 " requires requires(T &&t) {\n" 1089 " typename T::I;\n" 1090 " }\n" 1091 "Bar(T) -> Bar<typename T::I>;"; 1092 BaseTokenCount = 19; 1093 RequiresTokenCount = 14; 1094 PrefixTokenCount = 5; 1095 TestRequires(__LINE__); 1096 1097 BaseCode = "struct [[nodiscard]] zero_t {\n" 1098 " template<class T>\n" 1099 " [[nodiscard]] constexpr operator T() const { return v<T>; }\n" 1100 "};"; 1101 ConstrainedCode = 1102 "struct [[nodiscard]] zero_t {\n" 1103 " template<class T>\n" 1104 " requires requires { v<T>; }\n" 1105 " [[nodiscard]] constexpr operator T() const { return v<T>; }\n" 1106 "};"; 1107 BaseTokenCount = 35; 1108 RequiresTokenCount = 9; 1109 PrefixTokenCount = 13; 1110 TestRequires(__LINE__); 1111 1112 BaseCode = "constexpr Foo(Foo const &other)\n" 1113 " : value{other.value} {\n" 1114 " do_magic();\n" 1115 " do_more_magic();\n" 1116 "}"; 1117 ConstrainedCode = "constexpr Foo(Foo const &other)\n" 1118 " requires std::is_copy_constructible<T>\n" 1119 " : value{other.value} {\n" 1120 " do_magic();\n" 1121 " do_more_magic();\n" 1122 "}"; 1123 BaseTokenCount = 26; 1124 RequiresTokenCount = 7; 1125 PrefixTokenCount = 8; 1126 TestRequires(__LINE__); 1127 1128 BaseCode = "constexpr Foo(Foo const &other)\n" 1129 " : value{other.value} {\n" 1130 " do_magic();\n" 1131 " do_more_magic();\n" 1132 "}"; 1133 ConstrainedCode = "constexpr Foo(Foo const &other)\n" 1134 " requires (std::is_copy_constructible<T>)\n" 1135 " : value{other.value} {\n" 1136 " do_magic();\n" 1137 " do_more_magic();\n" 1138 "}"; 1139 RequiresTokenCount = 9; 1140 TestRequires(__LINE__); 1141 } 1142 1143 TEST_F(TokenAnnotatorTest, UnderstandsAsm) { 1144 auto Tokens = annotate("__asm{\n" 1145 "a:\n" 1146 "};"); 1147 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 1148 EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown); 1149 EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace); 1150 EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace); 1151 } 1152 1153 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) { 1154 auto Tokens = annotate("int (^)() = ^ ()\n" 1155 " external_source_symbol() { //\n" 1156 " return 1;\n" 1157 "};"); 1158 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 1159 EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen); 1160 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace); 1161 1162 Tokens = annotate("int *p = ^int*(){ //\n" 1163 " return nullptr;\n" 1164 "}();"); 1165 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 1166 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace); 1167 } 1168 1169 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) { 1170 auto Tokens = annotate("[]() constexpr {}"); 1171 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 1172 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1173 EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace); 1174 1175 Tokens = annotate("[]() consteval {}"); 1176 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 1177 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1178 EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace); 1179 1180 Tokens = annotate("[]() mutable {}"); 1181 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 1182 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1183 EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace); 1184 1185 Tokens = annotate("[]() static {}"); 1186 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 1187 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1188 EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace); 1189 1190 Tokens = annotate("[]() -> auto {}"); 1191 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 1192 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1193 EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow); 1194 EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace); 1195 1196 Tokens = annotate("[]() -> auto & {}"); 1197 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 1198 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1199 EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow); 1200 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 1201 1202 Tokens = annotate("[]() -> auto * {}"); 1203 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 1204 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1205 EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow); 1206 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 1207 1208 Tokens = annotate("[] {}"); 1209 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 1210 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1211 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace); 1212 1213 Tokens = annotate("[] noexcept {}"); 1214 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 1215 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1216 EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace); 1217 1218 Tokens = annotate("[] -> auto {}"); 1219 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 1220 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1221 EXPECT_TOKEN(Tokens[2], tok::arrow, TT_LambdaArrow); 1222 EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace); 1223 1224 Tokens = annotate("[] <typename T> () {}"); 1225 ASSERT_EQ(Tokens.size(), 11u) << Tokens; 1226 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1227 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 1228 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace); 1229 1230 Tokens = annotate("[] <typename T> {}"); 1231 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 1232 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1233 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 1234 EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace); 1235 1236 Tokens = annotate("[] <typename... T> () {}"); 1237 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 1238 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1239 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 1240 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace); 1241 1242 Tokens = annotate("[] <typename... T> {}"); 1243 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 1244 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1245 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 1246 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 1247 1248 Tokens = annotate("[] <int... T> () {}"); 1249 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 1250 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1251 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 1252 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace); 1253 1254 Tokens = annotate("[] <int... T> {}"); 1255 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 1256 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1257 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 1258 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 1259 1260 Tokens = annotate("[] <Foo... T> () {}"); 1261 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 1262 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1263 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 1264 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace); 1265 1266 Tokens = annotate("[] <Foo... T> {}"); 1267 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 1268 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 1269 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 1270 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 1271 } 1272 1273 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) { 1274 auto Tokens = annotate("template <typename T>\n" 1275 "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n" 1276 "string OldFunction(const string ¶meter) {}"); 1277 ASSERT_EQ(Tokens.size(), 20u) << Tokens; 1278 EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen); 1279 1280 Tokens = annotate("template <typename T>\n" 1281 "A(T) noexcept;"); 1282 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 1283 EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown); 1284 } 1285 1286 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) { 1287 auto Tokens = annotate("void f [[noreturn]] ();"); 1288 ASSERT_EQ(Tokens.size(), 11u) << Tokens; 1289 EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName); 1290 1291 Tokens = annotate("void f [[noreturn]] () {}"); 1292 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 1293 EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName); 1294 } 1295 1296 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) { 1297 auto Tokens = annotate("_Generic(x, int: 1, default: 0)"); 1298 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 1299 EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown); 1300 EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon); 1301 EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon); 1302 } 1303 1304 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) { 1305 auto Annotate = [this](llvm::StringRef Code) { 1306 return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog)); 1307 }; 1308 // Test that unary operators get labeled as such and that operators like '++' 1309 // don't get split. 1310 tok::TokenKind Unary[] = {tok::plus, tok::minus, tok::exclaim, 1311 tok::tilde, tok::amp, tok::pipe, 1312 tok::caret, tok::plusplus, tok::minusminus}; 1313 for (auto Kind : Unary) { 1314 auto Tokens = 1315 Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;"); 1316 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 1317 EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator); 1318 } 1319 // Operators formed by joining two operators like '^~'. For some of these 1320 // joined operators, we don't have a separate type, so we only test for their 1321 // precedence. 1322 std::pair<prec::Level, std::string> JoinedBinary[] = { 1323 {prec::Comma, "<->"}, {prec::Assignment, "+="}, 1324 {prec::Assignment, "-="}, {prec::Assignment, "*="}, 1325 {prec::Assignment, "/="}, {prec::Assignment, "%="}, 1326 {prec::Assignment, "&="}, {prec::Assignment, "^="}, 1327 {prec::Assignment, "<<="}, {prec::Assignment, ">>="}, 1328 {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="}, 1329 {prec::LogicalOr, "||"}, {prec::LogicalAnd, "&&"}, 1330 {prec::Equality, "=="}, {prec::Equality, "!="}, 1331 {prec::Equality, "==="}, {prec::Equality, "!=="}, 1332 {prec::Equality, "==?"}, {prec::Equality, "!=?"}, 1333 {prec::ExclusiveOr, "~^"}, {prec::ExclusiveOr, "^~"}, 1334 }; 1335 for (auto Operator : JoinedBinary) { 1336 auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;"); 1337 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 1338 EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator); 1339 EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first); 1340 } 1341 // '~^' and '^~' can be unary as well as binary operators. 1342 auto Tokens = Annotate("x = ~^x;"); 1343 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 1344 EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator); 1345 Tokens = Annotate("x = ^~x;"); 1346 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 1347 EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator); 1348 // The unary operators '~&' and '~|' can only be unary operators. The current 1349 // implementation treats each of them as separate unary '~' and '&' or '|' 1350 // operators, which is enough for formatting purposes. In FormatTestVerilog, 1351 // there is a test that there is no space in between. And even if a new line 1352 // is inserted between the '~' and '|', the semantic meaning is the same as 1353 // the joined operator, so the CanBreakBefore property doesn't need to be 1354 // false for the second operator. 1355 Tokens = Annotate("x = ~&x;"); 1356 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 1357 EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator); 1358 EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator); 1359 Tokens = Annotate("x = ~|x;"); 1360 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 1361 EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator); 1362 EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator); 1363 // Test for block label colons. 1364 Tokens = Annotate("begin : x\n" 1365 "end : x"); 1366 ASSERT_EQ(Tokens.size(), 7u); 1367 EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon); 1368 EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon); 1369 // Test that the dimension colon is annotated correctly. 1370 Tokens = Annotate("var [1 : 0] x;"); 1371 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 1372 EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon); 1373 Tokens = Annotate("extern function [1 : 0] x;"); 1374 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 1375 EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon); 1376 // Test case labels and ternary operators. 1377 Tokens = Annotate("case (x)\n" 1378 " x:\n" 1379 " x;\n" 1380 "endcase\n"); 1381 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 1382 EXPECT_TOKEN(Tokens[5], tok::colon, TT_GotoLabelColon); 1383 Tokens = Annotate("case (x)\n" 1384 " x ? x : x:\n" 1385 " x;\n" 1386 "endcase\n"); 1387 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 1388 EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr); 1389 EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr); 1390 EXPECT_TOKEN(Tokens[9], tok::colon, TT_GotoLabelColon); 1391 // Non-blocking assignments. 1392 Tokens = Annotate("a <= b;"); 1393 ASSERT_EQ(Tokens.size(), 5u); 1394 EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator); 1395 EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment); 1396 Tokens = Annotate("if (a <= b) break;"); 1397 ASSERT_EQ(Tokens.size(), 9u); 1398 EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator); 1399 EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational); 1400 Tokens = Annotate("a <= b <= a;"); 1401 ASSERT_EQ(Tokens.size(), 7u); 1402 EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator); 1403 EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment); 1404 EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator); 1405 EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational); 1406 } 1407 1408 TEST_F(TokenAnnotatorTest, UnderstandConstructors) { 1409 auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}"); 1410 1411 // The TT_Unknown is clearly not binding for the future, please adapt if those 1412 // tokens get annotated. 1413 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 1414 EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon); 1415 EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown); 1416 EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown); 1417 EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown); 1418 EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma); 1419 EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown); 1420 EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown); 1421 EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown); 1422 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace); 1423 1424 Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}"); 1425 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 1426 EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon); 1427 EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown); 1428 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown); 1429 EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown); 1430 EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma); 1431 EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown); 1432 EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown); 1433 EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown); 1434 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace); 1435 } 1436 1437 } // namespace 1438 } // namespace format 1439 } // namespace clang 1440