xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision b05dc1b8766a47482cae432011fd2faa04c83a3e)
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 
350 TEST_F(TokenAnnotatorTest, UnderstandsStructs) {
351   auto Tokens = annotate("struct S {};");
352   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
353   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace);
354 }
355 
356 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
357   auto Tokens = annotate("union U {};");
358   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
359   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
360 
361   Tokens = annotate("union U { void f() { return; } };");
362   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
363   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
364   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
365 }
366 
367 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
368   auto Tokens = annotate("enum E {};");
369   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
370   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
371 }
372 
373 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
374   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
375   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
376   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
377 
378   Tokens = annotate("template <typename T> void F(T) && = delete;");
379   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
380   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
381 }
382 
383 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
384   auto Tokens =
385       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
386   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
387   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
388 }
389 
390 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
391   auto Tokens =
392       annotate("template <typename T> "
393                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
394   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
395   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
396 }
397 
398 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) {
399   auto Tokens =
400       annotate("#define FOO(typeName) \\\n"
401                "  { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }");
402   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
403   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
404   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
405   EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener);
406   EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser);
407 }
408 
409 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) {
410   auto Tokens = annotate("if (std::tuple_size_v<T> > 0)");
411   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
412   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
413   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
414   EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator);
415 }
416 
417 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
418   FormatStyle Style = getLLVMStyle();
419   Style.WhitespaceSensitiveMacros.push_back("FOO");
420 
421   auto Tokens = annotate("FOO(1+2 )\n", Style);
422   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
423   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
424 
425   Tokens = annotate("FOO(a:b:c)\n", Style);
426   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
427   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
428 }
429 
430 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
431   auto Tokens = annotate("delete (void *)p;");
432   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
433   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
434 
435   Tokens = annotate("delete[] (void *)p;");
436   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
437   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
438 
439   Tokens = annotate("delete[] /*comment*/ (void *)p;");
440   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
441   EXPECT_TOKEN(Tokens[7], 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 
452 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
453   auto Tokens = annotate("(void)p;");
454   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
455   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
456 
457   Tokens = annotate("auto x = (Foo)p;");
458   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
459   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
460 
461   Tokens = annotate("(std::vector<int>)p;");
462   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
463   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
464 
465   Tokens = annotate("return (Foo)p;");
466   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
467   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
468 
469   Tokens = annotate("throw (Foo)p;");
470   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
471   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
472 }
473 
474 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
475   auto Tokens = annotate("void f() throw(int);");
476   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
477   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
478 }
479 
480 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
481   auto Tokens = annotate("void f() &;");
482   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
483   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
484 
485   Tokens = annotate("void operator=(T) &&;");
486   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
487   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
488 
489   Tokens = annotate("template <typename T> void f() &;");
490   EXPECT_EQ(Tokens.size(), 12u) << Tokens;
491   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
492 
493   Tokens = annotate("template <typename T> void operator=(T) &;");
494   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
495   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
496 }
497 
498 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
499   auto Tokens = annotate("x.operator+()");
500   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
501   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
502   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
503   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
504   Tokens = annotate("x.operator=()");
505   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
506   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
507   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
508   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
509   Tokens = annotate("x.operator+=()");
510   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
511   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
512   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
513   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
514   Tokens = annotate("x.operator,()");
515   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
516   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
517   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
518   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
519   Tokens = annotate("x.operator()()");
520   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
521   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
522   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
523   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
524   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
525   Tokens = annotate("x.operator[]()");
526   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
527   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
528   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
529   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
530   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
531   Tokens = annotate("x.operator\"\"_a()");
532   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
533   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
534   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
535   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
536   Tokens = annotate("x.operator\"\" _a()");
537   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
538   // FIXME
539   // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
540   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
541   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
542   Tokens = annotate("x.operator\"\"if()");
543   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
544   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
545   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
546   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
547   Tokens = annotate("x.operator\"\"s()");
548   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
549   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
550   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
551   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
552   Tokens = annotate("x.operator\"\" s()");
553   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
554   // FIXME
555   // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
556   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
557   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
558 
559   Tokens = annotate("int operator+(int);");
560   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
561   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
562   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
563   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
564   Tokens = annotate("auto operator=(T&) {}");
565   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
566   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
567   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
568   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
569   Tokens = annotate("auto operator()() {}");
570   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
571   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
572   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
573   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
574   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
575 }
576 
577 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
578   struct {
579     const char *Text;
580     tok::TokenKind Kind;
581   } Operators[] = {{"+", tok::plus},
582                    {"-", tok::minus},
583                    // FIXME:
584                    // {"*", tok::star},
585                    {"/", tok::slash},
586                    {"%", tok::percent},
587                    {"^", tok::caret},
588                    // FIXME:
589                    // {"&", tok::amp},
590                    {"|", tok::pipe},
591                    {"~", tok::tilde},
592                    {"!", tok::exclaim},
593                    {"=", tok::equal},
594                    // FIXME:
595                    // {"<", tok::less},
596                    {">", tok::greater},
597                    {"+=", tok::plusequal},
598                    {"-=", tok::minusequal},
599                    {"*=", tok::starequal},
600                    {"/=", tok::slashequal},
601                    {"%=", tok::percentequal},
602                    {"^=", tok::caretequal},
603                    {"&=", tok::ampequal},
604                    {"|=", tok::pipeequal},
605                    {"<<", tok::lessless},
606                    {">>", tok::greatergreater},
607                    {">>=", tok::greatergreaterequal},
608                    {"<<=", tok::lesslessequal},
609                    {"==", tok::equalequal},
610                    {"!=", tok::exclaimequal},
611                    {"<=", tok::lessequal},
612                    {">=", tok::greaterequal},
613                    {"<=>", tok::spaceship},
614                    {"&&", tok::ampamp},
615                    {"||", tok::pipepipe},
616                    {"++", tok::plusplus},
617                    {"--", tok::minusminus},
618                    {",", tok::comma},
619                    {"->*", tok::arrowstar},
620                    {"->", tok::arrow}};
621 
622   for (const auto &Operator : Operators) {
623     std::string Input("C<&operator");
624     Input += Operator.Text;
625     Input += " > a;";
626     auto Tokens = annotate(std::string(Input));
627     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
628     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
629     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
630     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
631   }
632 
633   auto Tokens = annotate("C<&operator< <X>> lt;");
634   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
635   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
636   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
637   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
638   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
639   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
640 }
641 
642 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
643   auto Tokens = annotate("template <typename T>\n"
644                          "concept C = (Foo && Bar) && (Bar && Baz);");
645 
646   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
647   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
648   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
649   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
650 
651   Tokens = annotate("template <typename T>\n"
652                     "concept C = Foo && !Bar;");
653 
654   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
655   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
656   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
657 
658   Tokens = annotate("template <typename T>\n"
659                     "concept C = requires(T t) {\n"
660                     "  { t.foo() };\n"
661                     "} && Bar<T> && Baz<T>;");
662   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
663   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
664   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
665   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
666   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
667   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
668 
669   Tokens = annotate("template<typename T>\n"
670                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
671                     "struct Foo;");
672   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
673   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
674   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
675   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
676   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
677   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
678   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
679   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
680   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
681   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
682   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
683 
684   Tokens =
685       annotate("template<typename T>\n"
686                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
687                "struct Foo;");
688   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
689   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
690   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
691   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
692   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
693   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
694   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
695   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
696   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
697   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
698   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
699   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
700 
701   Tokens = annotate("template <typename T>\n"
702                     "void foo(T) noexcept requires Bar<T>;");
703   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
704   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
705 
706   Tokens = annotate("template <typename T>\n"
707                     "requires Bar<T> || Baz<T>\n"
708                     "auto foo(T) -> int;");
709   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
710   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
711   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
712   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
713   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
714 
715   Tokens = annotate("template <typename T>\n"
716                     "requires Bar<T>\n"
717                     "bool foo(T) { return false; }");
718   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
719   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
720   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
721   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
722 
723   Tokens = annotate("template <typename T>\n"
724                     "requires Bar<T>\n"
725                     "decltype(auto) foo(T) { return false; }");
726   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
727   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
728   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
729   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
730 
731   Tokens = annotate("template <typename T>\n"
732                     "struct S {\n"
733                     "  void foo() const requires Bar<T>;\n"
734                     "  void bar() const & requires Baz<T>;\n"
735                     "  void bar() && requires Baz2<T>;\n"
736                     "  void baz() const & noexcept requires Baz<T>;\n"
737                     "  void baz() && noexcept requires Baz2<T>;\n"
738                     "};\n"
739                     "\n"
740                     "void S::bar() const & requires Baz<T> { }");
741   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
742   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
743   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
744   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
745   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
746   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
747   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
748 
749   Tokens = annotate("void Class::member() && requires(Constant) {}");
750   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
751   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
752 
753   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
754   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
755   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
756 
757   Tokens =
758       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
759   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
760   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
761 
762   Tokens = annotate("void Class::member() && requires(typename "
763                     "Namespace::Outer<T>::Inner::Constant) {}");
764   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
765   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
766 
767   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
768                     "  template<class T>\n"
769                     "    requires requires { number_zero_v<T>; }\n"
770                     "  [[nodiscard]] constexpr operator T() const { "
771                     "return number_zero_v<T>; }\n"
772                     "};");
773   ASSERT_EQ(Tokens.size(), 44u);
774   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
775   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
776   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
777   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
778   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
779   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
780 
781   Tokens =
782       annotate("template <class A, class B> concept C ="
783                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
784   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
785   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
786   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
787   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
788   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
789   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
790   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
791   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
792 
793   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
794   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
795   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
796 
797   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
798   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
799   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
800 
801   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
802   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
803   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
804 
805   Tokens =
806       annotate("auto bar() -> SOME_MACRO_TYPE 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 =
811       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
812   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
813   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
814 
815   Tokens =
816       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
817   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
818   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
819 }
820 
821 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
822   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
823   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
824   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
825   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
826   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
827 
828   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
829   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
830   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
831   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
832   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
833 
834   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
835   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
836   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
837   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
838   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
839 
840   Tokens = annotate("foo(requires(const T t) {});");
841   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
842   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
843   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
844   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
845 
846   Tokens = annotate("foo(requires(const int t) {});");
847   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
848   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
849   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
850   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
851 
852   Tokens = annotate("foo(requires(const T t) {});");
853   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
854   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
855   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
856   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
857 
858   Tokens = annotate("foo(requires(int const* volatile t) {});");
859   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
860   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
861   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
862   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
863   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
864 
865   Tokens = annotate("foo(requires(T const* volatile t) {});");
866   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
867   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
868   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
869   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
870   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
871 
872   Tokens = annotate("foo(requires(T& t) {});");
873   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
874   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
875   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
876   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
877   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
878 
879   Tokens = annotate("foo(requires(T&& t) {});");
880   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
881   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
882   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
883   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
884   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
885 
886   Tokens = annotate("bool foo = requires(T& t) {};");
887   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
888   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
889   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
890   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
891   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
892 
893   Tokens = annotate("bool foo = requires(T&& t) {};");
894   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
895   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
896   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
897   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
898   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
899 
900   Tokens =
901       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
902   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
903   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
904   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
905   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
906   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
907 
908   Tokens = annotate("template <typename T>\n"
909                     "concept C = requires(T T) {\n"
910                     "  requires Bar<T> && Foo<T>;\n"
911                     "};");
912   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
913   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
914   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
915   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
916   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
917                TT_RequiresClauseInARequiresExpression);
918 
919   Tokens = annotate("template <typename T>\n"
920                     "concept C = requires(T T) {\n"
921                     "  { t.func() } -> std::same_as<int>;"
922                     "  requires Bar<T> && Foo<T>;\n"
923                     "};");
924   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
925   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
926   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
927   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
928   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
929                TT_RequiresClauseInARequiresExpression);
930 
931   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
932   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
933                     "requires true; };");
934   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
935   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
936   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
937   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
938 }
939 
940 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
941   // Everything after #pragma region should be ImplicitStringLiteral
942   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
943   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
944   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
945   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
946   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
947 
948   // Make sure it's annotated correctly inside a function as well
949   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
950   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
951   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
952   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
953   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
954 }
955 
956 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
957   const char *BaseCode = nullptr;
958   const char *ConstrainedCode = nullptr;
959   auto BaseTokenCount = 0u;
960   auto RequiresTokenCount = 0u;
961   auto PrefixTokenCount = 0u;
962 
963   auto TestRequires = [&](int Line) {
964     const auto BaseTokens = annotate(BaseCode);
965     const auto ConstrainedTokens = annotate(ConstrainedCode);
966 
967 #define LINE " (Line " << Line << ')'
968 
969     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
970     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
971         << LINE;
972 
973     for (auto I = 0u; I < BaseTokenCount; ++I) {
974       EXPECT_EQ(
975           *BaseTokens[I],
976           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
977           << I << LINE;
978     }
979 
980 #undef LINE
981   };
982 
983   BaseCode = "template<typename T>\n"
984              "T Pi = 3.14;";
985   ConstrainedCode = "template<typename T>\n"
986                     "  requires Foo<T>\n"
987                     "T Pi = 3.14;";
988   BaseTokenCount = 11;
989   RequiresTokenCount = 5;
990   PrefixTokenCount = 5;
991   TestRequires(__LINE__);
992 
993   BaseCode = "template<typename T>\n"
994              "struct Bar;";
995   ConstrainedCode = "template<typename T>\n"
996                     "  requires Foo<T>\n"
997                     "struct Bar;";
998   BaseTokenCount = 9;
999   TestRequires(__LINE__);
1000 
1001   BaseCode = "template<typename T>\n"
1002              "struct Bar {\n"
1003              "  T foo();\n"
1004              "  T bar();\n"
1005              "};";
1006   ConstrainedCode = "template<typename T>\n"
1007                     "  requires Foo<T>\n"
1008                     "struct Bar {\n"
1009                     "  T foo();\n"
1010                     "  T bar();\n"
1011                     "};";
1012   BaseTokenCount = 21;
1013   TestRequires(__LINE__);
1014 
1015   BaseCode = "template<typename T>\n"
1016              "Bar(T) -> Bar<T>;";
1017   ConstrainedCode = "template<typename T>\n"
1018                     "  requires Foo<T>\n"
1019                     "Bar(T) -> Bar<T>;";
1020   BaseTokenCount = 16;
1021   TestRequires(__LINE__);
1022 
1023   BaseCode = "template<typename T>\n"
1024              "T foo();";
1025   ConstrainedCode = "template<typename T>\n"
1026                     "  requires Foo<T>\n"
1027                     "T foo();";
1028   BaseTokenCount = 11;
1029   TestRequires(__LINE__);
1030 
1031   BaseCode = "template<typename T>\n"
1032              "T foo() {\n"
1033              "  auto bar = baz();\n"
1034              "  return bar + T{};\n"
1035              "}";
1036   ConstrainedCode = "template<typename T>\n"
1037                     "  requires Foo<T>\n"
1038                     "T foo() {\n"
1039                     "  auto bar = baz();\n"
1040                     "  return bar + T{};\n"
1041                     "}";
1042   BaseTokenCount = 26;
1043   TestRequires(__LINE__);
1044 
1045   BaseCode = "template<typename T>\n"
1046              "T foo();";
1047   ConstrainedCode = "template<typename T>\n"
1048                     "T foo() requires Foo<T>;";
1049   BaseTokenCount = 11;
1050   PrefixTokenCount = 9;
1051   TestRequires(__LINE__);
1052 
1053   BaseCode = "template<typename T>\n"
1054              "T foo() {\n"
1055              "  auto bar = baz();\n"
1056              "  return bar + T{};\n"
1057              "}";
1058   ConstrainedCode = "template<typename T>\n"
1059                     "T foo() requires Foo<T> {\n"
1060                     "  auto bar = baz();\n"
1061                     "  return bar + T{};\n"
1062                     "}";
1063   BaseTokenCount = 26;
1064   TestRequires(__LINE__);
1065 
1066   BaseCode = "template<typename T>\n"
1067              "T foo();";
1068   ConstrainedCode = "template<typename T>\n"
1069                     "  requires(Foo<T>)\n"
1070                     "T foo();";
1071   BaseTokenCount = 11;
1072   RequiresTokenCount = 7;
1073   PrefixTokenCount = 5;
1074   TestRequires(__LINE__);
1075 
1076   BaseCode = "template<typename T>\n"
1077              "Bar(T) -> Bar<typename T::I>;";
1078   ConstrainedCode = "template<typename T>\n"
1079                     "  requires requires(T &&t) {\n"
1080                     "             typename T::I;\n"
1081                     "           }\n"
1082                     "Bar(T) -> Bar<typename T::I>;";
1083   BaseTokenCount = 19;
1084   RequiresTokenCount = 14;
1085   PrefixTokenCount = 5;
1086   TestRequires(__LINE__);
1087 
1088   BaseCode = "struct [[nodiscard]] zero_t {\n"
1089              "  template<class T>\n"
1090              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1091              "};";
1092   ConstrainedCode =
1093       "struct [[nodiscard]] zero_t {\n"
1094       "  template<class T>\n"
1095       "    requires requires { v<T>; }\n"
1096       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1097       "};";
1098   BaseTokenCount = 35;
1099   RequiresTokenCount = 9;
1100   PrefixTokenCount = 13;
1101   TestRequires(__LINE__);
1102 
1103   BaseCode = "constexpr Foo(Foo const &other)\n"
1104              "    : value{other.value} {\n"
1105              "  do_magic();\n"
1106              "  do_more_magic();\n"
1107              "}";
1108   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1109                     "  requires std::is_copy_constructible<T>\n"
1110                     "    : value{other.value} {\n"
1111                     "  do_magic();\n"
1112                     "  do_more_magic();\n"
1113                     "}";
1114   BaseTokenCount = 26;
1115   RequiresTokenCount = 7;
1116   PrefixTokenCount = 8;
1117   TestRequires(__LINE__);
1118 
1119   BaseCode = "constexpr Foo(Foo const &other)\n"
1120              "    : value{other.value} {\n"
1121              "  do_magic();\n"
1122              "  do_more_magic();\n"
1123              "}";
1124   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1125                     "  requires (std::is_copy_constructible<T>)\n"
1126                     "    : value{other.value} {\n"
1127                     "  do_magic();\n"
1128                     "  do_more_magic();\n"
1129                     "}";
1130   RequiresTokenCount = 9;
1131   TestRequires(__LINE__);
1132 }
1133 
1134 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1135   auto Tokens = annotate("__asm{\n"
1136                          "a:\n"
1137                          "};");
1138   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1139   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1140   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1141   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
1142 }
1143 
1144 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1145   auto Tokens = annotate("int (^)() = ^ ()\n"
1146                          "  external_source_symbol() { //\n"
1147                          "  return 1;\n"
1148                          "};");
1149   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1150   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1151   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1152 
1153   Tokens = annotate("int *p = ^int*(){ //\n"
1154                     "  return nullptr;\n"
1155                     "}();");
1156   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1157   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1158 }
1159 
1160 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1161   auto Tokens = annotate("[]() constexpr {}");
1162   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1163   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1164   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1165 
1166   Tokens = annotate("[]() consteval {}");
1167   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1168   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1169   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1170 
1171   Tokens = annotate("[]() mutable {}");
1172   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1173   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1174   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1175 
1176   Tokens = annotate("[]() static {}");
1177   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1178   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1179   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1180 
1181   Tokens = annotate("[]() -> auto {}");
1182   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1183   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1184   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1185   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1186 
1187   Tokens = annotate("[]() -> auto & {}");
1188   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1189   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1190   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1191   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1192 
1193   Tokens = annotate("[]() -> auto * {}");
1194   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1195   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1196   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1197   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1198 
1199   Tokens = annotate("[] {}");
1200   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1201   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1202   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1203 
1204   Tokens = annotate("[] noexcept {}");
1205   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1206   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1207   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1208 
1209   Tokens = annotate("[] -> auto {}");
1210   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1211   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1212   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_LambdaArrow);
1213   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1214 
1215   Tokens = annotate("[] <typename T> () {}");
1216   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1217   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1218   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1219   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1220 
1221   Tokens = annotate("[] <typename T> {}");
1222   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1223   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1224   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1225   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1226 
1227   Tokens = annotate("[] <typename... T> () {}");
1228   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1229   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1230   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1231   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1232 
1233   Tokens = annotate("[] <typename... T> {}");
1234   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1235   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1236   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1237   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1238 
1239   Tokens = annotate("[] <int... T> () {}");
1240   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1241   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1242   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1243   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1244 
1245   Tokens = annotate("[] <int... T> {}");
1246   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1247   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1248   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1249   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1250 
1251   Tokens = annotate("[] <Foo... T> () {}");
1252   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1253   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1254   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1255   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1256 
1257   Tokens = annotate("[] <Foo... T> {}");
1258   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1259   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1260   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1261   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1262 }
1263 
1264 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1265   auto Tokens = annotate("template <typename T>\n"
1266                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1267                          "string OldFunction(const string &parameter) {}");
1268   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1269   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1270 
1271   Tokens = annotate("template <typename T>\n"
1272                     "A(T) noexcept;");
1273   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1274   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1275 }
1276 
1277 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1278   auto Tokens = annotate("void f [[noreturn]] ();");
1279   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1280   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1281 
1282   Tokens = annotate("void f [[noreturn]] () {}");
1283   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1284   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1285 }
1286 
1287 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1288   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1289   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1290   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1291   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1292   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1293 }
1294 
1295 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
1296   auto Annotate = [this](llvm::StringRef Code) {
1297     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
1298   };
1299   // Test that unary operators get labeled as such and that operators like '++'
1300   // don't get split.
1301   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
1302                             tok::tilde, tok::amp,      tok::pipe,
1303                             tok::caret, tok::plusplus, tok::minusminus};
1304   for (auto Kind : Unary) {
1305     auto Tokens =
1306         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
1307     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1308     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
1309   }
1310   // Operators formed by joining two operators like '^~'. For some of these
1311   // joined operators, we don't have a separate type, so we only test for their
1312   // precedence.
1313   std::pair<prec::Level, std::string> JoinedBinary[] = {
1314       {prec::Comma, "<->"},       {prec::Assignment, "+="},
1315       {prec::Assignment, "-="},   {prec::Assignment, "*="},
1316       {prec::Assignment, "/="},   {prec::Assignment, "%="},
1317       {prec::Assignment, "&="},   {prec::Assignment, "^="},
1318       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
1319       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
1320       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
1321       {prec::Equality, "=="},     {prec::Equality, "!="},
1322       {prec::Equality, "==="},    {prec::Equality, "!=="},
1323       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
1324       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
1325   };
1326   for (auto Operator : JoinedBinary) {
1327     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
1328     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1329     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
1330     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
1331   }
1332   // '~^' and '^~' can be unary as well as binary operators.
1333   auto Tokens = Annotate("x = ~^x;");
1334   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1335   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1336   Tokens = Annotate("x = ^~x;");
1337   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1338   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1339   // The unary operators '~&' and '~|' can only be unary operators. The current
1340   // implementation treats each of them as separate unary '~' and '&' or '|'
1341   // operators, which is enough for formatting purposes. In FormatTestVerilog,
1342   // there is a test that there is no space in between. And even if a new line
1343   // is inserted between the '~' and '|', the semantic meaning is the same as
1344   // the joined operator, so the CanBreakBefore property doesn't need to be
1345   // false for the second operator.
1346   Tokens = Annotate("x = ~&x;");
1347   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1348   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1349   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
1350   Tokens = Annotate("x = ~|x;");
1351   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1352   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1353   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
1354   // Test for block label colons.
1355   Tokens = Annotate("begin : x\n"
1356                     "end : x");
1357   ASSERT_EQ(Tokens.size(), 7u);
1358   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
1359   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
1360   // Test that the dimension colon is annotated correctly.
1361   Tokens = Annotate("var [1 : 0] x;");
1362   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1363   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
1364   Tokens = Annotate("extern function [1 : 0] x;");
1365   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1366   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
1367   // Test case labels and ternary operators.
1368   Tokens = Annotate("case (x)\n"
1369                     "  x:\n"
1370                     "    x;\n"
1371                     "endcase\n");
1372   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1373   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GotoLabelColon);
1374   Tokens = Annotate("case (x)\n"
1375                     "  x ? x : x:\n"
1376                     "    x;\n"
1377                     "endcase\n");
1378   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1379   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
1380   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
1381   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GotoLabelColon);
1382   // Non-blocking assignments.
1383   Tokens = Annotate("a <= b;");
1384   ASSERT_EQ(Tokens.size(), 5u);
1385   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1386   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1387   Tokens = Annotate("if (a <= b) break;");
1388   ASSERT_EQ(Tokens.size(), 9u);
1389   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1390   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1391   Tokens = Annotate("a <= b <= a;");
1392   ASSERT_EQ(Tokens.size(), 7u);
1393   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1394   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1395   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1396   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1397 }
1398 
1399 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
1400   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
1401 
1402   // The TT_Unknown is clearly not binding for the future, please adapt if those
1403   // tokens get annotated.
1404   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1405   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1406   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1407   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
1408   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1409   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1410   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1411   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
1412   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
1413   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1414 
1415   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
1416   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1417   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1418   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1419   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
1420   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
1421   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1422   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1423   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
1424   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
1425   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1426 }
1427 
1428 } // namespace
1429 } // namespace format
1430 } // namespace clang
1431