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