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 136 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) { 137 auto Tokens = annotate("x - 0"); 138 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 139 EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator); 140 Tokens = annotate("0 + 0"); 141 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 142 EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator); 143 Tokens = annotate("x + +0"); 144 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 145 EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator); 146 Tokens = annotate("x ? -0 : +0"); 147 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 148 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 149 EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator); 150 Tokens = annotate("(-0)"); 151 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 152 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 153 Tokens = annotate("0, -0"); 154 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 155 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 156 Tokens = annotate("for (; -1;) {\n}"); 157 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 158 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 159 Tokens = annotate("x = -1;"); 160 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 161 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 162 Tokens = annotate("x[-1]"); 163 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 164 EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator); 165 Tokens = annotate("x = {-1};"); 166 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 167 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 168 Tokens = annotate("case -x:"); 169 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 170 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 171 Tokens = annotate("co_await -x;"); 172 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 173 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 174 Tokens = annotate("co_return -x;"); 175 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 176 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 177 Tokens = annotate("co_yield -x;"); 178 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 179 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 180 Tokens = annotate("delete -x;"); 181 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 182 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 183 Tokens = annotate("return -x;"); 184 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 185 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 186 Tokens = annotate("throw -x;"); 187 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 188 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 189 Tokens = annotate("sizeof -x"); 190 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 191 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 192 Tokens = annotate("co_await +x;"); 193 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 194 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 195 Tokens = annotate("co_return +x;"); 196 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 197 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 198 Tokens = annotate("co_yield +x;"); 199 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 200 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 201 Tokens = annotate("delete +x;"); 202 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 203 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 204 Tokens = annotate("return +x;"); 205 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 206 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 207 Tokens = annotate("throw +x;"); 208 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 209 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 210 Tokens = annotate("sizeof +x"); 211 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 212 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 213 Tokens = annotate("(int)-x"); 214 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 215 EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator); 216 Tokens = annotate("(-x)"); 217 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 218 EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator); 219 Tokens = annotate("!+x"); 220 ASSERT_EQ(Tokens.size(), 4u) << Tokens; 221 EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator); 222 EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator); 223 } 224 225 TEST_F(TokenAnnotatorTest, UnderstandsClasses) { 226 auto Tokens = annotate("class C {};"); 227 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 228 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace); 229 230 Tokens = annotate("const class C {} c;"); 231 EXPECT_EQ(Tokens.size(), 8u) << Tokens; 232 EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace); 233 234 Tokens = annotate("const class {} c;"); 235 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 236 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace); 237 } 238 239 TEST_F(TokenAnnotatorTest, UnderstandsStructs) { 240 auto Tokens = annotate("struct S {};"); 241 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 242 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace); 243 } 244 245 TEST_F(TokenAnnotatorTest, UnderstandsUnions) { 246 auto Tokens = annotate("union U {};"); 247 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 248 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace); 249 250 Tokens = annotate("union U { void f() { return; } };"); 251 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 252 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace); 253 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace); 254 } 255 256 TEST_F(TokenAnnotatorTest, UnderstandsEnums) { 257 auto Tokens = annotate("enum E {};"); 258 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 259 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace); 260 } 261 262 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) { 263 auto Tokens = annotate("auto operator<=>(const T &) const & = default;"); 264 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 265 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 266 267 Tokens = annotate("template <typename T> void F(T) && = delete;"); 268 EXPECT_EQ(Tokens.size(), 15u) << Tokens; 269 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference); 270 } 271 272 TEST_F(TokenAnnotatorTest, UnderstandsVariables) { 273 auto Tokens = 274 annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;"); 275 EXPECT_EQ(Tokens.size(), 15u) << Tokens; 276 EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator); 277 } 278 279 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) { 280 auto Tokens = 281 annotate("template <typename T> " 282 "inline bool var = is_integral_v<int> && is_signed_v<int>;"); 283 EXPECT_EQ(Tokens.size(), 20u) << Tokens; 284 EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator); 285 } 286 287 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) { 288 auto Tokens = 289 annotate("#define FOO(typeName) \\\n" 290 " { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }"); 291 ASSERT_EQ(Tokens.size(), 27u) << Tokens; 292 EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener); 293 EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser); 294 EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener); 295 EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser); 296 } 297 298 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) { 299 FormatStyle Style = getLLVMStyle(); 300 Style.WhitespaceSensitiveMacros.push_back("FOO"); 301 302 auto Tokens = annotate("FOO(1+2 )\n", Style); 303 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 304 EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc); 305 306 Tokens = annotate("FOO(a:b:c)\n", Style); 307 EXPECT_EQ(Tokens.size(), 9u) << Tokens; 308 EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc); 309 } 310 311 TEST_F(TokenAnnotatorTest, UnderstandsDelete) { 312 auto Tokens = annotate("delete (void *)p;"); 313 EXPECT_EQ(Tokens.size(), 8u) << Tokens; 314 EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen); 315 316 Tokens = annotate("delete[] (void *)p;"); 317 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 318 EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen); 319 320 Tokens = annotate("delete[] /*comment*/ (void *)p;"); 321 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 322 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 323 324 Tokens = annotate("delete[/*comment*/] (void *)p;"); 325 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 326 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 327 328 Tokens = annotate("delete/*comment*/[] (void *)p;"); 329 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 330 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 331 } 332 333 TEST_F(TokenAnnotatorTest, UnderstandsCasts) { 334 auto Tokens = annotate("(void)p;"); 335 EXPECT_EQ(Tokens.size(), 6u) << Tokens; 336 EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen); 337 338 Tokens = annotate("auto x = (Foo)p;"); 339 EXPECT_EQ(Tokens.size(), 9u) << Tokens; 340 EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen); 341 342 Tokens = annotate("(std::vector<int>)p;"); 343 EXPECT_EQ(Tokens.size(), 11u) << Tokens; 344 EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen); 345 346 Tokens = annotate("return (Foo)p;"); 347 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 348 EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen); 349 350 Tokens = annotate("throw (Foo)p;"); 351 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 352 EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen); 353 } 354 355 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) { 356 auto Tokens = annotate("void f() throw(int);"); 357 EXPECT_EQ(Tokens.size(), 10u) << Tokens; 358 EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown); 359 } 360 361 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) { 362 auto Tokens = annotate("void f() &;"); 363 EXPECT_EQ(Tokens.size(), 7u) << Tokens; 364 EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference); 365 366 Tokens = annotate("void operator=(T) &&;"); 367 EXPECT_EQ(Tokens.size(), 9u) << Tokens; 368 EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference); 369 370 Tokens = annotate("template <typename T> void f() &;"); 371 EXPECT_EQ(Tokens.size(), 12u) << Tokens; 372 EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference); 373 374 Tokens = annotate("template <typename T> void operator=(T) &;"); 375 EXPECT_EQ(Tokens.size(), 14u) << Tokens; 376 EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference); 377 } 378 379 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) { 380 auto Tokens = annotate("template <typename T>\n" 381 "concept C = (Foo && Bar) && (Bar && Baz);"); 382 383 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 384 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 385 EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator); 386 EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator); 387 388 Tokens = annotate("template <typename T>\n" 389 "concept C = Foo && !Bar;"); 390 391 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 392 EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator); 393 EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator); 394 395 Tokens = annotate("template <typename T>\n" 396 "concept C = requires(T t) {\n" 397 " { t.foo() };\n" 398 "} && Bar<T> && Baz<T>;"); 399 ASSERT_EQ(Tokens.size(), 35u) << Tokens; 400 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 401 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 402 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 403 EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator); 404 EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator); 405 406 Tokens = annotate("template<typename T>\n" 407 "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n" 408 "struct Foo;"); 409 ASSERT_EQ(Tokens.size(), 36u) << Tokens; 410 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 411 EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown); 412 EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u); 413 EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator); 414 EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator); 415 EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator); 416 EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator); 417 EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser); 418 EXPECT_EQ(Tokens[31]->FakeRParens, 1u); 419 EXPECT_TRUE(Tokens[31]->ClosesRequiresClause); 420 421 Tokens = 422 annotate("template<typename T>\n" 423 "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n" 424 "struct Foo;"); 425 ASSERT_EQ(Tokens.size(), 38u) << Tokens; 426 EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause); 427 EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown); 428 EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u); 429 EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator); 430 EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator); 431 EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator); 432 EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator); 433 EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser); 434 EXPECT_EQ(Tokens[32]->FakeRParens, 1u); 435 EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown); 436 EXPECT_TRUE(Tokens[33]->ClosesRequiresClause); 437 438 Tokens = annotate("template <typename T>\n" 439 "void foo(T) noexcept requires Bar<T>;"); 440 ASSERT_EQ(Tokens.size(), 18u) << Tokens; 441 EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause); 442 443 Tokens = annotate("template <typename T>\n" 444 "struct S {\n" 445 " void foo() const requires Bar<T>;\n" 446 " void bar() const & requires Baz<T>;\n" 447 " void bar() && requires Baz2<T>;\n" 448 " void baz() const & noexcept requires Baz<T>;\n" 449 " void baz() && noexcept requires Baz2<T>;\n" 450 "};\n" 451 "\n" 452 "void S::bar() const & requires Baz<T> { }"); 453 ASSERT_EQ(Tokens.size(), 85u) << Tokens; 454 EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause); 455 EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause); 456 EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause); 457 EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause); 458 EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause); 459 EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause); 460 461 Tokens = annotate("void Class::member() && requires(Constant) {}"); 462 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 463 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 464 465 Tokens = annotate("void Class::member() && requires(Constant<T>) {}"); 466 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 467 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 468 469 Tokens = 470 annotate("void Class::member() && requires(Namespace::Constant<T>) {}"); 471 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 472 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 473 474 Tokens = annotate("void Class::member() && requires(typename " 475 "Namespace::Outer<T>::Inner::Constant) {}"); 476 ASSERT_EQ(Tokens.size(), 24u) << Tokens; 477 EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause); 478 479 Tokens = annotate("struct [[nodiscard]] zero_t {\n" 480 " template<class T>\n" 481 " requires requires { number_zero_v<T>; }\n" 482 " [[nodiscard]] constexpr operator T() const { " 483 "return number_zero_v<T>; }\n" 484 "};"); 485 ASSERT_EQ(Tokens.size(), 44u); 486 EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause); 487 EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression); 488 EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace); 489 EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown); 490 EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]); 491 EXPECT_TRUE(Tokens[21]->ClosesRequiresClause); 492 493 Tokens = 494 annotate("template <class A, class B> concept C =" 495 "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;"); 496 ASSERT_EQ(Tokens.size(), 31u) << Tokens; 497 EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown); 498 EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener); 499 EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener); 500 EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser); 501 EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener); 502 EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser); 503 EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser); 504 505 Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}"); 506 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 507 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 508 509 Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}"); 510 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 511 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 512 513 Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}"); 514 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 515 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 516 517 Tokens = 518 annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}"); 519 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 520 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause); 521 522 Tokens = 523 annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}"); 524 ASSERT_EQ(Tokens.size(), 18u) << Tokens; 525 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause); 526 527 Tokens = 528 annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}"); 529 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 530 EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause); 531 } 532 533 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) { 534 auto Tokens = annotate("bool b = requires(int i) { i + 5; };"); 535 ASSERT_EQ(Tokens.size(), 16u) << Tokens; 536 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 537 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 538 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 539 540 Tokens = annotate("if (requires(int i) { i + 5; }) return;"); 541 ASSERT_EQ(Tokens.size(), 17u) << Tokens; 542 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 543 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 544 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace); 545 546 Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;"); 547 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 548 EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression); 549 EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen); 550 EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace); 551 552 Tokens = annotate("foo(requires(const T t) {});"); 553 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 554 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 555 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 556 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 557 558 Tokens = annotate("foo(requires(const int t) {});"); 559 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 560 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 561 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 562 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 563 564 Tokens = annotate("foo(requires(const T t) {});"); 565 ASSERT_EQ(Tokens.size(), 13u) << Tokens; 566 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 567 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 568 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace); 569 570 Tokens = annotate("foo(requires(int const* volatile t) {});"); 571 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 572 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 573 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 574 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 575 576 Tokens = annotate("foo(requires(T const* volatile t) {});"); 577 ASSERT_EQ(Tokens.size(), 15u) << Tokens; 578 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 579 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 580 EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace); 581 582 Tokens = 583 annotate("foo(requires(const typename Outer<T>::Inner * const t) {});"); 584 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 585 EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression); 586 EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen); 587 EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace); 588 589 Tokens = annotate("template <typename T>\n" 590 "concept C = requires(T T) {\n" 591 " requires Bar<T> && Foo<T>;\n" 592 "};"); 593 ASSERT_EQ(Tokens.size(), 28u) << Tokens; 594 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 595 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 596 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 597 EXPECT_TOKEN(Tokens[14], tok::kw_requires, 598 TT_RequiresClauseInARequiresExpression); 599 600 Tokens = annotate("template <typename T>\n" 601 "concept C = requires(T T) {\n" 602 " { t.func() } -> std::same_as<int>;" 603 " requires Bar<T> && Foo<T>;\n" 604 "};"); 605 ASSERT_EQ(Tokens.size(), 43u) << Tokens; 606 EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression); 607 EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen); 608 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace); 609 EXPECT_TOKEN(Tokens[29], tok::kw_requires, 610 TT_RequiresClauseInARequiresExpression); 611 612 // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350. 613 Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { " 614 "requires true; };"); 615 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 616 EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression); 617 EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen); 618 EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace); 619 } 620 621 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) { 622 const char *BaseCode = nullptr; 623 const char *ConstrainedCode = nullptr; 624 auto BaseTokenCount = 0u; 625 auto RequiresTokenCount = 0u; 626 auto PrefixTokenCount = 0u; 627 628 auto TestRequires = [&](int Line) { 629 const auto BaseTokens = annotate(BaseCode); 630 const auto ConstrainedTokens = annotate(ConstrainedCode); 631 632 #define LINE " (Line " << Line << ')' 633 634 ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE; 635 ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount) 636 << LINE; 637 638 for (auto I = 0u; I < BaseTokenCount; ++I) { 639 EXPECT_EQ( 640 *BaseTokens[I], 641 *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount]) 642 << I << LINE; 643 } 644 645 #undef LINE 646 }; 647 648 BaseCode = "template<typename T>\n" 649 "T Pi = 3.14;"; 650 ConstrainedCode = "template<typename T>\n" 651 " requires Foo<T>\n" 652 "T Pi = 3.14;"; 653 BaseTokenCount = 11; 654 RequiresTokenCount = 5; 655 PrefixTokenCount = 5; 656 TestRequires(__LINE__); 657 658 BaseCode = "template<typename T>\n" 659 "struct Bar;"; 660 ConstrainedCode = "template<typename T>\n" 661 " requires Foo<T>\n" 662 "struct Bar;"; 663 BaseTokenCount = 9; 664 TestRequires(__LINE__); 665 666 BaseCode = "template<typename T>\n" 667 "struct Bar {\n" 668 " T foo();\n" 669 " T bar();\n" 670 "};"; 671 ConstrainedCode = "template<typename T>\n" 672 " requires Foo<T>\n" 673 "struct Bar {\n" 674 " T foo();\n" 675 " T bar();\n" 676 "};"; 677 BaseTokenCount = 21; 678 TestRequires(__LINE__); 679 680 BaseCode = "template<typename T>\n" 681 "Bar(T) -> Bar<T>;"; 682 ConstrainedCode = "template<typename T>\n" 683 " requires Foo<T>\n" 684 "Bar(T) -> Bar<T>;"; 685 BaseTokenCount = 16; 686 TestRequires(__LINE__); 687 688 BaseCode = "template<typename T>\n" 689 "T foo();"; 690 ConstrainedCode = "template<typename T>\n" 691 " requires Foo<T>\n" 692 "T foo();"; 693 BaseTokenCount = 11; 694 TestRequires(__LINE__); 695 696 BaseCode = "template<typename T>\n" 697 "T foo() {\n" 698 " auto bar = baz();\n" 699 " return bar + T{};\n" 700 "}"; 701 ConstrainedCode = "template<typename T>\n" 702 " requires Foo<T>\n" 703 "T foo() {\n" 704 " auto bar = baz();\n" 705 " return bar + T{};\n" 706 "}"; 707 BaseTokenCount = 26; 708 TestRequires(__LINE__); 709 710 BaseCode = "template<typename T>\n" 711 "T foo();"; 712 ConstrainedCode = "template<typename T>\n" 713 "T foo() requires Foo<T>;"; 714 BaseTokenCount = 11; 715 PrefixTokenCount = 9; 716 TestRequires(__LINE__); 717 718 BaseCode = "template<typename T>\n" 719 "T foo() {\n" 720 " auto bar = baz();\n" 721 " return bar + T{};\n" 722 "}"; 723 ConstrainedCode = "template<typename T>\n" 724 "T foo() requires Foo<T> {\n" 725 " auto bar = baz();\n" 726 " return bar + T{};\n" 727 "}"; 728 BaseTokenCount = 26; 729 TestRequires(__LINE__); 730 731 BaseCode = "template<typename T>\n" 732 "Bar(T) -> Bar<typename T::I>;"; 733 ConstrainedCode = "template<typename T>\n" 734 " requires requires(T &&t) {\n" 735 " typename T::I;\n" 736 " }\n" 737 "Bar(T) -> Bar<typename T::I>;"; 738 BaseTokenCount = 19; 739 RequiresTokenCount = 14; 740 PrefixTokenCount = 5; 741 TestRequires(__LINE__); 742 743 BaseCode = "struct [[nodiscard]] zero_t {\n" 744 " template<class T>\n" 745 " [[nodiscard]] constexpr operator T() const { return v<T>; }\n" 746 "};"; 747 ConstrainedCode = 748 "struct [[nodiscard]] zero_t {\n" 749 " template<class T>\n" 750 " requires requires { v<T>; }\n" 751 " [[nodiscard]] constexpr operator T() const { return v<T>; }\n" 752 "};"; 753 BaseTokenCount = 35; 754 RequiresTokenCount = 9; 755 PrefixTokenCount = 13; 756 TestRequires(__LINE__); 757 758 BaseCode = "constexpr Foo(Foo const &other)\n" 759 " : value{other.value} {\n" 760 " do_magic();\n" 761 " do_more_magic();\n" 762 "}"; 763 ConstrainedCode = "constexpr Foo(Foo const &other)\n" 764 " requires std::is_copy_constructible<T>\n" 765 " : value{other.value} {\n" 766 " do_magic();\n" 767 " do_more_magic();\n" 768 "}"; 769 BaseTokenCount = 26; 770 RequiresTokenCount = 7; 771 PrefixTokenCount = 8; 772 TestRequires(__LINE__); 773 774 BaseCode = "constexpr Foo(Foo const &other)\n" 775 " : value{other.value} {\n" 776 " do_magic();\n" 777 " do_more_magic();\n" 778 "}"; 779 ConstrainedCode = "constexpr Foo(Foo const &other)\n" 780 " requires (std::is_copy_constructible<T>)\n" 781 " : value{other.value} {\n" 782 " do_magic();\n" 783 " do_more_magic();\n" 784 "}"; 785 RequiresTokenCount = 9; 786 TestRequires(__LINE__); 787 } 788 789 TEST_F(TokenAnnotatorTest, UnderstandsAsm) { 790 auto Tokens = annotate("__asm{\n" 791 "a:\n" 792 "};"); 793 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 794 EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown); 795 EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace); 796 EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace); 797 } 798 799 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) { 800 auto Tokens = annotate("int (^)() = ^ ()\n" 801 " external_source_symbol() { //\n" 802 " return 1;\n" 803 "};"); 804 ASSERT_EQ(Tokens.size(), 21u) << Tokens; 805 EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen); 806 EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace); 807 808 Tokens = annotate("int *p = ^int*(){ //\n" 809 " return nullptr;\n" 810 "}();"); 811 ASSERT_EQ(Tokens.size(), 19u) << Tokens; 812 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace); 813 } 814 815 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) { 816 auto Tokens = annotate("[]() constexpr {}"); 817 ASSERT_EQ(Tokens.size(), 8u) << Tokens; 818 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 819 EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace); 820 821 Tokens = annotate("[]() -> auto {}"); 822 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 823 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 824 EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow); 825 EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace); 826 827 Tokens = annotate("[]() -> auto & {}"); 828 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 829 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 830 EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow); 831 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 832 833 Tokens = annotate("[]() -> auto * {}"); 834 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 835 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 836 EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow); 837 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 838 839 Tokens = annotate("[] {}"); 840 ASSERT_EQ(Tokens.size(), 5u) << Tokens; 841 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 842 EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace); 843 844 Tokens = annotate("[] noexcept {}"); 845 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 846 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 847 EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace); 848 849 Tokens = annotate("[] -> auto {}"); 850 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 851 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 852 EXPECT_TOKEN(Tokens[2], tok::arrow, TT_LambdaArrow); 853 EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace); 854 855 Tokens = annotate("[] <typename T> () {}"); 856 ASSERT_EQ(Tokens.size(), 11u) << Tokens; 857 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 858 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 859 EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace); 860 861 Tokens = annotate("[] <typename T> {}"); 862 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 863 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 864 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 865 EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace); 866 867 Tokens = annotate("[] <typename... T> () {}"); 868 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 869 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 870 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 871 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace); 872 873 Tokens = annotate("[] <typename... T> {}"); 874 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 875 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 876 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 877 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 878 879 Tokens = annotate("[] <int... T> () {}"); 880 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 881 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 882 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 883 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace); 884 885 Tokens = annotate("[] <int... T> {}"); 886 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 887 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 888 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 889 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 890 891 Tokens = annotate("[] <Foo... T> () {}"); 892 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 893 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 894 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 895 EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace); 896 897 Tokens = annotate("[] <Foo... T> {}"); 898 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 899 EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare); 900 EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener); 901 EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace); 902 } 903 904 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) { 905 auto Tokens = annotate("template <typename T>\n" 906 "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n" 907 "string OldFunction(const string ¶meter) {}"); 908 ASSERT_EQ(Tokens.size(), 20u) << Tokens; 909 EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen); 910 911 Tokens = annotate("template <typename T>\n" 912 "A(T) noexcept;"); 913 ASSERT_EQ(Tokens.size(), 12u) << Tokens; 914 EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown); 915 } 916 917 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) { 918 auto Annotate = [this](llvm::StringRef Code) { 919 return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog)); 920 }; 921 // Test that unary operators get labeled as such and that operators like '++' 922 // don't get split. 923 tok::TokenKind Unary[] = {tok::plus, tok::minus, tok::exclaim, 924 tok::tilde, tok::amp, tok::pipe, 925 tok::caret, tok::plusplus, tok::minusminus}; 926 for (auto Kind : Unary) { 927 auto Tokens = 928 Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;"); 929 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 930 EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator); 931 } 932 // Operators formed by joining two operators like '^~'. For some of these 933 // joined operators, we don't have a separate type, so we only test for their 934 // precedence. 935 std::pair<prec::Level, std::string> JoinedBinary[] = { 936 {prec::Comma, "<->"}, {prec::Assignment, "+="}, 937 {prec::Assignment, "-="}, {prec::Assignment, "*="}, 938 {prec::Assignment, "/="}, {prec::Assignment, "%="}, 939 {prec::Assignment, "&="}, {prec::Assignment, "^="}, 940 {prec::Assignment, "<<="}, {prec::Assignment, ">>="}, 941 {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="}, 942 {prec::LogicalOr, "||"}, {prec::LogicalAnd, "&&"}, 943 {prec::Equality, "=="}, {prec::Equality, "!="}, 944 {prec::Equality, "==="}, {prec::Equality, "!=="}, 945 {prec::Equality, "==?"}, {prec::Equality, "!=?"}, 946 {prec::ExclusiveOr, "~^"}, {prec::ExclusiveOr, "^~"}, 947 }; 948 for (auto Operator : JoinedBinary) { 949 auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;"); 950 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 951 EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator); 952 EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first); 953 } 954 // '~^' and '^~' can be unary as well as binary operators. 955 auto Tokens = Annotate("x = ~^x;"); 956 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 957 EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator); 958 Tokens = Annotate("x = ^~x;"); 959 ASSERT_EQ(Tokens.size(), 6u) << Tokens; 960 EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator); 961 // The unary operators '~&' and '~|' can only be unary operators. The current 962 // implementation treats each of them as separate unary '~' and '&' or '|' 963 // operators, which is enough for formatting purposes. In FormatTestVerilog, 964 // there is a test that there is no space in between. And even if a new line 965 // is inserted between the '~' and '|', the semantic meaning is the same as 966 // the joined operator, so the CanBreakBefore property doesn't need to be 967 // false for the second operator. 968 Tokens = Annotate("x = ~&x;"); 969 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 970 EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator); 971 EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator); 972 Tokens = Annotate("x = ~|x;"); 973 ASSERT_EQ(Tokens.size(), 7u) << Tokens; 974 EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator); 975 EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator); 976 // Test for block label colons. 977 Tokens = Annotate("begin : x\n" 978 "end : x"); 979 ASSERT_EQ(Tokens.size(), 7u); 980 EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon); 981 EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon); 982 // Test that the dimension colon is annotated correctly. 983 Tokens = Annotate("var [1 : 0] x;"); 984 ASSERT_EQ(Tokens.size(), 9u) << Tokens; 985 EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon); 986 Tokens = Annotate("extern function [1 : 0] x;"); 987 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 988 EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon); 989 // Test case labels and ternary operators. 990 Tokens = Annotate("case (x)\n" 991 " x:\n" 992 " x;\n" 993 "endcase\n"); 994 ASSERT_EQ(Tokens.size(), 10u) << Tokens; 995 EXPECT_TOKEN(Tokens[5], tok::colon, TT_GotoLabelColon); 996 Tokens = Annotate("case (x)\n" 997 " x ? x : x:\n" 998 " x;\n" 999 "endcase\n"); 1000 ASSERT_EQ(Tokens.size(), 14u) << Tokens; 1001 EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr); 1002 EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr); 1003 EXPECT_TOKEN(Tokens[9], tok::colon, TT_GotoLabelColon); 1004 } 1005 1006 } // namespace 1007 } // namespace format 1008 } // namespace clang 1009