xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision cc2ff02eadede988ab890b2d0f428bd1531a3803)
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_BRACE_KIND(FormatTok, Kind)                                     \
44   EXPECT_EQ(FormatTok->getBlockKind(), Kind) << *(FormatTok)
45 #define EXPECT_TOKEN(FormatTok, Kind, Type)                                    \
46   do {                                                                         \
47     EXPECT_TOKEN_KIND(FormatTok, Kind);                                        \
48     EXPECT_TOKEN_TYPE(FormatTok, Type);                                        \
49   } while (false)
50 
51 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfStarAndAmp) {
52   auto Tokens = annotate("auto x = [](const decltype(x) &ptr) {};");
53   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
54   EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown);
55   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen);
56   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown);
57   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
58   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
59 
60   Tokens = annotate("auto x = [](const decltype(x) *ptr) {};");
61   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
62   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
63   EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference);
64 
65   Tokens = annotate("#define lambda [](const decltype(x) &ptr) {}");
66   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
67   EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown);
68   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen);
69   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown);
70   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
71   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
72 
73   Tokens = annotate("#define lambda [](const decltype(x) *ptr) {}");
74   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
75   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
76   EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference);
77 
78   Tokens = annotate("void f() {\n"
79                     "  while (p < a && *p == 'a')\n"
80                     "    p++;\n"
81                     "}");
82   EXPECT_EQ(Tokens.size(), 21u) << Tokens;
83   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
84   EXPECT_TOKEN(Tokens[11], tok::star, TT_UnaryOperator);
85 
86   Tokens = annotate("case *x:");
87   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
88   EXPECT_TOKEN(Tokens[1], tok::star, TT_UnaryOperator);
89   Tokens = annotate("case &x:");
90   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
91   EXPECT_TOKEN(Tokens[1], tok::amp, TT_UnaryOperator);
92 
93   Tokens = annotate("bool b = 3 == int{3} && true;\n");
94   EXPECT_EQ(Tokens.size(), 13u) << Tokens;
95   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
96 
97   Tokens = annotate("struct {\n"
98                     "} *ptr;");
99   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
100   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
101   Tokens = annotate("union {\n"
102                     "} *ptr;");
103   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
104   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
105   Tokens = annotate("class {\n"
106                     "} *ptr;");
107   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
108   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
109 
110   Tokens = annotate("struct {\n"
111                     "} &&ptr = {};");
112   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
113   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
114   Tokens = annotate("union {\n"
115                     "} &&ptr = {};");
116   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
117   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
118   Tokens = annotate("class {\n"
119                     "} &&ptr = {};");
120   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
121   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
122   Tokens = annotate("int i = int{42} * 2;");
123   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
124   EXPECT_TOKEN(Tokens[7], tok::star, TT_BinaryOperator);
125 
126   Tokens = annotate("delete[] *ptr;");
127   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
128   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
129   Tokens = annotate("delete[] **ptr;");
130   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
131   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
132   EXPECT_TOKEN(Tokens[4], tok::star, TT_UnaryOperator);
133   Tokens = annotate("delete[] *(ptr);");
134   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
135   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
136 
137   Tokens = annotate("void f() { void (*fnptr)(char* foo); }");
138   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
139   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_FunctionTypeLParen);
140   // FIXME: The star of a function pointer probably makes more sense as
141   // TT_PointerOrReference.
142   EXPECT_TOKEN(Tokens[7], tok::star, TT_UnaryOperator);
143   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
144 
145   Tokens = annotate("void f() { void (*fnptr)(t* foo); }");
146   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
147   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_FunctionTypeLParen);
148   EXPECT_TOKEN(Tokens[7], tok::star, TT_UnaryOperator);
149   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
150 
151   Tokens = annotate("int f3() { return sizeof(Foo&); }");
152   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
153   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
154 
155   Tokens = annotate("int f4() { return sizeof(Foo&&); }");
156   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
157   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_PointerOrReference);
158 
159   Tokens = annotate("void f5() { int f6(Foo&, Bar&); }");
160   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
161   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
162   EXPECT_TOKEN(Tokens[12], tok::amp, TT_PointerOrReference);
163 
164   Tokens = annotate("void f7() { int f8(Foo&&, Bar&&); }");
165   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
166   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_PointerOrReference);
167   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_PointerOrReference);
168 
169   Tokens = annotate("Type1 &val1 = val2;");
170   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
171   EXPECT_TOKEN(Tokens[1], tok::amp, TT_PointerOrReference);
172 
173   Tokens = annotate("Type1 *val1 = &val2;");
174   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
175   EXPECT_TOKEN(Tokens[1], tok::star, TT_PointerOrReference);
176   EXPECT_TOKEN(Tokens[4], tok::amp, TT_UnaryOperator);
177 
178   Tokens = annotate("val1 & val2;");
179   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
180   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
181 
182   Tokens = annotate("val1 & val2.member;");
183   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
184   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
185 
186   Tokens = annotate("val1 & val2.*member;");
187   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
188   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
189 
190   Tokens = annotate("val1.*member & val2;");
191   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
192   EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator);
193 
194   Tokens = annotate("val1 & val2->*member;");
195   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
196   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
197 
198   Tokens = annotate("val1->member & val2;");
199   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
200   EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator);
201 
202   Tokens = annotate("val1 & val2 & val3;");
203   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
204   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
205   EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator);
206 
207   Tokens = annotate("val1 & val2 // comment\n"
208                     "     & val3;");
209   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
210   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
211   EXPECT_TOKEN(Tokens[4], tok::amp, TT_BinaryOperator);
212 
213   Tokens =
214       annotate("val1 & val2.member & val3.member() & val4 & val5->member;");
215   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
216   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
217   EXPECT_TOKEN(Tokens[5], tok::amp, TT_BinaryOperator);
218   EXPECT_TOKEN(Tokens[11], tok::amp, TT_BinaryOperator);
219   EXPECT_TOKEN(Tokens[13], tok::amp, TT_BinaryOperator);
220 
221   Tokens = annotate("class c {\n"
222                     "  void func(type &a) { a & member; }\n"
223                     "  anotherType &member;\n"
224                     "}");
225   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
226   EXPECT_TOKEN(Tokens[7], tok::amp, TT_PointerOrReference);
227   EXPECT_TOKEN(Tokens[12], tok::amp, TT_BinaryOperator);
228   EXPECT_TOKEN(Tokens[17], tok::amp, TT_PointerOrReference);
229 
230   Tokens = annotate("struct S {\n"
231                     "  auto Mem = C & D;\n"
232                     "}");
233   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
234   EXPECT_TOKEN(Tokens[7], tok::amp, TT_BinaryOperator);
235 
236   Tokens =
237       annotate("template <typename T> void swap() noexcept(Bar<T> && Foo<T>);");
238   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
239   EXPECT_TOKEN(Tokens[15], tok::ampamp, TT_BinaryOperator);
240 
241   Tokens = annotate("template <typename T> struct S {\n"
242                     "  explicit(Bar<T> && Foo<T>) S(const S &);\n"
243                     "};");
244   ASSERT_EQ(Tokens.size(), 30u) << Tokens;
245   EXPECT_TOKEN(Tokens[14], tok::ampamp, TT_BinaryOperator);
246 
247   Tokens = annotate("template <bool B = C && D> struct S {};");
248   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
249   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_BinaryOperator);
250 
251   Tokens = annotate("template <typename T, bool B = C && D> struct S {};");
252   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
253   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
254 
255   Tokens = annotate("template <typename T, typename U = T&&> struct S {};");
256   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
257   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_PointerOrReference);
258 
259   Tokens = annotate("template <typename T = int (*)(int)> struct S {};");
260   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
261   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_FunctionTypeLParen);
262   EXPECT_TOKEN(Tokens[7], tok::star, TT_PointerOrReference);
263 
264   Tokens = annotate("Foo<A && B> a = {};");
265   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
266   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_BinaryOperator);
267 
268   Tokens = annotate("Foo<A &&> a = {};");
269   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
270   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
271 
272   Tokens = annotate("template <enable_if_t<foo && !bar>* = nullptr> void f();");
273   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
274   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_BinaryOperator);
275 }
276 
277 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) {
278   auto Tokens = annotate("x - 0");
279   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
280   EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator);
281   Tokens = annotate("0 + 0");
282   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
283   EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator);
284   Tokens = annotate("x + +0");
285   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
286   EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator);
287   Tokens = annotate("x ? -0 : +0");
288   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
289   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
290   EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator);
291   Tokens = annotate("(-0)");
292   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
293   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
294   Tokens = annotate("0, -0");
295   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
296   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
297   Tokens = annotate("for (; -1;) {\n}");
298   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
299   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
300   Tokens = annotate("x = -1;");
301   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
302   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
303   Tokens = annotate("x[-1]");
304   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
305   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
306   Tokens = annotate("x = {-1};");
307   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
308   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
309   Tokens = annotate("case -x:");
310   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
311   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
312   Tokens = annotate("co_await -x;");
313   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
314   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
315   Tokens = annotate("co_return -x;");
316   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
317   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
318   Tokens = annotate("co_yield -x;");
319   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
320   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
321   Tokens = annotate("delete -x;");
322   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
323   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
324   Tokens = annotate("return -x;");
325   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
326   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
327   Tokens = annotate("throw -x;");
328   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
329   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
330   Tokens = annotate("sizeof -x");
331   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
332   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
333   Tokens = annotate("co_await +x;");
334   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
335   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
336   Tokens = annotate("co_return +x;");
337   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
338   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
339   Tokens = annotate("co_yield +x;");
340   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
341   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
342   Tokens = annotate("delete +x;");
343   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
344   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
345   Tokens = annotate("return +x;");
346   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
347   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
348   Tokens = annotate("throw +x;");
349   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
350   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
351   Tokens = annotate("sizeof +x");
352   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
353   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
354   Tokens = annotate("(int)-x");
355   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
356   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
357   Tokens = annotate("(-x)");
358   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
359   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
360   Tokens = annotate("!+x");
361   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
362   EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator);
363   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
364 }
365 
366 TEST_F(TokenAnnotatorTest, UnderstandsClasses) {
367   auto Tokens = annotate("class C {};");
368   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
369   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
370 
371   Tokens = annotate("const class C {} c;");
372   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
373   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace);
374 
375   Tokens = annotate("const class {} c;");
376   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
377   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
378 
379   Tokens = annotate("class [[deprecated(\"\")]] C { int i; };");
380   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
381   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_ClassLBrace);
382 }
383 
384 TEST_F(TokenAnnotatorTest, UnderstandsStructs) {
385   auto Tokens = annotate("struct S {};");
386   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
387   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace);
388 
389   Tokens = annotate("struct EXPORT_MACRO [[nodiscard]] C { int i; };");
390   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
391   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_StructLBrace);
392 
393   Tokens = annotate("struct [[deprecated]] [[nodiscard]] C { int i; };");
394   EXPECT_EQ(Tokens.size(), 19u) << Tokens;
395   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_StructLBrace);
396 
397   Tokens = annotate("template <typename T> struct S<const T[N]> {};");
398   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
399   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
400   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
401   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
402   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
403 
404   Tokens = annotate("template <typename T> struct S<T const[N]> {};");
405   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
406   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
407   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
408   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
409   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
410 
411   Tokens = annotate("template <typename T, unsigned n> struct S<T const[n]> {\n"
412                     "  void f(T const (&a)[n]);\n"
413                     "};");
414   EXPECT_EQ(Tokens.size(), 35u) << Tokens;
415   EXPECT_TOKEN(Tokens[10], tok::less, TT_TemplateOpener);
416   EXPECT_TOKEN(Tokens[13], tok::l_square, TT_ArraySubscriptLSquare);
417   EXPECT_TOKEN(Tokens[16], tok::greater, TT_TemplateCloser);
418   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_StructLBrace);
419   EXPECT_TOKEN(Tokens[23], tok::l_paren, TT_FunctionTypeLParen);
420   EXPECT_TOKEN(Tokens[24], tok::amp, TT_UnaryOperator);
421   EXPECT_TOKEN(Tokens[27], tok::l_square, TT_ArraySubscriptLSquare);
422 }
423 
424 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
425   auto Tokens = annotate("union U {};");
426   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
427   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
428 
429   Tokens = annotate("union U { void f() { return; } };");
430   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
431   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
432   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
433 }
434 
435 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
436   auto Tokens = annotate("enum E {};");
437   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
438   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
439 }
440 
441 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
442   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
443   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
444   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
445 
446   Tokens = annotate("template <typename T> void F(T) && = delete;");
447   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
448   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
449 }
450 
451 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
452   auto Tokens =
453       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
454   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
455   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
456 }
457 
458 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
459   auto Tokens =
460       annotate("template <typename T> "
461                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
462   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
463   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
464 }
465 
466 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) {
467   auto Tokens =
468       annotate("#define FOO(typeName) \\\n"
469                "  { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }");
470   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
471   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
472   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
473   EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener);
474   EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser);
475 }
476 
477 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) {
478   auto Tokens = annotate("if (std::tuple_size_v<T> > 0)");
479   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
480   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
481   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
482   EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator);
483 }
484 
485 TEST_F(TokenAnnotatorTest, UnderstandsNonTemplateAngleBrackets) {
486   auto Tokens = annotate("return a < b && c > d;");
487   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
488   EXPECT_TOKEN(Tokens[2], tok::less, TT_BinaryOperator);
489   EXPECT_TOKEN(Tokens[6], tok::greater, TT_BinaryOperator);
490 
491   Tokens = annotate("a < 0 ? b : a > 0 ? c : d;");
492   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
493   EXPECT_TOKEN(Tokens[1], tok::less, TT_BinaryOperator);
494   EXPECT_TOKEN(Tokens[7], tok::greater, TT_BinaryOperator);
495 
496   Tokens = annotate("ratio{-1, 2} < ratio{-1, 3} == -1 / 3 > -1 / 2;");
497   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
498   EXPECT_TOKEN(Tokens[7], tok::less, TT_BinaryOperator);
499   EXPECT_TOKEN(Tokens[20], tok::greater, TT_BinaryOperator);
500 }
501 
502 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
503   FormatStyle Style = getLLVMStyle();
504   Style.WhitespaceSensitiveMacros.push_back("FOO");
505 
506   auto Tokens = annotate("FOO(1+2 )\n", Style);
507   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
508   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
509 
510   Tokens = annotate("FOO(a:b:c)\n", Style);
511   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
512   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
513 }
514 
515 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
516   auto Tokens = annotate("delete (void *)p;");
517   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
518   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
519 
520   Tokens = annotate("delete[] (void *)p;");
521   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
522   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
523 
524   Tokens = annotate("delete[] /*comment*/ (void *)p;");
525   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
526   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
527 
528   Tokens = annotate("delete[/*comment*/] (void *)p;");
529   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
530   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
531 
532   Tokens = annotate("delete/*comment*/[] (void *)p;");
533   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
534   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
535 }
536 
537 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
538   auto Tokens = annotate("(void)p;");
539   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
540   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
541 
542   Tokens = annotate("auto x = (Foo)p;");
543   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
544   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
545 
546   Tokens = annotate("(std::vector<int>)p;");
547   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
548   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
549 
550   Tokens = annotate("return (Foo)p;");
551   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
552   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
553 
554   Tokens = annotate("throw (Foo)p;");
555   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
556   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
557 
558   Tokens = annotate("#define FOO(x) (((uint64_t)(x) * BAR) / 100)");
559   EXPECT_EQ(Tokens.size(), 21u) << Tokens;
560   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
561   EXPECT_TOKEN(Tokens[13], tok::r_paren, TT_Unknown);
562   EXPECT_TOKEN(Tokens[14], tok::star, TT_BinaryOperator);
563 
564   Tokens = annotate("return (Foo) & 10;");
565   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
566   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_Unknown);
567   EXPECT_TOKEN(Tokens[4], tok::amp, TT_BinaryOperator);
568 }
569 
570 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
571   auto Tokens = annotate("void f() throw(int);");
572   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
573   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
574 }
575 
576 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
577   auto Tokens = annotate("void f() &;");
578   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
579   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
580 
581   Tokens = annotate("void operator=(T) &&;");
582   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
583   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
584 
585   Tokens = annotate("template <typename T> void f() &;");
586   EXPECT_EQ(Tokens.size(), 12u) << Tokens;
587   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
588 
589   Tokens = annotate("template <typename T> void operator=(T) &;");
590   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
591   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
592 }
593 
594 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
595   auto Tokens = annotate("x.operator+()");
596   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
597   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
598   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
599   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
600   Tokens = annotate("x.operator=()");
601   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
602   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
603   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
604   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
605   Tokens = annotate("x.operator+=()");
606   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
607   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
608   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
609   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
610   Tokens = annotate("x.operator,()");
611   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
612   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
613   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
614   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
615   Tokens = annotate("x.operator()()");
616   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
617   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
618   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
619   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
620   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
621   Tokens = annotate("x.operator[]()");
622   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
623   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
624   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
625   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
626   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
627   Tokens = annotate("x.operator\"\"_a()");
628   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
629   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
630   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
631   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
632   Tokens = annotate("x.operator\"\" _a()");
633   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
634   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
635   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
636   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
637   Tokens = annotate("x.operator\"\"if()");
638   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
639   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
640   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
641   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
642   Tokens = annotate("x.operator\"\"s()");
643   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
644   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
645   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
646   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
647   Tokens = annotate("x.operator\"\" s()");
648   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
649   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
650   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
651   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
652 
653   Tokens = annotate("int operator+(int);");
654   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
655   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
656   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
657   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
658   Tokens = annotate("auto operator=(T&) {}");
659   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
660   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
661   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
662   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
663   Tokens = annotate("auto operator()() {}");
664   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
665   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
666   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
667   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
668   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
669 
670   Tokens = annotate("class Foo {\n"
671                     "  int operator+(a* b);\n"
672                     "}");
673   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
674   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
675   EXPECT_TOKEN(Tokens[5], tok::plus, TT_OverloadedOperator);
676   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_OverloadedOperatorLParen);
677   EXPECT_TOKEN(Tokens[8], tok::star, TT_PointerOrReference);
678 
679   Tokens = annotate("class Foo {\n"
680                     "  int c = operator+(a * b);\n"
681                     "}");
682   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
683   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_Unknown);
684   EXPECT_TOKEN(Tokens[7], tok::plus, TT_OverloadedOperator);
685   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_OverloadedOperatorLParen);
686   EXPECT_TOKEN(Tokens[10], tok::star, TT_BinaryOperator);
687 
688   Tokens = annotate("void foo() {\n"
689                     "  operator+(a * b);\n"
690                     "}");
691   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
692   EXPECT_TOKEN(Tokens[5], tok::kw_operator, TT_Unknown);
693   EXPECT_TOKEN(Tokens[6], tok::plus, TT_OverloadedOperator);
694   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
695   EXPECT_TOKEN(Tokens[9], tok::star, TT_BinaryOperator);
696 
697   Tokens = annotate("return operator+(a * b, c & d) + operator+(a && b && c);");
698   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
699   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_Unknown);
700   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
701   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
702   EXPECT_TOKEN(Tokens[5], tok::star, TT_BinaryOperator);
703   EXPECT_TOKEN(Tokens[9], tok::amp, TT_BinaryOperator);
704   EXPECT_TOKEN(Tokens[13], tok::kw_operator, TT_Unknown);
705   EXPECT_TOKEN(Tokens[14], tok::plus, TT_OverloadedOperator);
706   EXPECT_TOKEN(Tokens[15], tok::l_paren, TT_OverloadedOperatorLParen);
707   EXPECT_TOKEN(Tokens[17], tok::ampamp, TT_BinaryOperator);
708   EXPECT_TOKEN(Tokens[19], tok::ampamp, TT_BinaryOperator);
709 
710   Tokens = annotate("class Foo {\n"
711                     "  void foo() {\n"
712                     "    operator+(a * b);\n"
713                     "  }\n"
714                     "}");
715   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
716   EXPECT_TOKEN(Tokens[8], tok::kw_operator, TT_Unknown);
717   EXPECT_TOKEN(Tokens[9], tok::plus, TT_OverloadedOperator);
718   EXPECT_TOKEN(Tokens[10], tok::l_paren, TT_OverloadedOperatorLParen);
719   EXPECT_TOKEN(Tokens[12], tok::star, TT_BinaryOperator);
720 
721   Tokens = annotate("std::vector<Foo> operator()(Foo &foo);");
722   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
723   EXPECT_TOKEN(Tokens[3], tok::less, TT_TemplateOpener);
724   EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
725   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_FunctionDeclarationName);
726   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperator);
727   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_OverloadedOperator);
728   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_OverloadedOperatorLParen);
729   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
730 }
731 
732 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
733   struct {
734     const char *Text;
735     tok::TokenKind Kind;
736   } Operators[] = {{"+", tok::plus},
737                    {"-", tok::minus},
738                    // FIXME:
739                    // {"*", tok::star},
740                    {"/", tok::slash},
741                    {"%", tok::percent},
742                    {"^", tok::caret},
743                    // FIXME:
744                    // {"&", tok::amp},
745                    {"|", tok::pipe},
746                    {"~", tok::tilde},
747                    {"!", tok::exclaim},
748                    {"=", tok::equal},
749                    // FIXME:
750                    // {"<", tok::less},
751                    {">", tok::greater},
752                    {"+=", tok::plusequal},
753                    {"-=", tok::minusequal},
754                    {"*=", tok::starequal},
755                    {"/=", tok::slashequal},
756                    {"%=", tok::percentequal},
757                    {"^=", tok::caretequal},
758                    {"&=", tok::ampequal},
759                    {"|=", tok::pipeequal},
760                    {"<<", tok::lessless},
761                    {">>", tok::greatergreater},
762                    {">>=", tok::greatergreaterequal},
763                    {"<<=", tok::lesslessequal},
764                    {"==", tok::equalequal},
765                    {"!=", tok::exclaimequal},
766                    {"<=", tok::lessequal},
767                    {">=", tok::greaterequal},
768                    {"<=>", tok::spaceship},
769                    {"&&", tok::ampamp},
770                    {"||", tok::pipepipe},
771                    {"++", tok::plusplus},
772                    {"--", tok::minusminus},
773                    {",", tok::comma},
774                    {"->*", tok::arrowstar},
775                    {"->", tok::arrow}};
776 
777   for (const auto &Operator : Operators) {
778     std::string Input("C<&operator");
779     Input += Operator.Text;
780     Input += " > a;";
781     auto Tokens = annotate(std::string(Input));
782     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
783     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
784     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
785     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
786   }
787 
788   auto Tokens = annotate("C<&operator< <X>> lt;");
789   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
790   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
791   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
792   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
793   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
794   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
795 }
796 
797 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
798   auto Tokens = annotate("template <typename T>\n"
799                          "concept C = (Foo && Bar) && (Bar && Baz);");
800 
801   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
802   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
803   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
804   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
805 
806   Tokens = annotate("template <typename T>\n"
807                     "concept C = Foo && !Bar;");
808 
809   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
810   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
811   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
812 
813   Tokens = annotate("template <typename T>\n"
814                     "concept C = requires(T t) {\n"
815                     "  { t.foo() };\n"
816                     "} && Bar<T> && Baz<T>;");
817   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
818   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
819   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
820   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
821   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
822   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
823 
824   Tokens = annotate("template<typename T>\n"
825                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
826                     "struct Foo;");
827   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
828   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
829   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
830   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
831   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
832   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
833   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
834   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
835   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
836   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
837   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
838 
839   Tokens =
840       annotate("template<typename T>\n"
841                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
842                "struct Foo;");
843   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
844   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
845   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
846   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
847   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
848   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
849   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
850   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
851   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
852   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
853   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
854   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
855 
856   Tokens = annotate("template <typename T>\n"
857                     "void foo(T) noexcept requires Bar<T>;");
858   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
859   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
860 
861   Tokens = annotate("template <typename T>\n"
862                     "requires Bar<T> || Baz<T>\n"
863                     "auto foo(T) -> int;");
864   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
865   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
866   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
867   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
868   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
869 
870   Tokens = annotate("template <typename T>\n"
871                     "requires Bar<T>\n"
872                     "bool foo(T) { return false; }");
873   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
874   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
875   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
876   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
877 
878   Tokens = annotate("template <typename T>\n"
879                     "requires Bar<T>\n"
880                     "decltype(auto) foo(T) { return false; }");
881   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
882   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
883   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
884   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
885 
886   Tokens = annotate("template <typename T>\n"
887                     "struct S {\n"
888                     "  void foo() const requires Bar<T>;\n"
889                     "  void bar() const & requires Baz<T>;\n"
890                     "  void bar() && requires Baz2<T>;\n"
891                     "  void baz() const & noexcept requires Baz<T>;\n"
892                     "  void baz() && noexcept requires Baz2<T>;\n"
893                     "};\n"
894                     "\n"
895                     "void S::bar() const & requires Baz<T> { }");
896   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
897   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
898   EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference);
899   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
900   EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference);
901   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
902   EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference);
903   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
904   EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference);
905   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
906   EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference);
907   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
908 
909   Tokens = annotate("void Class::member() && requires(Constant) {}");
910   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
911   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
912 
913   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
914   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
915   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
916 
917   Tokens =
918       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
919   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
920   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
921 
922   Tokens = annotate("void Class::member() && requires(typename "
923                     "Namespace::Outer<T>::Inner::Constant) {}");
924   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
925   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
926 
927   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
928                     "  template<class T>\n"
929                     "    requires requires { number_zero_v<T>; }\n"
930                     "  [[nodiscard]] constexpr operator T() const { "
931                     "return number_zero_v<T>; }\n"
932                     "};");
933   ASSERT_EQ(Tokens.size(), 44u) << Tokens;
934   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
935   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
936   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
937   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
938   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
939   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
940 
941   Tokens =
942       annotate("template <class A, class B> concept C ="
943                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
944   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
945   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
946   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
947   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
948   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
949   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
950   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
951   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
952 
953   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
954   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
955   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
956 
957   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
958   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
959   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
960 
961   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
962   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
963   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
964 
965   Tokens =
966       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
967   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
968   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
969 
970   Tokens =
971       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
972   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
973   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
974 
975   Tokens =
976       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
977   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
978   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
979 
980   Tokens = annotate("void foo() requires((A<T>) && C) {}");
981   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
982   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
983   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_BinaryOperator);
984 
985   Tokens = annotate("void foo() requires(((A<T>) && C)) {}");
986   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
987   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
988   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
989 
990   Tokens = annotate("void foo() requires([](T&&){}(t)) {}");
991   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
992   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
993   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
994 
995   Tokens = annotate("void foo() requires([](T&& u){}(t)) {}");
996   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
997   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
998   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
999 }
1000 
1001 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
1002   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
1003   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1004   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1005   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1006   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1007 
1008   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
1009   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1010   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1011   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1012   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
1013 
1014   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
1015   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1016   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
1017   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
1018   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
1019 
1020   Tokens = annotate("foo(requires(const T t) {});");
1021   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1022   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1023   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1024   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1025 
1026   Tokens = annotate("foo(requires(const int t) {});");
1027   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1028   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1029   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1030   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1031 
1032   Tokens = annotate("foo(requires(const T t) {});");
1033   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1034   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1035   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1036   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1037 
1038   Tokens = annotate("foo(requires(int const* volatile t) {});");
1039   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1040   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1041   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1042   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1043   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1044 
1045   Tokens = annotate("foo(requires(T const* volatile t) {});");
1046   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1047   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1048   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1049   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1050   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1051 
1052   Tokens = annotate("foo(requires(T& t) {});");
1053   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1054   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1055   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1056   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
1057   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1058 
1059   Tokens = annotate("foo(requires(T&& t) {});");
1060   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1061   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1062   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1063   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
1064   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1065 
1066   Tokens = annotate("bool foo = requires(T& t) {};");
1067   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1068   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1069   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1070   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1071   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1072 
1073   Tokens = annotate("bool foo = requires(T&& t) {};");
1074   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1075   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1076   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1077   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
1078   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1079 
1080   Tokens =
1081       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
1082   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1083   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1084   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1085   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
1086   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
1087 
1088   Tokens = annotate("template <typename T>\n"
1089                     "concept C = requires(T T) {\n"
1090                     "  requires Bar<T> && Foo<T>;\n"
1091                     "};");
1092   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
1093   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1094   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1095   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1096   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
1097                TT_RequiresClauseInARequiresExpression);
1098 
1099   Tokens = annotate("template <typename T>\n"
1100                     "concept C = requires(T T) {\n"
1101                     "  { t.func() } -> std::same_as<int>;"
1102                     "  requires Bar<T> && Foo<T>;\n"
1103                     "};");
1104   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
1105   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1106   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1107   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1108   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
1109                TT_RequiresClauseInARequiresExpression);
1110 
1111   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
1112   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
1113                     "requires true; };");
1114   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1115   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1116   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1117   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
1118 }
1119 
1120 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
1121   // Everything after #pragma region should be ImplicitStringLiteral
1122   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
1123   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1124   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
1125   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
1126   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
1127 
1128   // Make sure it's annotated correctly inside a function as well
1129   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
1130   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1131   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
1132   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
1133   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
1134 }
1135 
1136 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
1137   const char *BaseCode = nullptr;
1138   const char *ConstrainedCode = nullptr;
1139   auto BaseTokenCount = 0u;
1140   auto RequiresTokenCount = 0u;
1141   auto PrefixTokenCount = 0u;
1142 
1143   auto TestRequires = [&](int Line) {
1144     const auto BaseTokens = annotate(BaseCode);
1145     const auto ConstrainedTokens = annotate(ConstrainedCode);
1146 
1147 #define LINE " (Line " << Line << ')'
1148 
1149     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
1150     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
1151         << LINE;
1152 
1153     for (auto I = 0u; I < BaseTokenCount; ++I) {
1154       EXPECT_EQ(
1155           *BaseTokens[I],
1156           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
1157           << I << LINE;
1158     }
1159 
1160 #undef LINE
1161   };
1162 
1163   BaseCode = "template<typename T>\n"
1164              "T Pi = 3.14;";
1165   ConstrainedCode = "template<typename T>\n"
1166                     "  requires Foo<T>\n"
1167                     "T Pi = 3.14;";
1168   BaseTokenCount = 11;
1169   RequiresTokenCount = 5;
1170   PrefixTokenCount = 5;
1171   TestRequires(__LINE__);
1172 
1173   BaseCode = "template<typename T>\n"
1174              "struct Bar;";
1175   ConstrainedCode = "template<typename T>\n"
1176                     "  requires Foo<T>\n"
1177                     "struct Bar;";
1178   BaseTokenCount = 9;
1179   TestRequires(__LINE__);
1180 
1181   BaseCode = "template<typename T>\n"
1182              "struct Bar {\n"
1183              "  T foo();\n"
1184              "  T bar();\n"
1185              "};";
1186   ConstrainedCode = "template<typename T>\n"
1187                     "  requires Foo<T>\n"
1188                     "struct Bar {\n"
1189                     "  T foo();\n"
1190                     "  T bar();\n"
1191                     "};";
1192   BaseTokenCount = 21;
1193   TestRequires(__LINE__);
1194 
1195   BaseCode = "template<typename T>\n"
1196              "Bar(T) -> Bar<T>;";
1197   ConstrainedCode = "template<typename T>\n"
1198                     "  requires Foo<T>\n"
1199                     "Bar(T) -> Bar<T>;";
1200   BaseTokenCount = 16;
1201   TestRequires(__LINE__);
1202 
1203   BaseCode = "template<typename T>\n"
1204              "T foo();";
1205   ConstrainedCode = "template<typename T>\n"
1206                     "  requires Foo<T>\n"
1207                     "T foo();";
1208   BaseTokenCount = 11;
1209   TestRequires(__LINE__);
1210 
1211   BaseCode = "template<typename T>\n"
1212              "T foo() {\n"
1213              "  auto bar = baz();\n"
1214              "  return bar + T{};\n"
1215              "}";
1216   ConstrainedCode = "template<typename T>\n"
1217                     "  requires Foo<T>\n"
1218                     "T foo() {\n"
1219                     "  auto bar = baz();\n"
1220                     "  return bar + T{};\n"
1221                     "}";
1222   BaseTokenCount = 26;
1223   TestRequires(__LINE__);
1224 
1225   BaseCode = "template<typename T>\n"
1226              "T foo();";
1227   ConstrainedCode = "template<typename T>\n"
1228                     "T foo() requires Foo<T>;";
1229   BaseTokenCount = 11;
1230   PrefixTokenCount = 9;
1231   TestRequires(__LINE__);
1232 
1233   BaseCode = "template<typename T>\n"
1234              "T foo() {\n"
1235              "  auto bar = baz();\n"
1236              "  return bar + T{};\n"
1237              "}";
1238   ConstrainedCode = "template<typename T>\n"
1239                     "T foo() requires Foo<T> {\n"
1240                     "  auto bar = baz();\n"
1241                     "  return bar + T{};\n"
1242                     "}";
1243   BaseTokenCount = 26;
1244   TestRequires(__LINE__);
1245 
1246   BaseCode = "template<typename T>\n"
1247              "T foo();";
1248   ConstrainedCode = "template<typename T>\n"
1249                     "  requires(Foo<T>)\n"
1250                     "T foo();";
1251   BaseTokenCount = 11;
1252   RequiresTokenCount = 7;
1253   PrefixTokenCount = 5;
1254   TestRequires(__LINE__);
1255 
1256   BaseCode = "template<typename T>\n"
1257              "Bar(T) -> Bar<typename T::I>;";
1258   ConstrainedCode = "template<typename T>\n"
1259                     "  requires requires(T &&t) {\n"
1260                     "             typename T::I;\n"
1261                     "           }\n"
1262                     "Bar(T) -> Bar<typename T::I>;";
1263   BaseTokenCount = 19;
1264   RequiresTokenCount = 14;
1265   PrefixTokenCount = 5;
1266   TestRequires(__LINE__);
1267 
1268   BaseCode = "struct [[nodiscard]] zero_t {\n"
1269              "  template<class T>\n"
1270              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1271              "};";
1272   ConstrainedCode =
1273       "struct [[nodiscard]] zero_t {\n"
1274       "  template<class T>\n"
1275       "    requires requires { v<T>; }\n"
1276       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1277       "};";
1278   BaseTokenCount = 35;
1279   RequiresTokenCount = 9;
1280   PrefixTokenCount = 13;
1281   TestRequires(__LINE__);
1282 
1283   BaseCode = "constexpr Foo(Foo const &other)\n"
1284              "    : value{other.value} {\n"
1285              "  do_magic();\n"
1286              "  do_more_magic();\n"
1287              "}";
1288   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1289                     "  requires std::is_copy_constructible<T>\n"
1290                     "    : value{other.value} {\n"
1291                     "  do_magic();\n"
1292                     "  do_more_magic();\n"
1293                     "}";
1294   BaseTokenCount = 26;
1295   RequiresTokenCount = 7;
1296   PrefixTokenCount = 8;
1297   TestRequires(__LINE__);
1298 
1299   BaseCode = "constexpr Foo(Foo const &other)\n"
1300              "    : value{other.value} {\n"
1301              "  do_magic();\n"
1302              "  do_more_magic();\n"
1303              "}";
1304   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1305                     "  requires (std::is_copy_constructible<T>)\n"
1306                     "    : value{other.value} {\n"
1307                     "  do_magic();\n"
1308                     "  do_more_magic();\n"
1309                     "}";
1310   RequiresTokenCount = 9;
1311   TestRequires(__LINE__);
1312 }
1313 
1314 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1315   auto Tokens = annotate("__asm{\n"
1316                          "a:\n"
1317                          "};");
1318   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1319   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1320   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1321   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
1322 }
1323 
1324 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1325   auto Tokens = annotate("int (^)() = ^ ()\n"
1326                          "  external_source_symbol() { //\n"
1327                          "  return 1;\n"
1328                          "};");
1329   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1330   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1331   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1332 
1333   Tokens = annotate("int *p = ^int*(){ //\n"
1334                     "  return nullptr;\n"
1335                     "}();");
1336   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1337   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1338 }
1339 
1340 TEST_F(TokenAnnotatorTest, UnderstandsObjCMethodExpr) {
1341   auto Tokens = annotate("void f() {\n"
1342                          "  //\n"
1343                          "  BOOL a = [b.c n] > 1;\n"
1344                          "}");
1345   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
1346   EXPECT_TOKEN(Tokens[9], tok::l_square, TT_ObjCMethodExpr);
1347   EXPECT_TOKEN(Tokens[15], tok::greater, TT_BinaryOperator);
1348 }
1349 
1350 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1351   auto Tokens = annotate("[]() constexpr {}");
1352   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1353   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1354   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1355 
1356   Tokens = annotate("[]() consteval {}");
1357   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1358   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1359   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1360 
1361   Tokens = annotate("[]() mutable {}");
1362   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1363   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1364   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1365 
1366   Tokens = annotate("[]() static {}");
1367   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1368   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1369   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1370 
1371   Tokens = annotate("[]() -> auto {}");
1372   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1373   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1374   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1375   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1376 
1377   Tokens = annotate("[]() -> auto & {}");
1378   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1379   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1380   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1381   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1382 
1383   Tokens = annotate("[]() -> auto * {}");
1384   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1385   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1386   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1387   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1388 
1389   Tokens = annotate("[] {}");
1390   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1391   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1392   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1393 
1394   Tokens = annotate("[] noexcept {}");
1395   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1396   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1397   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1398 
1399   Tokens = annotate("[] -> auto {}");
1400   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1401   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1402   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_LambdaArrow);
1403   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1404 
1405   Tokens = annotate("[] <typename T> () {}");
1406   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1407   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1408   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1409   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1410 
1411   Tokens = annotate("[] <typename T> {}");
1412   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1413   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1414   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1415   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1416 
1417   Tokens = annotate("[] <typename... T> () {}");
1418   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1419   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1420   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1421   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1422 
1423   Tokens = annotate("[] <typename... T> {}");
1424   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1425   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1426   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1427   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1428 
1429   Tokens = annotate("[] <int... T> () {}");
1430   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1431   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1432   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1433   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1434 
1435   Tokens = annotate("[] <int... T> {}");
1436   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1437   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1438   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1439   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1440 
1441   Tokens = annotate("[] <Foo... T> () {}");
1442   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1443   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1444   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1445   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1446 
1447   Tokens = annotate("[] <Foo... T> {}");
1448   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1449   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1450   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1451   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1452 
1453   // Lambdas with a requires-clause
1454   Tokens = annotate("[] <typename T> (T t) requires Bar<T> {}");
1455   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1456   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1457   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1458   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1459   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1460   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1461 
1462   Tokens = annotate("[] <typename T> (T &&t) requires Bar<T> {}");
1463   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1464   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1465   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1466   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_PointerOrReference);
1467   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1468   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1469   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1470 
1471   Tokens = annotate("[] <typename T> (T t) requires Foo<T> || Bar<T> {}");
1472   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1473   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1474   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1475   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1476   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1477   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1478 
1479   Tokens = annotate("[] <typename T> (T t) -> T requires Bar<T> {}");
1480   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1481   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1482   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1483   EXPECT_TOKEN(Tokens[10], tok::arrow, TT_LambdaArrow);
1484   EXPECT_TOKEN(Tokens[12], tok::kw_requires, TT_RequiresClause);
1485   EXPECT_TRUE(Tokens[16]->ClosesRequiresClause);
1486   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1487 
1488   Tokens = annotate("[] <typename T> requires Bar<T> (T t) {}");
1489   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1490   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1491   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1492   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1493   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1494   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1495 
1496   Tokens = annotate("[] <typename T> requires Bar<T> (T &&t) {}");
1497   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1498   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1499   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1500   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1501   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1502   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_PointerOrReference);
1503   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1504 
1505   Tokens = annotate("[] <typename T> requires Foo<T> || Bar<T> (T t) {}");
1506   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1507   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1508   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1509   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1510   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1511   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1512 
1513   Tokens = annotate("[] <typename T> requires true (T&& t) {}");
1514   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1515   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1516   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1517   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1518   EXPECT_TRUE(Tokens[7]->ClosesRequiresClause);
1519   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1520   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1521 
1522   Tokens = annotate("[] <typename T> requires Bar<T> {}");
1523   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1524   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1525   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1526   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1527   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1528   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_LambdaLBrace);
1529 
1530   Tokens = annotate("[] <typename T> requires Bar<T> noexcept {}");
1531   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1532   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1533   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1534   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1535   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1536   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1537 
1538   Tokens = annotate("[] <typename T> requires Bar<T> -> T {}");
1539   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1540   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1541   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1542   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1543   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1544   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_LambdaArrow);
1545   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1546 
1547   Tokens = annotate("[] <typename T> requires Foo<T> (T t) requires Bar<T> {}");
1548   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1549   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1550   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1551   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1552   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1553   EXPECT_TOKEN(Tokens[15], tok::kw_requires, TT_RequiresClause);
1554   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1555   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1556 }
1557 
1558 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1559   auto Tokens = annotate("template <typename T>\n"
1560                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1561                          "string OldFunction(const string &parameter) {}");
1562   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1563   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1564 
1565   Tokens = annotate("template <typename T>\n"
1566                     "A(T) noexcept;");
1567   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1568   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1569 }
1570 
1571 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1572   auto Tokens = annotate("void f [[noreturn]] ();");
1573   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1574   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1575 
1576   Tokens = annotate("void f [[noreturn]] () {}");
1577   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1578   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1579 }
1580 
1581 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1582   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1583   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1584   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1585   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1586   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1587 }
1588 
1589 TEST_F(TokenAnnotatorTest, UnderstandsTrailingReturnArrow) {
1590   auto Tokens = annotate("auto f() -> int;");
1591   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1592   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1593 
1594   Tokens = annotate("auto operator->() -> int;");
1595   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1596   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_OverloadedOperator);
1597   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1598 
1599   Tokens = annotate("auto operator++(int) -> int;");
1600   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1601   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1602 
1603   Tokens = annotate("auto operator=() -> int;");
1604   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1605   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1606 
1607   Tokens = annotate("auto operator=(int) -> int;");
1608   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1609   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1610 
1611   Tokens = annotate("auto foo() -> auto { return Val; }");
1612   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1613   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1614 
1615   Tokens = annotate("struct S { auto bar() const -> int; };");
1616   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1617   EXPECT_TOKEN(Tokens[8], tok::arrow, TT_TrailingReturnArrow);
1618 
1619   // Not trailing return arrows
1620   Tokens = annotate("auto a = b->c;");
1621   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1622   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1623 
1624   Tokens = annotate("auto a = (b)->c;");
1625   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1626   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1627 
1628   Tokens = annotate("auto a = b()->c;");
1629   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1630   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1631 
1632   Tokens = annotate("auto a = b->c();");
1633   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1634   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1635 
1636   Tokens = annotate("decltype(auto) a = b()->c;");
1637   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1638   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1639 
1640   Tokens = annotate("void f() { auto a = b->c(); }");
1641   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1642   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1643 
1644   Tokens = annotate("void f() { auto a = b()->c; }");
1645   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1646   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_Unknown);
1647 
1648   // Mixed
1649   Tokens = annotate("auto f() -> int { auto a = b()->c; }");
1650   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1651   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1652   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
1653 }
1654 
1655 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
1656   auto Annotate = [this](llvm::StringRef Code) {
1657     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
1658   };
1659   // Test that unary operators get labeled as such and that operators like '++'
1660   // don't get split.
1661   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
1662                             tok::tilde, tok::amp,      tok::pipe,
1663                             tok::caret, tok::plusplus, tok::minusminus};
1664   for (auto Kind : Unary) {
1665     auto Tokens =
1666         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
1667     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1668     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
1669   }
1670   // Operators formed by joining two operators like '^~'. For some of these
1671   // joined operators, we don't have a separate type, so we only test for their
1672   // precedence.
1673   std::pair<prec::Level, std::string> JoinedBinary[] = {
1674       {prec::Comma, "<->"},       {prec::Assignment, "+="},
1675       {prec::Assignment, "-="},   {prec::Assignment, "*="},
1676       {prec::Assignment, "/="},   {prec::Assignment, "%="},
1677       {prec::Assignment, "&="},   {prec::Assignment, "^="},
1678       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
1679       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
1680       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
1681       {prec::Equality, "=="},     {prec::Equality, "!="},
1682       {prec::Equality, "==="},    {prec::Equality, "!=="},
1683       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
1684       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
1685   };
1686   for (auto Operator : JoinedBinary) {
1687     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
1688     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1689     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
1690     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
1691   }
1692   // '~^' and '^~' can be unary as well as binary operators.
1693   auto Tokens = Annotate("x = ~^x;");
1694   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1695   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1696   Tokens = Annotate("x = ^~x;");
1697   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1698   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1699   // The unary operators '~&' and '~|' can only be unary operators. The current
1700   // implementation treats each of them as separate unary '~' and '&' or '|'
1701   // operators, which is enough for formatting purposes. In FormatTestVerilog,
1702   // there is a test that there is no space in between. And even if a new line
1703   // is inserted between the '~' and '|', the semantic meaning is the same as
1704   // the joined operator, so the CanBreakBefore property doesn't need to be
1705   // false for the second operator.
1706   Tokens = Annotate("x = ~&x;");
1707   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1708   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1709   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
1710   Tokens = Annotate("x = ~|x;");
1711   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1712   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1713   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
1714   // Test for block label colons.
1715   Tokens = Annotate("begin : x\n"
1716                     "end : x");
1717   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1718   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
1719   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
1720   // Test that the dimension colon is annotated correctly.
1721   Tokens = Annotate("var [1 : 0] x;");
1722   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1723   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
1724   Tokens = Annotate("extern function [1 : 0] x;");
1725   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1726   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
1727   Tokens = Annotate("module test\n"
1728                     "    (input wire [7 : 0] a[7 : 0]);\n"
1729                     "endmodule");
1730   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1731   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_VerilogDimensionedTypeName);
1732   EXPECT_TOKEN(Tokens[7], tok::colon, TT_BitFieldColon);
1733   EXPECT_TOKEN(Tokens[13], tok::colon, TT_BitFieldColon);
1734   // Test case labels and ternary operators.
1735   Tokens = Annotate("case (x)\n"
1736                     "  x:\n"
1737                     "    x;\n"
1738                     "endcase\n");
1739   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1740   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CaseLabelColon);
1741   Tokens = Annotate("case (x)\n"
1742                     "  x ? x : x:\n"
1743                     "    x;\n"
1744                     "endcase\n");
1745   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1746   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
1747   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
1748   EXPECT_TOKEN(Tokens[9], tok::colon, TT_CaseLabelColon);
1749   // Non-blocking assignments.
1750   Tokens = Annotate("a <= b;");
1751   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1752   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1753   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1754   Tokens = Annotate("if (a <= b) break;");
1755   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1756   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1757   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1758   Tokens = Annotate("a <= b <= a;");
1759   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1760   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1761   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1762   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1763   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1764 
1765   // Port lists in module instantiation.
1766   Tokens = Annotate("module_x instance_1(port_1), instance_2(port_2);");
1767   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1768   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
1769   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_VerilogInstancePortLParen);
1770   Tokens = Annotate("module_x #(parameter) instance_1(port_1), "
1771                     "instance_2(port_2);");
1772   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1773   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
1774   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_VerilogInstancePortLParen);
1775   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_VerilogInstancePortLParen);
1776 
1777   // Condition parentheses.
1778   Tokens = Annotate("assert (x);");
1779   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1780   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1781   Tokens = Annotate("assert #0 (x);");
1782   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1783   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_ConditionLParen);
1784   Tokens = Annotate("assert final (x);");
1785   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1786   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
1787   Tokens = Annotate("foreach (x[x]) continue;");
1788   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1789   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1790   Tokens = Annotate("repeat (x[x]) continue;");
1791   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1792   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1793   Tokens = Annotate("case (x) endcase;");
1794   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1795   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1796 
1797   // Sensitivity list. The TT_Unknown type is clearly not binding for the
1798   // future, please adapt if those tokens get annotated.  This test is only here
1799   // to prevent the comma from being annotated as TT_VerilogInstancePortComma.
1800   Tokens = Annotate("always @(posedge x, posedge y);");
1801   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1802   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_Unknown);
1803   EXPECT_TOKEN(Tokens[5], tok::comma, TT_Unknown);
1804   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1805 }
1806 
1807 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
1808   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
1809 
1810   // The TT_Unknown is clearly not binding for the future, please adapt if those
1811   // tokens get annotated.
1812   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1813   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1814   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1815   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
1816   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1817   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1818   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1819   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
1820   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
1821   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1822 
1823   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
1824   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1825   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1826   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1827   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
1828   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
1829   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1830   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1831   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
1832   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
1833   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1834 }
1835 
1836 TEST_F(TokenAnnotatorTest, UnderstandsConditionParens) {
1837   auto Tokens = annotate("if (x) {}");
1838   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1839   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1840   Tokens = annotate("if constexpr (x) {}");
1841   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1842   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
1843   Tokens = annotate("if CONSTEXPR (x) {}");
1844   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1845   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
1846   Tokens = annotate("if (x) {} else if (x) {}");
1847   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1848   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1849   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_ConditionLParen);
1850 }
1851 
1852 TEST_F(TokenAnnotatorTest, CSharpNullableTypes) {
1853   FormatStyle Style = getGoogleStyle(FormatStyle::LK_CSharp);
1854 
1855   auto Tokens = annotate("int? a;", Style);
1856   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
1857   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1858 
1859   Tokens = annotate("int? a = 1;", Style);
1860   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
1861   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1862 
1863   Tokens = annotate("int?)", Style);
1864   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
1865   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1866 
1867   Tokens = annotate("int?>", Style);
1868   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
1869   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1870 
1871   Tokens = annotate("cond? id : id2", Style);
1872   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
1873   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
1874 
1875   Tokens = annotate("cond ? cond2 ? : id1 : id2", Style);
1876   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
1877   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
1878 }
1879 
1880 TEST_F(TokenAnnotatorTest, UnderstandsLabels) {
1881   auto Tokens = annotate("{ x: break; }");
1882   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1883   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
1884   Tokens = annotate("{ case x: break; }");
1885   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1886   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
1887   Tokens = annotate("{ x: { break; } }");
1888   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1889   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
1890   Tokens = annotate("{ case x: { break; } }");
1891   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1892   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
1893 }
1894 
1895 TEST_F(TokenAnnotatorTest, UnderstandsNestedBlocks) {
1896   // The closing braces are not annotated. It doesn't seem to cause a problem.
1897   // So we only test for the opening braces.
1898   auto Tokens = annotate("{\n"
1899                          "  {\n"
1900                          "    { int a = 0; }\n"
1901                          "  }\n"
1902                          "  {}\n"
1903                          "}");
1904   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1905   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
1906   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
1907   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
1908   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
1909 }
1910 
1911 } // namespace
1912 } // namespace format
1913 } // namespace clang
1914