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