xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision 834ac2e205dd8e492d6084a7952e68e19a1f54db)
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(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   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
88   EXPECT_TOKEN(Tokens[1], tok::star, TT_UnaryOperator);
89   Tokens = annotate("case &x:");
90   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
91   EXPECT_TOKEN(Tokens[1], tok::amp, TT_UnaryOperator);
92 
93   Tokens = annotate("bool b = 3 == int{3} && true;");
94   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
95   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
96 
97   Tokens = annotate("struct {\n"
98                     "} *ptr;");
99   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
100   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
101   Tokens = annotate("union {\n"
102                     "} *ptr;");
103   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
104   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
105   Tokens = annotate("class {\n"
106                     "} *ptr;");
107   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
108   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
109 
110   Tokens = annotate("struct {\n"
111                     "} &&ptr = {};");
112   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
113   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
114   Tokens = annotate("union {\n"
115                     "} &&ptr = {};");
116   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
117   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
118   Tokens = annotate("class {\n"
119                     "} &&ptr = {};");
120   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
121   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
122   Tokens = annotate("int i = int{42} * 2;");
123   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
124   EXPECT_TOKEN(Tokens[7], tok::star, TT_BinaryOperator);
125 
126   Tokens = annotate("delete[] *ptr;");
127   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
128   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
129   Tokens = annotate("delete[] **ptr;");
130   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_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   Tokens =
277       annotate("auto foo() noexcept(noexcept(bar()) && "
278                "trait<std::decay_t<decltype(bar())>> && noexcept(baz())) {}");
279   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
280   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_BinaryOperator);
281   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
282 
283   Tokens = annotate("foo = *i < *j && *j > *k;");
284   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
285   EXPECT_TOKEN(Tokens[4], tok::less, TT_BinaryOperator);
286   EXPECT_TOKEN(Tokens[7], tok::ampamp, TT_BinaryOperator);
287   EXPECT_TOKEN(Tokens[10], tok::greater, TT_BinaryOperator);
288 
289   FormatStyle Style = getLLVMStyle();
290   Style.TypeNames.push_back("MYI");
291   Tokens = annotate("if (MYI *p{nullptr})", Style);
292   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
293   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_TypeName);
294   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
295 
296   Style.TypeNames.push_back("Class");
297   Tokens = annotate("if (Class *obj {getObj()})", Style);
298   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
299   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_TypeName);
300   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
301 
302   Tokens = annotate("class Foo {\n"
303                     "  void operator<() {}\n"
304                     "  Foo &f;\n"
305                     "};");
306   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
307   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
308   EXPECT_TOKEN(Tokens[5], tok::less, TT_OverloadedOperator);
309   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_OverloadedOperatorLParen);
310   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_FunctionLBrace);
311   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
312 
313   Tokens = annotate("if (new && num) {\n"
314                     "  new = 1;\n"
315                     "}\n"
316                     "if (!delete && num) {\n"
317                     "  delete = 1;\n"
318                     "}");
319   ASSERT_EQ(Tokens.size(), 26u) << Tokens;
320   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_BinaryOperator);
321   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
322 }
323 
324 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) {
325   auto Tokens = annotate("x - 0");
326   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
327   EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator);
328   Tokens = annotate("0 + 0");
329   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
330   EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator);
331   Tokens = annotate("x + +0");
332   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
333   EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator);
334   Tokens = annotate("x ? -0 : +0");
335   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
336   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
337   EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator);
338   Tokens = annotate("(-0)");
339   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
340   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
341   Tokens = annotate("0, -0");
342   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
343   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
344   Tokens = annotate("for (; -1;) {\n}");
345   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
346   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
347   Tokens = annotate("x = -1;");
348   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
349   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
350   Tokens = annotate("x[-1]");
351   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
352   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
353   Tokens = annotate("x = {-1};");
354   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
355   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
356   Tokens = annotate("case -x:");
357   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
358   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
359   Tokens = annotate("co_await -x;");
360   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
361   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
362   Tokens = annotate("co_return -x;");
363   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
364   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
365   Tokens = annotate("co_yield -x;");
366   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
367   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
368   Tokens = annotate("delete -x;");
369   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
370   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
371   Tokens = annotate("return -x;");
372   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
373   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
374   Tokens = annotate("throw -x;");
375   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
376   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
377   Tokens = annotate("sizeof -x");
378   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
379   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
380   Tokens = annotate("co_await +x;");
381   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
382   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
383   Tokens = annotate("co_return +x;");
384   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
385   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
386   Tokens = annotate("co_yield +x;");
387   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
388   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
389   Tokens = annotate("delete +x;");
390   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
391   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
392   Tokens = annotate("return +x;");
393   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
394   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
395   Tokens = annotate("throw +x;");
396   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
397   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
398   Tokens = annotate("sizeof +x");
399   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
400   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
401   Tokens = annotate("(int)-x");
402   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
403   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
404   Tokens = annotate("(-x)");
405   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
406   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
407   Tokens = annotate("!+x");
408   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
409   EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator);
410   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
411 }
412 
413 TEST_F(TokenAnnotatorTest, UnderstandsClasses) {
414   auto Tokens = annotate("class C {};");
415   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
416   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
417   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_ClassRBrace);
418 
419   Tokens = annotate("const class C {} c;");
420   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
421   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace);
422   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_ClassRBrace);
423 
424   Tokens = annotate("const class {} c;");
425   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
426   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
427   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_ClassRBrace);
428 
429   Tokens = annotate("class [[deprecated(\"\")]] C { int i; };");
430   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
431   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_ClassLBrace);
432   EXPECT_TOKEN(Tokens[14], tok::r_brace, TT_ClassRBrace);
433 }
434 
435 TEST_F(TokenAnnotatorTest, UnderstandsStructs) {
436   auto Tokens = annotate("struct S {};");
437   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
438   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace);
439   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_StructRBrace);
440 
441   Tokens = annotate("struct macro(a) S {};");
442   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
443   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_StructLBrace);
444   EXPECT_TOKEN(Tokens[7], tok::r_brace, TT_StructRBrace);
445 
446   Tokens = annotate("struct EXPORT_MACRO [[nodiscard]] C { int i; };");
447   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
448   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_StructLBrace);
449   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_StructRBrace);
450 
451   Tokens = annotate("struct [[deprecated]] [[nodiscard]] C { int i; };");
452   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
453   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_StructLBrace);
454   EXPECT_TOKEN(Tokens[16], tok::r_brace, TT_StructRBrace);
455 
456   Tokens = annotate("struct macro(a) S {\n"
457                     "  void f(T &t);\n"
458                     "};");
459   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
460   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_StructLBrace);
461   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
462   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_StructRBrace);
463 
464   Tokens = annotate("template <typename T> struct S<const T[N]> {};");
465   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
466   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
467   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
468   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
469   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
470   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_StructRBrace);
471 
472   Tokens = annotate("template <typename T> struct S<T const[N]> {};");
473   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
474   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
475   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
476   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
477   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
478   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_StructRBrace);
479 
480   Tokens = annotate("template <typename T, unsigned n> struct S<T const[n]> {\n"
481                     "  void f(T const (&a)[n]);\n"
482                     "};");
483   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
484   EXPECT_TOKEN(Tokens[10], tok::less, TT_TemplateOpener);
485   EXPECT_TOKEN(Tokens[13], tok::l_square, TT_ArraySubscriptLSquare);
486   EXPECT_TOKEN(Tokens[16], tok::greater, TT_TemplateCloser);
487   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_StructLBrace);
488   EXPECT_TOKEN(Tokens[23], tok::l_paren, TT_FunctionTypeLParen);
489   EXPECT_TOKEN(Tokens[24], tok::amp, TT_UnaryOperator);
490   EXPECT_TOKEN(Tokens[27], tok::l_square, TT_ArraySubscriptLSquare);
491   EXPECT_TOKEN(Tokens[32], tok::r_brace, TT_StructRBrace);
492 
493   Tokens = annotate("template <typename T, enum E e> struct S {};");
494   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
495   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_StructLBrace);
496 
497   auto Style = getLLVMStyle();
498   Style.AttributeMacros.push_back("EXPORT");
499   Tokens = annotate("struct EXPORT StructName {};", Style);
500   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
501   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_AttributeMacro);
502   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_StructLBrace);
503   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_StructRBrace);
504 }
505 
506 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
507   auto Tokens = annotate("union U {};");
508   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
509   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
510   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_UnionRBrace);
511 
512   Tokens = annotate("union U { void f() { return; } };");
513   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
514   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
515   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
516   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_UnionRBrace);
517 }
518 
519 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
520   auto Tokens = annotate("enum E {};");
521   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
522   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
523   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_EnumRBrace);
524 }
525 
526 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
527   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
528   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
529   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
530 
531   Tokens = annotate("template <typename T> void F(T) && = delete;");
532   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
533   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
534 }
535 
536 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
537   auto Tokens =
538       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
539   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
540   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
541 }
542 
543 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
544   auto Tokens =
545       annotate("template <typename T> "
546                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
547   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
548   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
549 }
550 
551 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) {
552   auto Tokens =
553       annotate("#define FOO(typeName) \\\n"
554                "  { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }");
555   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
556   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
557   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
558   EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener);
559   EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser);
560 }
561 
562 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) {
563   auto Tokens = annotate("if (std::tuple_size_v<T> > 0)");
564   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
565   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
566   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
567   EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator);
568 }
569 
570 TEST_F(TokenAnnotatorTest, UnderstandsTernaryInTemplate) {
571   // IsExpression = false
572   auto Tokens = annotate("foo<true ? 1 : 2>();");
573   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
574   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
575   EXPECT_TOKEN(Tokens[3], tok::question, TT_ConditionalExpr);
576   EXPECT_TOKEN(Tokens[5], tok::colon, TT_ConditionalExpr);
577   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
578 
579   // IsExpression = true
580   Tokens = annotate("return foo<true ? 1 : 2>();");
581   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
582   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
583   EXPECT_TOKEN(Tokens[4], tok::question, TT_ConditionalExpr);
584   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ConditionalExpr);
585   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
586 }
587 
588 TEST_F(TokenAnnotatorTest, UnderstandsNonTemplateAngleBrackets) {
589   auto Tokens = annotate("return a < b && c > d;");
590   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
591   EXPECT_TOKEN(Tokens[2], tok::less, TT_BinaryOperator);
592   EXPECT_TOKEN(Tokens[6], tok::greater, TT_BinaryOperator);
593 
594   Tokens = annotate("a < 0 ? b : a > 0 ? c : d;");
595   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
596   EXPECT_TOKEN(Tokens[1], tok::less, TT_BinaryOperator);
597   EXPECT_TOKEN(Tokens[7], tok::greater, TT_BinaryOperator);
598 
599   Tokens = annotate("ratio{-1, 2} < ratio{-1, 3} == -1 / 3 > -1 / 2;");
600   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
601   EXPECT_TOKEN(Tokens[7], tok::less, TT_BinaryOperator);
602   EXPECT_TOKEN(Tokens[20], tok::greater, TT_BinaryOperator);
603 }
604 
605 TEST_F(TokenAnnotatorTest, UnderstandsTemplateTemplateParameters) {
606   auto Tokens = annotate("template <template <typename...> typename X,\n"
607                          "          template <typename...> class Y,\n"
608                          "          typename... T>\n"
609                          "class A {};");
610   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
611   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
612   EXPECT_TOKEN(Tokens[3], tok::less, TT_TemplateOpener);
613   EXPECT_TOKEN(Tokens[6], tok::greater, TT_TemplateCloser);
614   EXPECT_FALSE(Tokens[6]->ClosesTemplateDeclaration);
615   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
616   EXPECT_TOKEN(Tokens[14], tok::greater, TT_TemplateCloser);
617   EXPECT_FALSE(Tokens[14]->ClosesTemplateDeclaration);
618   EXPECT_TOKEN(Tokens[21], tok::greater, TT_TemplateCloser);
619   EXPECT_TRUE(Tokens[21]->ClosesTemplateDeclaration);
620 }
621 
622 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
623   FormatStyle Style = getLLVMStyle();
624   Style.WhitespaceSensitiveMacros.push_back("FOO");
625 
626   auto Tokens = annotate("FOO(1+2 )", Style);
627   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
628   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
629 
630   Tokens = annotate("FOO(a:b:c)", Style);
631   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
632   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
633 }
634 
635 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
636   auto Tokens = annotate("delete (void *)p;");
637   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
638   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
639 
640   Tokens = annotate("delete[] (void *)p;");
641   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
642   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
643 
644   Tokens = annotate("delete[] /*comment*/ (void *)p;");
645   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
646   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
647 
648   Tokens = annotate("delete[/*comment*/] (void *)p;");
649   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
650   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
651 
652   Tokens = annotate("delete/*comment*/[] (void *)p;");
653   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
654   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
655 }
656 
657 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
658   auto Tokens = annotate("(void)p;");
659   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
660   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
661 
662   Tokens = annotate("(uint32_t)&&label;");
663   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
664   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
665   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_UnaryOperator);
666   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
667 
668   Tokens = annotate("auto x = (Foo)p;");
669   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
670   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
671 
672   Tokens = annotate("(std::vector<int>)p;");
673   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
674   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
675 
676   Tokens = annotate("return (Foo)p;");
677   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
678   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
679 
680   Tokens = annotate("throw (Foo)p;");
681   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
682   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
683 
684   Tokens = annotate("#define FOO(x) (((uint64_t)(x) * BAR) / 100)");
685   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
686   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
687   EXPECT_TOKEN(Tokens[13], tok::r_paren, TT_Unknown);
688   EXPECT_TOKEN(Tokens[14], tok::star, TT_BinaryOperator);
689 
690   Tokens = annotate("#define foo(i) ((i) - bar)");
691   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
692   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_Unknown);
693   EXPECT_TOKEN(Tokens[10], tok::minus, TT_BinaryOperator);
694 
695   Tokens = annotate("return (Foo) & 10;");
696   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
697   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_Unknown);
698   EXPECT_TOKEN(Tokens[4], tok::amp, TT_BinaryOperator);
699 
700   Tokens = annotate("return (struct foo){};");
701   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
702   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
703 
704   Tokens = annotate("#define FOO(bar) foo((uint64_t)&bar)");
705   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
706   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
707   EXPECT_TOKEN(Tokens[11], tok::amp, TT_UnaryOperator);
708 
709   Tokens = annotate("#define FOO(bar) foo((Foo) & bar)");
710   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
711   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_Unknown);
712   EXPECT_TOKEN(Tokens[11], tok::amp, TT_BinaryOperator);
713 
714   auto Style = getLLVMStyle();
715   Style.TypeNames.push_back("Foo");
716   Tokens = annotate("#define FOO(bar) foo((Foo)&bar)", Style);
717   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
718   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_TypeName);
719   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
720   EXPECT_TOKEN(Tokens[11], tok::amp, TT_UnaryOperator);
721 }
722 
723 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
724   auto Tokens = annotate("void f() throw(int);");
725   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
726   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
727 }
728 
729 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
730   auto Tokens = annotate("void f() &;");
731   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
732   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
733 
734   Tokens = annotate("void operator=(T) &&;");
735   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
736   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
737 
738   Tokens = annotate("template <typename T> void f() &;");
739   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
740   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
741 
742   Tokens = annotate("template <typename T> void operator=(T) &;");
743   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
744   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
745 }
746 
747 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
748   auto Tokens = annotate("x.operator+()");
749   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
750   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
751   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
752   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
753   Tokens = annotate("x.operator=()");
754   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
755   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
756   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
757   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
758   Tokens = annotate("x.operator+=()");
759   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
760   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
761   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
762   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
763   Tokens = annotate("x.operator,()");
764   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
765   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
766   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
767   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
768   Tokens = annotate("x.operator()()");
769   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
770   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
771   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
772   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
773   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
774   Tokens = annotate("x.operator[]()");
775   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
776   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
777   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
778   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
779   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
780   Tokens = annotate("x.operator\"\"_a()");
781   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
782   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
783   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
784   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
785   Tokens = annotate("x.operator\"\" _a()");
786   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
787   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
788   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
789   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
790   Tokens = annotate("x.operator\"\"if()");
791   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
792   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
793   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
794   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
795   Tokens = annotate("x.operator\"\"s()");
796   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
797   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
798   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
799   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
800   Tokens = annotate("x.operator\"\" s()");
801   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
802   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
803   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
804   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
805 
806   Tokens = annotate("int operator+(int);");
807   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
808   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
809   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
810   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
811   Tokens = annotate("auto operator=(T&) {}");
812   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
813   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
814   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
815   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
816   Tokens = annotate("auto operator()() {}");
817   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
818   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
819   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
820   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
821   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
822 
823   Tokens = annotate("class Foo {\n"
824                     "  int operator+(a* b);\n"
825                     "}");
826   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
827   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
828   EXPECT_TOKEN(Tokens[5], tok::plus, TT_OverloadedOperator);
829   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_OverloadedOperatorLParen);
830   EXPECT_TOKEN(Tokens[8], tok::star, TT_PointerOrReference);
831 
832   Tokens = annotate("class Foo {\n"
833                     "  int c = operator+(a * b);\n"
834                     "}");
835   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
836   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_Unknown);
837   EXPECT_TOKEN(Tokens[7], tok::plus, TT_OverloadedOperator);
838   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_OverloadedOperatorLParen);
839   EXPECT_TOKEN(Tokens[10], tok::star, TT_BinaryOperator);
840 
841   Tokens = annotate("void foo() {\n"
842                     "  operator+(a * b);\n"
843                     "}");
844   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
845   EXPECT_TOKEN(Tokens[5], tok::kw_operator, TT_Unknown);
846   EXPECT_TOKEN(Tokens[6], tok::plus, TT_OverloadedOperator);
847   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
848   EXPECT_TOKEN(Tokens[9], tok::star, TT_BinaryOperator);
849 
850   Tokens = annotate("return operator+(a * b, c & d) + operator+(a && b && c);");
851   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
852   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_Unknown);
853   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
854   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
855   EXPECT_TOKEN(Tokens[5], tok::star, TT_BinaryOperator);
856   EXPECT_TOKEN(Tokens[9], tok::amp, TT_BinaryOperator);
857   EXPECT_TOKEN(Tokens[13], tok::kw_operator, TT_Unknown);
858   EXPECT_TOKEN(Tokens[14], tok::plus, TT_OverloadedOperator);
859   EXPECT_TOKEN(Tokens[15], tok::l_paren, TT_OverloadedOperatorLParen);
860   EXPECT_TOKEN(Tokens[17], tok::ampamp, TT_BinaryOperator);
861   EXPECT_TOKEN(Tokens[19], tok::ampamp, TT_BinaryOperator);
862 
863   Tokens = annotate("class Foo {\n"
864                     "  void foo() {\n"
865                     "    operator+(a * b);\n"
866                     "  }\n"
867                     "}");
868   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
869   EXPECT_TOKEN(Tokens[8], tok::kw_operator, TT_Unknown);
870   EXPECT_TOKEN(Tokens[9], tok::plus, TT_OverloadedOperator);
871   EXPECT_TOKEN(Tokens[10], tok::l_paren, TT_OverloadedOperatorLParen);
872   EXPECT_TOKEN(Tokens[12], tok::star, TT_BinaryOperator);
873 
874   Tokens = annotate("std::vector<Foo> operator()(Foo &foo);");
875   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
876   EXPECT_TOKEN(Tokens[3], tok::less, TT_TemplateOpener);
877   EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
878   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_FunctionDeclarationName);
879   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperator);
880   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_OverloadedOperator);
881   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_OverloadedOperatorLParen);
882   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
883 
884   Tokens = annotate("decltype(auto) operator()(T &x);");
885   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
886   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_TypeDeclarationParen);
887   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_TypeDeclarationParen);
888   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
889   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperator);
890   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_OverloadedOperator);
891   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
892   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
893 }
894 
895 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
896   struct {
897     const char *Text;
898     tok::TokenKind Kind;
899   } Operators[] = {{"+", tok::plus},
900                    {"-", tok::minus},
901                    // FIXME:
902                    // {"*", tok::star},
903                    {"/", tok::slash},
904                    {"%", tok::percent},
905                    {"^", tok::caret},
906                    // FIXME:
907                    // {"&", tok::amp},
908                    {"|", tok::pipe},
909                    {"~", tok::tilde},
910                    {"!", tok::exclaim},
911                    {"=", tok::equal},
912                    // FIXME:
913                    // {"<", tok::less},
914                    {">", tok::greater},
915                    {"+=", tok::plusequal},
916                    {"-=", tok::minusequal},
917                    {"*=", tok::starequal},
918                    {"/=", tok::slashequal},
919                    {"%=", tok::percentequal},
920                    {"^=", tok::caretequal},
921                    {"&=", tok::ampequal},
922                    {"|=", tok::pipeequal},
923                    {"<<", tok::lessless},
924                    {">>", tok::greatergreater},
925                    {">>=", tok::greatergreaterequal},
926                    {"<<=", tok::lesslessequal},
927                    {"==", tok::equalequal},
928                    {"!=", tok::exclaimequal},
929                    {"<=", tok::lessequal},
930                    {">=", tok::greaterequal},
931                    {"<=>", tok::spaceship},
932                    {"&&", tok::ampamp},
933                    {"||", tok::pipepipe},
934                    {"++", tok::plusplus},
935                    {"--", tok::minusminus},
936                    {",", tok::comma},
937                    {"->*", tok::arrowstar},
938                    {"->", tok::arrow}};
939 
940   for (const auto &Operator : Operators) {
941     std::string Input("C<&operator");
942     Input += Operator.Text;
943     Input += " > a;";
944     auto Tokens = annotate(std::string(Input));
945     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
946     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
947     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
948     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
949   }
950 
951   auto Tokens = annotate("C<&operator< <X>> lt;");
952   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
953   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
954   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
955   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
956   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
957   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
958 }
959 
960 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
961   auto Tokens = annotate("template <typename T>\n"
962                          "concept C = (Foo && Bar) && (Bar && Baz);");
963 
964   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
965   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
966   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
967   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
968 
969   Tokens = annotate("template <typename T>\n"
970                     "concept C = Foo && !Bar;");
971 
972   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
973   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
974   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
975 
976   Tokens = annotate("template <typename T>\n"
977                     "concept C = requires(T t) {\n"
978                     "  { t.foo() };\n"
979                     "} && Bar<T> && Baz<T>;");
980   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
981   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
982   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
983   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
984   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
985   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
986 
987   Tokens = annotate("template<typename T>\n"
988                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
989                     "struct Foo;");
990   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
991   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
992   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
993   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
994   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
995   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
996   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
997   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
998   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
999   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
1000   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
1001 
1002   Tokens =
1003       annotate("template<typename T>\n"
1004                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
1005                "struct Foo;");
1006   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
1007   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1008   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
1009   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
1010   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
1011   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
1012   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
1013   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
1014   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
1015   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
1016   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
1017   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
1018 
1019   Tokens = annotate("template <typename T>\n"
1020                     "void foo(T) noexcept requires Bar<T>;");
1021   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1022   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1023 
1024   Tokens = annotate("template <typename T>\n"
1025                     "requires Bar<T> || Baz<T>\n"
1026                     "auto foo(T) -> int;");
1027   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
1028   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1029   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
1030   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1031   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
1032 
1033   Tokens = annotate("template <typename T>\n"
1034                     "requires Bar<T>\n"
1035                     "bool foo(T) { return false; }");
1036   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1037   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1038   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
1039   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
1040 
1041   Tokens = annotate("template <typename T>\n"
1042                     "requires Bar<T>\n"
1043                     "decltype(auto) foo(T) { return false; }");
1044   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
1045   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1046   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
1047   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
1048 
1049   Tokens = annotate("template <typename T>\n"
1050                     "struct S {\n"
1051                     "  void foo() const requires Bar<T>;\n"
1052                     "  void bar() const & requires Baz<T>;\n"
1053                     "  void bar() && requires Baz2<T>;\n"
1054                     "  void baz() const & noexcept requires Baz<T>;\n"
1055                     "  void baz() && noexcept requires Baz2<T>;\n"
1056                     "};\n"
1057                     "\n"
1058                     "void S::bar() const & requires Baz<T> { }");
1059   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
1060   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
1061   EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference);
1062   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
1063   EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference);
1064   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
1065   EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference);
1066   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
1067   EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference);
1068   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
1069   EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference);
1070   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
1071 
1072   Tokens = annotate("void Class::member() && requires(Constant) {}");
1073   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1074   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1075 
1076   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
1077   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1078   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1079 
1080   Tokens =
1081       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
1082   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1083   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1084 
1085   Tokens = annotate("void Class::member() && requires(typename "
1086                     "Namespace::Outer<T>::Inner::Constant) {}");
1087   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
1088   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1089 
1090   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
1091                     "  template<class T>\n"
1092                     "    requires requires { number_zero_v<T>; }\n"
1093                     "  [[nodiscard]] constexpr operator T() const { "
1094                     "return number_zero_v<T>; }\n"
1095                     "};");
1096   ASSERT_EQ(Tokens.size(), 44u) << Tokens;
1097   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
1098   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
1099   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
1100   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
1101   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
1102   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
1103 
1104   Tokens =
1105       annotate("template <class A, class B> concept C ="
1106                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
1107   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
1108   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
1109   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
1110   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
1111   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
1112   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
1113   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
1114   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
1115 
1116   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
1117   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1118   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1119 
1120   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
1121   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1122   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1123 
1124   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
1125   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1126   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1127 
1128   Tokens =
1129       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
1130   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1131   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1132 
1133   Tokens =
1134       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
1135   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1136   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1137 
1138   Tokens =
1139       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
1140   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1141   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
1142 
1143   Tokens = annotate("void foo() requires((A<T>) && C) {}");
1144   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1145   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1146   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_BinaryOperator);
1147 
1148   Tokens = annotate("void foo() requires(((A<T>) && C)) {}");
1149   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1150   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1151   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
1152 
1153   Tokens = annotate("void foo() requires([](T&&){}(t)) {}");
1154   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1155   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1156   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1157 
1158   Tokens = annotate("void foo() requires([](T&& u){}(t)) {}");
1159   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
1160   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1161   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1162 
1163   Tokens = annotate("void f() & requires(true) {}");
1164   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1165   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1166   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1167 
1168   Tokens = annotate("void f() & requires(C<true, true>) {}");
1169   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1170   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1171   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1172 
1173   Tokens = annotate("template <typename T>\n"
1174                     "concept C = (!Foo<T>) && Bar;");
1175   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1176   EXPECT_TOKEN(Tokens[15], tok::ampamp, TT_BinaryOperator);
1177 
1178   Tokens = annotate("void f() & requires(C<decltype(x)>) {}");
1179   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1180   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1181   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1182 
1183   Tokens = annotate("auto f() -> int& requires(C<decltype(x)>) {}");
1184   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1185   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1186   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1187 
1188   Tokens = annotate("bool x = t && requires(decltype(t) x) { x.foo(); };");
1189   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1190   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresExpression);
1191 
1192   Tokens = annotate("bool x = t && requires(Foo<decltype(t)> x) { x.foo(); };");
1193   ASSERT_EQ(Tokens.size(), 26u) << Tokens;
1194   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresExpression);
1195 
1196   Tokens = annotate("bool x = t && requires(Foo<C1 || C2> x) { x.foo(); };");
1197   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1198   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresExpression);
1199 }
1200 
1201 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
1202   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
1203   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1204   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1205   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1206   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1207 
1208   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
1209   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1210   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1211   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1212   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
1213 
1214   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
1215   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1216   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
1217   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
1218   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
1219 
1220   Tokens = annotate("foo(requires(const T t) {});");
1221   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1222   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1223   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1224   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1225 
1226   Tokens = annotate("foo(requires(const int t) {});");
1227   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1228   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1229   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1230   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1231 
1232   Tokens = annotate("foo(requires(const T t) {});");
1233   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1234   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1235   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1236   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1237 
1238   Tokens = annotate("foo(requires(int const* volatile t) {});");
1239   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1240   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1241   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1242   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1243   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1244 
1245   Tokens = annotate("foo(requires(T const* volatile t) {});");
1246   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1247   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1248   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1249   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1250   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1251 
1252   Tokens = annotate("foo(requires(T& t) {});");
1253   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1254   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1255   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1256   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
1257   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1258 
1259   Tokens = annotate("foo(requires(T&& t) {});");
1260   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1261   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1262   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1263   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
1264   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1265 
1266   Tokens = annotate("bool foo = requires(T& t) {};");
1267   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1268   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1269   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1270   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1271   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1272 
1273   Tokens = annotate("bool foo = requires(T&& t) {};");
1274   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1275   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1276   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1277   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
1278   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1279 
1280   Tokens =
1281       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
1282   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1283   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1284   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1285   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
1286   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
1287 
1288   Tokens = annotate("template <typename T>\n"
1289                     "concept C = requires(T T) {\n"
1290                     "  requires Bar<T> && Foo<T>;\n"
1291                     "};");
1292   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
1293   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1294   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1295   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1296   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
1297                TT_RequiresClauseInARequiresExpression);
1298 
1299   Tokens = annotate("template <typename T>\n"
1300                     "concept C = requires(T T) {\n"
1301                     "  { t.func() } -> std::same_as<int>;"
1302                     "  requires Bar<T> && Foo<T>;\n"
1303                     "};");
1304   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
1305   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1306   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1307   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1308   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
1309                TT_RequiresClauseInARequiresExpression);
1310 
1311   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
1312   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
1313                     "requires true; };");
1314   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1315   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1316   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1317   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
1318 
1319   Tokens = annotate("bool foo = requires(C<true, true> c) {\n"
1320                     "  { c.foo(); }\n"
1321                     "};");
1322   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1323   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1324   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1325   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1326 }
1327 
1328 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
1329   // Everything after #pragma region should be ImplicitStringLiteral
1330   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
1331   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1332   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
1333   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
1334   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
1335 
1336   // Make sure it's annotated correctly inside a function as well
1337   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
1338   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1339   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
1340   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
1341   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
1342 }
1343 
1344 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
1345   const char *BaseCode = nullptr;
1346   const char *ConstrainedCode = nullptr;
1347   auto BaseTokenCount = 0u;
1348   auto RequiresTokenCount = 0u;
1349   auto PrefixTokenCount = 0u;
1350 
1351   auto TestRequires = [&](int Line) {
1352     const auto BaseTokens = annotate(BaseCode);
1353     const auto ConstrainedTokens = annotate(ConstrainedCode);
1354 
1355 #define LINE " (Line " << Line << ')'
1356 
1357     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
1358     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
1359         << LINE;
1360 
1361     for (auto I = 0u; I < BaseTokenCount; ++I) {
1362       EXPECT_EQ(
1363           *BaseTokens[I],
1364           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
1365           << I << LINE;
1366     }
1367 
1368 #undef LINE
1369   };
1370 
1371   BaseCode = "template<typename T>\n"
1372              "T Pi = 3.14;";
1373   ConstrainedCode = "template<typename T>\n"
1374                     "  requires Foo<T>\n"
1375                     "T Pi = 3.14;";
1376   BaseTokenCount = 11;
1377   RequiresTokenCount = 5;
1378   PrefixTokenCount = 5;
1379   TestRequires(__LINE__);
1380 
1381   BaseCode = "template<typename T>\n"
1382              "struct Bar;";
1383   ConstrainedCode = "template<typename T>\n"
1384                     "  requires Foo<T>\n"
1385                     "struct Bar;";
1386   BaseTokenCount = 9;
1387   TestRequires(__LINE__);
1388 
1389   BaseCode = "template<typename T>\n"
1390              "struct Bar {\n"
1391              "  T foo();\n"
1392              "  T bar();\n"
1393              "};";
1394   ConstrainedCode = "template<typename T>\n"
1395                     "  requires Foo<T>\n"
1396                     "struct Bar {\n"
1397                     "  T foo();\n"
1398                     "  T bar();\n"
1399                     "};";
1400   BaseTokenCount = 21;
1401   TestRequires(__LINE__);
1402 
1403   BaseCode = "template<typename T>\n"
1404              "Bar(T) -> Bar<T>;";
1405   ConstrainedCode = "template<typename T>\n"
1406                     "  requires Foo<T>\n"
1407                     "Bar(T) -> Bar<T>;";
1408   BaseTokenCount = 16;
1409   TestRequires(__LINE__);
1410 
1411   BaseCode = "template<typename T>\n"
1412              "T foo();";
1413   ConstrainedCode = "template<typename T>\n"
1414                     "  requires Foo<T>\n"
1415                     "T foo();";
1416   BaseTokenCount = 11;
1417   TestRequires(__LINE__);
1418 
1419   BaseCode = "template<typename T>\n"
1420              "T foo() {\n"
1421              "  auto bar = baz();\n"
1422              "  return bar + T{};\n"
1423              "}";
1424   ConstrainedCode = "template<typename T>\n"
1425                     "  requires Foo<T>\n"
1426                     "T foo() {\n"
1427                     "  auto bar = baz();\n"
1428                     "  return bar + T{};\n"
1429                     "}";
1430   BaseTokenCount = 26;
1431   TestRequires(__LINE__);
1432 
1433   BaseCode = "template<typename T>\n"
1434              "T foo();";
1435   ConstrainedCode = "template<typename T>\n"
1436                     "T foo() requires Foo<T>;";
1437   BaseTokenCount = 11;
1438   PrefixTokenCount = 9;
1439   TestRequires(__LINE__);
1440 
1441   BaseCode = "template<typename T>\n"
1442              "T foo() {\n"
1443              "  auto bar = baz();\n"
1444              "  return bar + T{};\n"
1445              "}";
1446   ConstrainedCode = "template<typename T>\n"
1447                     "T foo() requires Foo<T> {\n"
1448                     "  auto bar = baz();\n"
1449                     "  return bar + T{};\n"
1450                     "}";
1451   BaseTokenCount = 26;
1452   TestRequires(__LINE__);
1453 
1454   BaseCode = "template<typename T>\n"
1455              "T foo();";
1456   ConstrainedCode = "template<typename T>\n"
1457                     "  requires(Foo<T>)\n"
1458                     "T foo();";
1459   BaseTokenCount = 11;
1460   RequiresTokenCount = 7;
1461   PrefixTokenCount = 5;
1462   TestRequires(__LINE__);
1463 
1464   BaseCode = "template<typename T>\n"
1465              "Bar(T) -> Bar<typename T::I>;";
1466   ConstrainedCode = "template<typename T>\n"
1467                     "  requires requires(T &&t) {\n"
1468                     "             typename T::I;\n"
1469                     "           }\n"
1470                     "Bar(T) -> Bar<typename T::I>;";
1471   BaseTokenCount = 19;
1472   RequiresTokenCount = 14;
1473   PrefixTokenCount = 5;
1474   TestRequires(__LINE__);
1475 
1476   BaseCode = "struct [[nodiscard]] zero_t {\n"
1477              "  template<class T>\n"
1478              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1479              "};";
1480   ConstrainedCode =
1481       "struct [[nodiscard]] zero_t {\n"
1482       "  template<class T>\n"
1483       "    requires requires { v<T>; }\n"
1484       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1485       "};";
1486   BaseTokenCount = 35;
1487   RequiresTokenCount = 9;
1488   PrefixTokenCount = 13;
1489   TestRequires(__LINE__);
1490 
1491   BaseCode = "constexpr Foo(Foo const &other)\n"
1492              "    : value{other.value} {\n"
1493              "  do_magic();\n"
1494              "  do_more_magic();\n"
1495              "}";
1496   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1497                     "  requires std::is_copy_constructible<T>\n"
1498                     "    : value{other.value} {\n"
1499                     "  do_magic();\n"
1500                     "  do_more_magic();\n"
1501                     "}";
1502   BaseTokenCount = 26;
1503   RequiresTokenCount = 7;
1504   PrefixTokenCount = 8;
1505   TestRequires(__LINE__);
1506 
1507   BaseCode = "constexpr Foo(Foo const &other)\n"
1508              "    : value{other.value} {\n"
1509              "  do_magic();\n"
1510              "  do_more_magic();\n"
1511              "}";
1512   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1513                     "  requires (std::is_copy_constructible<T>)\n"
1514                     "    : value{other.value} {\n"
1515                     "  do_magic();\n"
1516                     "  do_more_magic();\n"
1517                     "}";
1518   RequiresTokenCount = 9;
1519   TestRequires(__LINE__);
1520 
1521   BaseCode = "template<typename T>\n"
1522              "ANNOTATE(\"S\"\n"
1523              "         \"S\")\n"
1524              "void foo();";
1525   ConstrainedCode = "template<typename T>\n"
1526                     "  requires(true)\n"
1527                     "ANNOTATE(\"S\"\n"
1528                     "         \"S\")\n"
1529                     "void foo();";
1530   BaseTokenCount = 16;
1531   RequiresTokenCount = 4;
1532   PrefixTokenCount = 5;
1533   TestRequires(__LINE__);
1534 }
1535 
1536 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1537   auto Tokens = annotate("__asm{\n"
1538                          "\"a\":\n"
1539                          ": x\n"
1540                          ":};");
1541   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1542   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1543   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1544   EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
1545   EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
1546   EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
1547   EXPECT_TOKEN(Tokens[7], tok::r_brace, TT_InlineASMBrace);
1548 
1549   Tokens = annotate("__asm(\n"
1550                     "\"a\":\n"
1551                     ": x\n"
1552                     ":);");
1553   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1554   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1555   EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
1556   EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
1557   EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
1558 
1559   Tokens = annotate("asm volatile (\n"
1560                     "\"a_label:\"\n"
1561                     ":\n"
1562                     ": x\n"
1563                     ":);");
1564   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1565   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1566   EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
1567   EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
1568   EXPECT_TOKEN(Tokens[7], tok::colon, TT_InlineASMColon);
1569 
1570   Tokens = annotate("__asm__(\n"
1571                     "\"a_label:\"\n"
1572                     ": x\n"
1573                     ":\n"
1574                     ": y);");
1575   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1576   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1577   EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
1578   EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
1579   EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
1580 
1581   Tokens = annotate("__asm volatile (\n"
1582                     "\"a_label:\"\n"
1583                     "\"a b c(%%x)\"\n"
1584                     ":\n"
1585                     ": x\n"
1586                     ":);");
1587   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1588   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1589   EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
1590   EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
1591   EXPECT_TOKEN(Tokens[8], tok::colon, TT_InlineASMColon);
1592 
1593   Tokens = annotate("asm(\n"
1594                     "\"insn\"\n"
1595                     ": \"=r\" (var1), \"=&r\" (value)\n"
1596                     ":\n"
1597                     ": \"memory\");");
1598   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1599   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1600   EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
1601   EXPECT_TOKEN(Tokens[13], tok::colon, TT_InlineASMColon);
1602   EXPECT_TOKEN(Tokens[14], tok::colon, TT_InlineASMColon);
1603 
1604   Tokens = annotate("__asm__ volatile (\n"
1605                     "\"ldr r1, [r0, %%[sym]]\"\n"
1606                     ":\n"
1607                     ": [sym] \"J\" (aaaaa(aaaa, aaaa))\n"
1608                     ");");
1609   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1610   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1611   EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
1612   EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
1613   EXPECT_TOKEN(Tokens[6], tok::l_square, TT_InlineASMSymbolicNameLSquare);
1614 }
1615 
1616 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1617   auto Tokens = annotate("int (^)() = ^ ()\n"
1618                          "  external_source_symbol() { //\n"
1619                          "  return 1;\n"
1620                          "};");
1621   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1622   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1623   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1624 
1625   Tokens = annotate("int *p = ^int*(){ //\n"
1626                     "  return nullptr;\n"
1627                     "}();");
1628   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1629   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1630 }
1631 
1632 TEST_F(TokenAnnotatorTest, UnderstandsObjCMethodExpr) {
1633   auto Tokens = annotate("void f() {\n"
1634                          "  //\n"
1635                          "  BOOL a = [b.c n] > 1;\n"
1636                          "}");
1637   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1638   EXPECT_TOKEN(Tokens[9], tok::l_square, TT_ObjCMethodExpr);
1639   EXPECT_TOKEN(Tokens[15], tok::greater, TT_BinaryOperator);
1640 }
1641 
1642 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1643   auto Tokens = annotate("[]() constexpr {}");
1644   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1645   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1646   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1647 
1648   Tokens = annotate("[]() consteval {}");
1649   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1650   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1651   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1652 
1653   Tokens = annotate("[]() mutable {}");
1654   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1655   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1656   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1657 
1658   Tokens = annotate("[]() static {}");
1659   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1660   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1661   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1662 
1663   Tokens = annotate("[]() -> auto {}");
1664   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1665   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1666   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1667   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1668 
1669   Tokens = annotate("[]() -> auto & {}");
1670   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1671   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1672   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1673   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1674 
1675   Tokens = annotate("[]() -> auto * {}");
1676   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1677   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1678   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1679   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1680 
1681   Tokens = annotate("[] {}");
1682   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1683   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1684   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1685 
1686   Tokens = annotate("[] noexcept {}");
1687   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1688   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1689   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1690 
1691   Tokens = annotate("[] -> auto {}");
1692   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1693   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1694   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_TrailingReturnArrow);
1695   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1696 
1697   Tokens = annotate("[] -> struct S { return {}; }");
1698   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1699   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1700   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_TrailingReturnArrow);
1701   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1702 
1703   Tokens = annotate("foo([&](u32 bar) __attribute__((attr)) -> void {});");
1704   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
1705   EXPECT_TOKEN(Tokens[2], tok::l_square, TT_LambdaLSquare);
1706   EXPECT_TOKEN(Tokens[15], tok::arrow, TT_TrailingReturnArrow);
1707   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1708 
1709   Tokens = annotate("[] <typename T> () {}");
1710   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1711   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1712   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1713   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1714 
1715   Tokens = annotate("[] <typename T> {}");
1716   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1717   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1718   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1719   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1720 
1721   Tokens = annotate("[] <typename... T> () {}");
1722   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1723   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1724   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1725   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1726 
1727   Tokens = annotate("[] <typename... T> {}");
1728   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1729   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1730   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1731   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1732 
1733   Tokens = annotate("[] <int... T> () {}");
1734   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1735   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1736   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1737   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1738 
1739   Tokens = annotate("[] <int... T> {}");
1740   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1741   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1742   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1743   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1744 
1745   Tokens = annotate("[] <Foo... T> () {}");
1746   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1747   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1748   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1749   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1750 
1751   Tokens = annotate("[] <Foo... T> {}");
1752   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1753   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1754   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1755   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1756 
1757   // Lambdas with a requires-clause
1758   Tokens = annotate("[] <typename T> (T t) requires Bar<T> {}");
1759   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1760   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1761   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1762   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1763   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1764   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1765 
1766   Tokens = annotate("[] <typename T> (T &&t) requires Bar<T> {}");
1767   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1768   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1769   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1770   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_PointerOrReference);
1771   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1772   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1773   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1774 
1775   Tokens = annotate("[] <typename T> (T t) requires Foo<T> || Bar<T> {}");
1776   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1777   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1778   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1779   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1780   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1781   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1782 
1783   Tokens = annotate("[] <typename T> (T t) -> T requires Bar<T> {}");
1784   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1785   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1786   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1787   EXPECT_TOKEN(Tokens[10], tok::arrow, TT_TrailingReturnArrow);
1788   EXPECT_TOKEN(Tokens[12], tok::kw_requires, TT_RequiresClause);
1789   EXPECT_TRUE(Tokens[16]->ClosesRequiresClause);
1790   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1791 
1792   Tokens = annotate("[] <typename T> requires Bar<T> (T t) {}");
1793   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1794   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1795   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1796   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1797   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1798   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1799 
1800   Tokens = annotate("[] <typename T> requires Bar<T> (T &&t) {}");
1801   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1802   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1803   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1804   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1805   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1806   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_PointerOrReference);
1807   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1808 
1809   Tokens = annotate("[] <typename T> requires Foo<T> || Bar<T> (T t) {}");
1810   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1811   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1812   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1813   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1814   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1815   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1816 
1817   Tokens = annotate("[] <typename T> requires true (T&& t) {}");
1818   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1819   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1820   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1821   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1822   EXPECT_TRUE(Tokens[7]->ClosesRequiresClause);
1823   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1824   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1825 
1826   Tokens = annotate("[] <typename T> requires Bar<T> {}");
1827   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1828   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1829   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1830   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1831   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1832   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_LambdaLBrace);
1833 
1834   Tokens = annotate("[] <typename T> requires Bar<T> noexcept {}");
1835   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1836   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1837   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1838   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1839   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1840   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1841 
1842   Tokens = annotate("[] <typename T> requires Bar<T> -> T {}");
1843   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1844   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1845   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1846   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1847   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1848   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_TrailingReturnArrow);
1849   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1850 
1851   Tokens = annotate("[] <typename T> requires Foo<T> (T t) requires Bar<T> {}");
1852   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1853   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1854   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1855   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1856   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1857   EXPECT_TOKEN(Tokens[15], tok::kw_requires, TT_RequiresClause);
1858   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1859   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1860 
1861   Tokens = annotate("[] <typename T = int> (T t) {}");
1862   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1863   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1864   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1865   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1866   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1867 
1868   Tokens = annotate("[] <int I = 0> (T t) {}");
1869   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1870   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1871   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1872   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1873   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1874 
1875   Tokens = annotate("[] <bool b = false> (T t) {}");
1876   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1877   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1878   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1879   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1880   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1881 
1882   Tokens = annotate("[] <bool b = true && false> (T&& t) {}");
1883   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1884   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1885   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1886   EXPECT_TOKEN(Tokens[7], tok::ampamp, TT_BinaryOperator);
1887   EXPECT_TOKEN(Tokens[9], tok::greater, TT_TemplateCloser);
1888   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_PointerOrReference);
1889   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1890 
1891   Tokens = annotate("[] <typename T = int> requires Foo<T> (T t) {}");
1892   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1893   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1894   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1895   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1896   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1897   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1898 }
1899 
1900 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1901   auto Tokens = annotate("template <typename T>\n"
1902                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1903                          "string OldFunction(const string &parameter) {}");
1904   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1905   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1906 
1907   Tokens = annotate("template <typename T>\n"
1908                     "A(T) noexcept;");
1909   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1910   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1911 }
1912 
1913 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1914   auto Tokens = annotate("void f [[noreturn]] ();");
1915   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1916   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1917 
1918   Tokens = annotate("void f [[noreturn]] () {}");
1919   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1920   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1921 
1922   Tokens = annotate("#define FOO Foo::\n"
1923                     "FOO Foo();");
1924   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1925   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_FunctionDeclarationName);
1926 
1927   Tokens = annotate("struct Foo {\n"
1928                     "  Bar (*func)();\n"
1929                     "};");
1930   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1931   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
1932   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_FunctionTypeLParen);
1933 
1934   Tokens = annotate("void instanceof();");
1935   ASSERT_EQ(Tokens.size(), 6u);
1936   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1937 
1938   Tokens = annotate("int iso_time(time_t);");
1939   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1940   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1941 
1942   auto Style = getLLVMStyle();
1943   Style.TypeNames.push_back("MyType");
1944   Tokens = annotate("int iso_time(MyType);", Style);
1945   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1946   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1947   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_TypeName);
1948 }
1949 
1950 TEST_F(TokenAnnotatorTest, UnderstandsCtorAndDtorDeclNames) {
1951   auto Tokens = annotate("class Foo { public: Foo(); };");
1952   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1953   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_CtorDtorDeclName);
1954 
1955   Tokens = annotate("class Foo { public: ~Foo(); };");
1956   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1957   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_CtorDtorDeclName);
1958 
1959   Tokens = annotate("struct Foo { [[deprecated]] Foo() {} };");
1960   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1961   EXPECT_TOKEN(Tokens[8], tok::identifier, TT_CtorDtorDeclName);
1962   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1963 
1964   Tokens = annotate("struct Foo { [[deprecated]] ~Foo() {} };");
1965   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1966   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1967   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1968 
1969   Tokens = annotate("struct Foo { Foo() [[deprecated]] {} };");
1970   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1971   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1972   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1973 
1974   Tokens = annotate("struct Foo { ~Foo() [[deprecated]] {} };");
1975   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1976   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_CtorDtorDeclName);
1977   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1978 
1979   Tokens = annotate("struct Foo { [[deprecated]] explicit Foo() {} };");
1980   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1981   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1982   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1983 
1984   Tokens = annotate("struct Foo { virtual [[deprecated]] ~Foo() {} };");
1985   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1986   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_CtorDtorDeclName);
1987   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1988 
1989   Tokens = annotate("Foo::Foo() {}");
1990   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1991   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_CtorDtorDeclName);
1992   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
1993 
1994   Tokens = annotate("Foo::~Foo() {}");
1995   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1996   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1997   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
1998 
1999   Tokens = annotate("struct Test {\n"
2000                     "  Test()\n"
2001                     "      : l([] {\n"
2002                     "          Short::foo();\n"
2003                     "        }) {}\n"
2004                     "};");
2005   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
2006   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
2007   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_Unknown);
2008 }
2009 
2010 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
2011   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
2012   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2013   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
2014   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
2015   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
2016 }
2017 
2018 TEST_F(TokenAnnotatorTest, UnderstandsTrailingReturnArrow) {
2019   auto Tokens = annotate("auto f() -> int;");
2020   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2021   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
2022 
2023   Tokens = annotate("auto operator->() -> int;");
2024   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2025   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_OverloadedOperator);
2026   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
2027 
2028   Tokens = annotate("auto operator++(int) -> int;");
2029   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2030   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
2031 
2032   Tokens = annotate("auto operator=() -> int;");
2033   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2034   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
2035 
2036   Tokens = annotate("auto operator=(int) -> int;");
2037   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2038   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
2039 
2040   Tokens = annotate("auto foo() -> auto { return Val; }");
2041   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2042   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
2043 
2044   Tokens = annotate("struct S { auto bar() const -> int; };");
2045   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2046   EXPECT_TOKEN(Tokens[8], tok::arrow, TT_TrailingReturnArrow);
2047 
2048   // Not trailing return arrows
2049   Tokens = annotate("auto a = b->c;");
2050   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2051   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
2052 
2053   Tokens = annotate("auto a = (b)->c;");
2054   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2055   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
2056 
2057   Tokens = annotate("auto a = b()->c;");
2058   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2059   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
2060 
2061   Tokens = annotate("auto a = b->c();");
2062   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2063   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
2064 
2065   Tokens = annotate("decltype(auto) a = b()->c;");
2066   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2067   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
2068 
2069   Tokens = annotate("void f() { auto a = b->c(); }");
2070   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2071   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
2072 
2073   Tokens = annotate("void f() { auto a = b()->c; }");
2074   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2075   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_Unknown);
2076 
2077   Tokens = annotate("#define P(ptr) auto p = (ptr)->p");
2078   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
2079   EXPECT_TOKEN(Tokens[12], tok::arrow, TT_Unknown);
2080 
2081   Tokens = annotate("void f() FOO(foo->bar);");
2082   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2083   EXPECT_TOKEN(Tokens[7], tok::arrow, TT_Unknown);
2084 
2085   Tokens = annotate("__attribute__((cold)) C() : Base(obj->func()) {}");
2086   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
2087   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
2088 
2089   // Mixed
2090   Tokens = annotate("auto f() -> int { auto a = b()->c; }");
2091   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
2092   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
2093   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
2094 }
2095 
2096 TEST_F(TokenAnnotatorTest, UnderstandHashInMacro) {
2097   auto Tokens = annotate("#define Foo(Bar) \\\n"
2098                          "  { \\\n"
2099                          "    #Bar \\\n"
2100                          "  }");
2101   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2102   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
2103   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
2104 
2105   Tokens = annotate("#define Foo(Bar) \\\n"
2106                     "  { #Bar }");
2107   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2108   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
2109   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
2110 
2111   Tokens = annotate("#define FOO(typeName, realClass) \\\n"
2112                     "  {#typeName, foo<Foo>(new foo<realClass>(#typeName))}");
2113   ASSERT_EQ(Tokens.size(), 29u) << Tokens;
2114   EXPECT_BRACE_KIND(Tokens[8], BK_BracedInit);
2115   EXPECT_BRACE_KIND(Tokens[27], BK_BracedInit);
2116 }
2117 
2118 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacros) {
2119   // '__attribute__' has special handling.
2120   auto Tokens = annotate("__attribute__((X)) void Foo(void);");
2121   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2122   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
2123   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2124   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2125 
2126   // Generic macro has no special handling in this location.
2127   Tokens = annotate("A(X) void Foo(void);");
2128   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2129   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2130   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_Unknown);
2131 
2132   // Add a custom AttributeMacro. Test that it has the same behavior.
2133   FormatStyle Style = getLLVMStyle();
2134   Style.AttributeMacros.push_back("A");
2135 
2136   // An "AttributeMacro" gets annotated like '__attribute__'.
2137   Tokens = annotate("A(X) void Foo(void);", Style);
2138   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2139   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
2140   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2141   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
2142 }
2143 
2144 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCDecl) {
2145   // '__attribute__' has special handling.
2146   auto Tokens = annotate("__attribute__((X)) @interface Foo");
2147   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2148   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
2149   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2150   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2151 
2152   // Generic macro has no special handling in this location.
2153   Tokens = annotate("A(X) @interface Foo");
2154   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2155   // Note: Don't check token-type as a random token in this position is hard to
2156   // reason about.
2157   EXPECT_TOKEN_KIND(Tokens[0], tok::identifier);
2158   EXPECT_TOKEN_KIND(Tokens[1], tok::l_paren);
2159 
2160   // Add a custom AttributeMacro. Test that it has the same behavior.
2161   FormatStyle Style = getLLVMStyle();
2162   Style.AttributeMacros.push_back("A");
2163 
2164   // An "AttributeMacro" gets annotated like '__attribute__'.
2165   Tokens = annotate("A(X) @interface Foo", Style);
2166   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2167   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
2168   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2169   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
2170 }
2171 
2172 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCMethodDecl) {
2173   // '__attribute__' has special handling.
2174   auto Tokens = annotate("- (id)init __attribute__((X));");
2175   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2176   EXPECT_TOKEN(Tokens[5], tok::kw___attribute, TT_Unknown);
2177   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
2178   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
2179 
2180   // Generic macro has no special handling in this location.
2181   Tokens = annotate("- (id)init A(X);");
2182   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2183   // Note: Don't check token-type as a random token in this position is hard to
2184   // reason about.
2185   EXPECT_TOKEN_KIND(Tokens[5], tok::identifier);
2186   EXPECT_TOKEN_KIND(Tokens[6], tok::l_paren);
2187 
2188   // Add a custom AttributeMacro. Test that it has the same behavior.
2189   FormatStyle Style = getLLVMStyle();
2190   Style.AttributeMacros.push_back("A");
2191 
2192   // An "AttributeMacro" gets annotated like '__attribute__'.
2193   Tokens = annotate("- (id)init A(X);", Style);
2194   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2195   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_AttributeMacro);
2196   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
2197   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
2198 }
2199 
2200 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCProperty) {
2201   // '__attribute__' has special handling.
2202   auto Tokens = annotate("@property(weak) id delegate __attribute__((X));");
2203   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
2204   EXPECT_TOKEN(Tokens[7], tok::kw___attribute, TT_Unknown);
2205   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
2206   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_AttributeRParen);
2207 
2208   // Generic macro has no special handling in this location.
2209   Tokens = annotate("@property(weak) id delegate A(X);");
2210   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2211   // Note: Don't check token-type as a random token in this position is hard to
2212   // reason about.
2213   EXPECT_TOKEN_KIND(Tokens[7], tok::identifier);
2214   EXPECT_TOKEN_KIND(Tokens[8], tok::l_paren);
2215 
2216   // Add a custom AttributeMacro. Test that it has the same behavior.
2217   FormatStyle Style = getLLVMStyle();
2218   Style.AttributeMacros.push_back("A");
2219 
2220   // An "AttributeMacro" gets annotated like '__attribute__'.
2221   Tokens = annotate("@property(weak) id delegate A(X);", Style);
2222   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2223   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_AttributeMacro);
2224   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
2225   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
2226 }
2227 
2228 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
2229   auto Annotate = [this](StringRef Code) {
2230     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
2231   };
2232   // Test that unary operators get labeled as such and that operators like '++'
2233   // don't get split.
2234   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
2235                             tok::tilde, tok::amp,      tok::pipe,
2236                             tok::caret, tok::plusplus, tok::minusminus};
2237   for (auto Kind : Unary) {
2238     auto Tokens =
2239         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
2240     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2241     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
2242   }
2243   // Operators formed by joining two operators like '^~'. For some of these
2244   // joined operators, we don't have a separate type, so we only test for their
2245   // precedence.
2246   std::pair<prec::Level, std::string> JoinedBinary[] = {
2247       {prec::Comma, "->"},        {prec::Comma, "<->"},
2248       {prec::Assignment, "+="},   {prec::Assignment, "-="},
2249       {prec::Assignment, "*="},   {prec::Assignment, "/="},
2250       {prec::Assignment, "%="},   {prec::Assignment, "&="},
2251       {prec::Assignment, "^="},   {prec::Assignment, "<<="},
2252       {prec::Assignment, ">>="},  {prec::Assignment, "<<<="},
2253       {prec::Assignment, ">>>="}, {prec::LogicalOr, "||"},
2254       {prec::LogicalAnd, "&&"},   {prec::Equality, "=="},
2255       {prec::Equality, "!="},     {prec::Equality, "==="},
2256       {prec::Equality, "!=="},    {prec::Equality, "==?"},
2257       {prec::Equality, "!=?"},    {prec::ExclusiveOr, "~^"},
2258       {prec::ExclusiveOr, "^~"},
2259   };
2260   for (auto Operator : JoinedBinary) {
2261     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
2262     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2263     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
2264     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
2265   }
2266   // '~^' and '^~' can be unary as well as binary operators.
2267   auto Tokens = Annotate("x = ~^x;");
2268   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2269   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
2270   Tokens = Annotate("x = ^~x;");
2271   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2272   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
2273   // The unary operators '~&' and '~|' can only be unary operators. The current
2274   // implementation treats each of them as separate unary '~' and '&' or '|'
2275   // operators, which is enough for formatting purposes. In FormatTestVerilog,
2276   // there is a test that there is no space in between. And even if a new line
2277   // is inserted between the '~' and '|', the semantic meaning is the same as
2278   // the joined operator, so the CanBreakBefore property doesn't need to be
2279   // false for the second operator.
2280   Tokens = Annotate("x = ~&x;");
2281   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2282   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2283   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
2284   Tokens = Annotate("x = ~|x;");
2285   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2286   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2287   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
2288   // Test for block label colons.
2289   Tokens = Annotate("begin : x\n"
2290                     "end : x");
2291   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2292   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
2293   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
2294   // Test that the dimension colon is annotated correctly.
2295   Tokens = Annotate("var [1 : 0] x;");
2296   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2297   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
2298   Tokens = Annotate("extern function [1 : 0] x;");
2299   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2300   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
2301   Tokens = Annotate("module test\n"
2302                     "    (input wire [7 : 0] a[7 : 0]);\n"
2303                     "endmodule");
2304   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2305   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_VerilogDimensionedTypeName);
2306   EXPECT_TOKEN(Tokens[7], tok::colon, TT_BitFieldColon);
2307   EXPECT_TOKEN(Tokens[13], tok::colon, TT_BitFieldColon);
2308   // Test case labels and ternary operators.
2309   Tokens = Annotate("case (x)\n"
2310                     "  x:\n"
2311                     "    x;\n"
2312                     "endcase");
2313   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2314   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CaseLabelColon);
2315   Tokens = Annotate("case (x)\n"
2316                     "  x ? x : x:\n"
2317                     "    x;\n"
2318                     "endcase");
2319   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2320   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
2321   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
2322   EXPECT_TOKEN(Tokens[9], tok::colon, TT_CaseLabelColon);
2323   // Non-blocking assignments.
2324   Tokens = Annotate("a <= b;");
2325   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2326   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2327   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2328   Tokens = Annotate("if (a <= b) break;");
2329   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2330   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2331   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2332   Tokens = Annotate("a <= b <= a;");
2333   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2334   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2335   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2336   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2337   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2338 
2339   // Port lists in module instantiation.
2340   Tokens = Annotate("module_x instance_1(port_1), instance_2(port_2);");
2341   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2342   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2343   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_VerilogInstancePortLParen);
2344   Tokens = Annotate("module_x #(parameter) instance_1(port_1), "
2345                     "instance_2(port_2);");
2346   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2347   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2348   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_VerilogInstancePortLParen);
2349   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_VerilogInstancePortLParen);
2350 
2351   // Condition parentheses.
2352   Tokens = Annotate("assert (x);");
2353   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2354   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2355   Tokens = Annotate("assert #0 (x);");
2356   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2357   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_ConditionLParen);
2358   Tokens = Annotate("assert final (x);");
2359   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2360   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2361   Tokens = Annotate("foreach (x[x]) continue;");
2362   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2363   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2364   Tokens = Annotate("repeat (x[x]) continue;");
2365   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2366   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2367   Tokens = Annotate("case (x) endcase;");
2368   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2369   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2370 
2371   // Sensitivity list. The TT_Unknown type is clearly not binding for the
2372   // future, please adapt if those tokens get annotated.  This test is only here
2373   // to prevent the comma from being annotated as TT_VerilogInstancePortComma.
2374   Tokens = Annotate("always @(posedge x, posedge y);");
2375   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2376   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_Unknown);
2377   EXPECT_TOKEN(Tokens[5], tok::comma, TT_Unknown);
2378   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2379 
2380   // String literals in concatenation.
2381   Tokens = Annotate("x = {\"\"};");
2382   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2383   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2384   Tokens = Annotate("x = {\"\", \"\"};");
2385   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2386   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2387   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2388   Tokens = Annotate("x = '{{\"\"}};");
2389   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2390   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2391   // Cases where the string should not be annotated that type.  Fix the
2392   // `TT_Unknown` if needed in the future.
2393   Tokens = Annotate("x = {\"\" == \"\"};");
2394   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2395   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_Unknown);
2396   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_Unknown);
2397   Tokens = Annotate("x = {(\"\")};");
2398   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2399   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2400   Tokens = Annotate("x = '{\"\"};");
2401   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2402   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2403 }
2404 
2405 TEST_F(TokenAnnotatorTest, UnderstandTableGenTokens) {
2406   auto Style = getLLVMStyle(FormatStyle::LK_TableGen);
2407   ASSERT_TRUE(Style.isTableGen());
2408 
2409   TestLexer Lexer(Allocator, Buffers, Style);
2410   AdditionalKeywords Keywords(Lexer.IdentTable);
2411   auto Annotate = [&Lexer](StringRef Code) { return Lexer.annotate(Code); };
2412 
2413   // Additional keywords representation test.
2414   auto Tokens = Annotate("def foo : Bar<1>;");
2415   ASSERT_TRUE(Keywords.isTableGenKeyword(*Tokens[0]));
2416   ASSERT_TRUE(Keywords.isTableGenDefinition(*Tokens[0]));
2417   ASSERT_TRUE(Tokens[0]->is(Keywords.kw_def));
2418   ASSERT_TRUE(Tokens[1]->is(TT_StartOfName));
2419 
2420   // Code, the multiline string token.
2421   Tokens = Annotate("[{ code is multiline string }]");
2422   ASSERT_EQ(Tokens.size(), 2u) << Tokens;
2423   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2424   EXPECT_FALSE(Tokens[0]->IsMultiline);
2425   // Case with multiple lines.
2426   Tokens = Annotate("[{ It can break\n"
2427                     "   across lines and the line breaks\n"
2428                     "   are retained in \n"
2429                     "   the string. }]");
2430   ASSERT_EQ(Tokens.size(), 2u) << Tokens;
2431   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2432   EXPECT_EQ(Tokens[0]->ColumnWidth, sizeof("[{ It can break\n") - 1);
2433   EXPECT_TRUE(Tokens[0]->IsMultiline);
2434   EXPECT_EQ(Tokens[0]->LastLineColumnWidth, sizeof("   the string. }]") - 1);
2435 
2436   // Numeric literals.
2437   Tokens = Annotate("1234");
2438   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2439   Tokens = Annotate("-1");
2440   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2441   Tokens = Annotate("+1234");
2442   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2443   Tokens = Annotate("0b0110");
2444   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2445   Tokens = Annotate("0x1abC");
2446   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2447 
2448   // Identifier tokens. In TableGen, identifiers can begin with a number.
2449   // In ambiguous cases, the lexer tries to lex it as a number.
2450   // Even if the try fails, it does not fall back to identifier lexing and
2451   // regard as an error.
2452   // The ambiguity is not documented. The result of those tests are based on the
2453   // implementation of llvm::TGLexer::LexToken.
2454   // This is invalid syntax of number, but not an identifier.
2455   Tokens = Annotate("0x1234x");
2456   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2457   Tokens = Annotate("identifier");
2458   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2459   // Identifier beginning with a number.
2460   Tokens = Annotate("0x");
2461   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2462   Tokens = Annotate("2dVector");
2463   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2464   Tokens = Annotate("01234Vector");
2465   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2466 
2467   // Structured statements.
2468   Tokens = Annotate("class Foo {}");
2469   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_FunctionLBrace);
2470   Tokens = Annotate("def Def: Foo {}");
2471   EXPECT_TOKEN(Tokens[2], tok::colon, TT_InheritanceColon);
2472   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2473   Tokens = Annotate("if cond then {} else {}");
2474   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ControlStatementLBrace);
2475   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_ElseLBrace);
2476   Tokens = Annotate("defset Foo Def2 = {}");
2477   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2478 
2479   // Bang Operators.
2480   Tokens = Annotate("!foreach");
2481   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenBangOperator);
2482   Tokens = Annotate("!if");
2483   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenBangOperator);
2484   Tokens = Annotate("!cond");
2485   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenCondOperator);
2486 
2487   auto AnnotateValue = [this, &Style](StringRef Code) {
2488     // Values are annotated only in specific context.
2489     auto Result = annotate(("def X { let V = " + Code + "; }").str(), Style);
2490     return decltype(Result){Result.begin() + 6, Result.end() - 3};
2491   };
2492   // Both of bang/cond operators.
2493   Tokens = AnnotateValue("!cond(!eq(x, 0): 1, true: x)");
2494   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
2495   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenCondOperator);
2496   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_TableGenBangOperator);
2497   EXPECT_TOKEN(Tokens[8], tok::colon, TT_TableGenCondOperatorColon);
2498   EXPECT_TOKEN(Tokens[10], tok::comma, TT_TableGenCondOperatorComma);
2499   EXPECT_TOKEN(Tokens[12], tok::colon, TT_TableGenCondOperatorColon);
2500   // DAGArg values with operator identifier
2501   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2502   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2503   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpener);
2504   EXPECT_TOKEN(Tokens[3], tok::colon, TT_TableGenDAGArgListColon);
2505   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown); // $src1
2506   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListComma);
2507   EXPECT_TOKEN(Tokens[7], tok::colon, TT_TableGenDAGArgListColon);
2508   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2509   // List literal
2510   Tokens = AnnotateValue("[1, 2, 3]");
2511   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2512   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_TableGenListOpener);
2513   EXPECT_TOKEN(Tokens[6], tok::r_square, TT_TableGenListCloser);
2514   // Suffixes of values
2515   Tokens = AnnotateValue("valid.field");
2516   ASSERT_EQ(Tokens.size(), 3u) << Tokens;
2517   EXPECT_TOKEN(Tokens[1], tok::period, TT_TableGenValueSuffix);
2518   // Code
2519   Tokens = AnnotateValue("[{ code is multiline string }]");
2520   ASSERT_EQ(Tokens.size(), 1u) << Tokens;
2521   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2522 
2523   // The definition
2524   Tokens = annotate("def Def : Parent<Child> {}", Style);
2525   ASSERT_EQ(Tokens.size(), 10u) << Tokens; // This contains eof.
2526   // We use inheritance colon and function brace. They are enough.
2527   EXPECT_TOKEN(Tokens[2], tok::colon, TT_InheritanceColon);
2528   EXPECT_TOKEN(Tokens[4], tok::less, TT_TemplateOpener);
2529   EXPECT_TOKEN(Tokens[6], tok::greater, TT_TemplateCloser);
2530   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
2531 
2532   // DAGArg breaking options. They use different token types depending on what
2533   // is specified.
2534   Style.TableGenBreakInsideDAGArg = FormatStyle::DAS_BreakElements;
2535 
2536   // When TableGenBreakInsideDAGArg is DAS_BreakElements and
2537   // TableGenBreakingDAGArgOperators is not specified, it makes all the DAGArg
2538   // elements to have line break.
2539   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2540   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2541   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2542   EXPECT_TOKEN(Tokens[1], tok::identifier,
2543                TT_TableGenDAGArgOperatorID); // ins
2544   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2545   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2546 
2547   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2548   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2549   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2550   EXPECT_TOKEN(Tokens[1], tok::identifier,
2551                TT_TableGenDAGArgOperatorID); // other
2552   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2553   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2554 
2555   // For non-identifier operators, breaks after the operator.
2556   Tokens = AnnotateValue("(!cast<Type>(\"Name\") type1:$src1, type2:$src2)");
2557   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2558   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2559   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_TableGenDAGArgOperatorToBreak);
2560   EXPECT_TOKEN(Tokens[11], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2561   EXPECT_TOKEN(Tokens[15], tok::r_paren, TT_TableGenDAGArgCloser);
2562 
2563   Style.TableGenBreakInsideDAGArg = FormatStyle::DAS_BreakAll;
2564 
2565   // When TableGenBreakInsideDAGArg is DAS_BreakAll and
2566   // TableGenBreakingDAGArgOperators is not specified, it makes all the DAGArg
2567   // to have line break inside it.
2568   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2569   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2570   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2571   EXPECT_TOKEN(Tokens[1], tok::identifier,
2572                TT_TableGenDAGArgOperatorToBreak); // ins
2573   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2574   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2575 
2576   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2577   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2578   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2579   EXPECT_TOKEN(Tokens[1], tok::identifier,
2580                TT_TableGenDAGArgOperatorToBreak); // other
2581   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2582   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2583 
2584   // If TableGenBreakingDAGArgOperators is specified, it is limited to the
2585   // specified operators.
2586   Style.TableGenBreakingDAGArgOperators = {"ins", "outs"};
2587   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2588   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2589   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2590   EXPECT_TOKEN(Tokens[1], tok::identifier,
2591                TT_TableGenDAGArgOperatorToBreak); // ins
2592   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2593   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2594 
2595   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2596   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2597   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpener);
2598   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_Unknown); // other
2599   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListComma);
2600   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2601 
2602   // If TableGenBreakingDAGArgOperators is enabled, it uses
2603   // TT_TableGenDAGArgListColonToAlign to annotate the colon to align.
2604   Style.AlignConsecutiveTableGenBreakingDAGArgColons.Enabled = true;
2605   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2606   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2607   EXPECT_TOKEN(Tokens[1], tok::identifier,
2608                TT_TableGenDAGArgOperatorToBreak); // ins
2609   EXPECT_TOKEN(Tokens[3], tok::colon, TT_TableGenDAGArgListColonToAlign);
2610   EXPECT_TOKEN(Tokens[7], tok::colon, TT_TableGenDAGArgListColonToAlign);
2611 
2612   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2613   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2614   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_Unknown); // other
2615   EXPECT_TOKEN(Tokens[3], tok::colon, TT_TableGenDAGArgListColon);
2616   EXPECT_TOKEN(Tokens[7], tok::colon, TT_TableGenDAGArgListColon);
2617 }
2618 
2619 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
2620   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
2621 
2622   // The TT_Unknown is clearly not binding for the future, please adapt if those
2623   // tokens get annotated.
2624   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2625   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2626   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2627   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
2628   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2629   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2630   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2631   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
2632   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
2633   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2634   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2635 
2636   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
2637   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2638   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2639   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2640   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
2641   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
2642   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2643   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2644   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
2645   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
2646   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2647   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2648 
2649   Tokens = annotate("class Class {\n"
2650                     "  Class() : BaseClass() {\n"
2651                     "#if 0\n"
2652                     "    // comment\n"
2653                     "#endif\n"
2654                     "  }\n"
2655                     "  Class f();\n"
2656                     "}");
2657   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
2658   EXPECT_TOKEN(Tokens[6], tok::colon, TT_CtorInitializerColon);
2659   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_FunctionLBrace);
2660   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2661 }
2662 
2663 TEST_F(TokenAnnotatorTest, UnderstandsConditionParens) {
2664   auto Tokens = annotate("if (x) {}");
2665   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2666   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2667   Tokens = annotate("if constexpr (x) {}");
2668   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2669   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2670   Tokens = annotate("if CONSTEXPR (x) {}");
2671   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2672   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2673   Tokens = annotate("if (x) {} else if (x) {}");
2674   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2675   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2676   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_ConditionLParen);
2677 }
2678 
2679 TEST_F(TokenAnnotatorTest, CSharpNullableTypes) {
2680   FormatStyle Style = getGoogleStyle(FormatStyle::LK_CSharp);
2681 
2682   auto Tokens = annotate("int? a;", Style);
2683   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2684   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2685 
2686   Tokens = annotate("int? a = 1;", Style);
2687   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2688   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2689 
2690   Tokens = annotate("int?)", Style);
2691   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
2692   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2693 
2694   Tokens = annotate("int?>", Style);
2695   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
2696   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2697 
2698   Tokens = annotate("cond? id : id2", Style);
2699   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2700   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2701 
2702   Tokens = annotate("cond ? cond2 ? : id1 : id2", Style);
2703   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2704   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2705 }
2706 
2707 TEST_F(TokenAnnotatorTest, UnderstandsLabels) {
2708   auto Tokens = annotate("{ x: break; }");
2709   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2710   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2711 
2712   Tokens = annotate("{ case x: break; }");
2713   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2714   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2715 
2716   Tokens = annotate("{ x: { break; } }");
2717   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2718   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2719 
2720   Tokens = annotate("{ case x: { break; } }");
2721   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2722   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2723 
2724   Tokens = annotate("#define FOO label:");
2725   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2726   EXPECT_TOKEN(Tokens[4], tok::colon, TT_GotoLabelColon);
2727 
2728   Tokens = annotate("#define FOO \\\n"
2729                     "label: \\\n"
2730                     "  break;");
2731   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2732   EXPECT_TOKEN(Tokens[4], tok::colon, TT_GotoLabelColon);
2733 }
2734 
2735 TEST_F(TokenAnnotatorTest, UnderstandsNestedBlocks) {
2736   // The closing braces are not annotated. It doesn't seem to cause a problem.
2737   // So we only test for the opening braces.
2738   auto Tokens = annotate("{\n"
2739                          "  {\n"
2740                          "    { int a = 0; }\n"
2741                          "  }\n"
2742                          "  {}\n"
2743                          "}");
2744   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2745   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2746   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
2747   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
2748   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2749 }
2750 
2751 TEST_F(TokenAnnotatorTest, UnderstandDesignatedInitializers) {
2752   auto Tokens = annotate("SomeStruct { .a = 1 };");
2753   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2754   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2755   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2756 
2757   Tokens = annotate("SomeStruct { .a = 1, .b = 2 };");
2758   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2759   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2760   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2761   EXPECT_TOKEN(Tokens[7], tok::period, TT_DesignatedInitializerPeriod);
2762 
2763   Tokens = annotate("SomeStruct {\n"
2764                     "#ifdef FOO\n"
2765                     "  .a = 1,\n"
2766                     "#endif\n"
2767                     "  .b = 2\n"
2768                     "};");
2769   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2770   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2771   EXPECT_TOKEN(Tokens[5], tok::period, TT_DesignatedInitializerPeriod);
2772   EXPECT_TOKEN(Tokens[12], tok::period, TT_DesignatedInitializerPeriod);
2773 
2774   Tokens = annotate("SomeStruct {\n"
2775                     "#if defined FOO\n"
2776                     "  .a = 1,\n"
2777                     "#endif\n"
2778                     "  .b = 2\n"
2779                     "};");
2780   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2781   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2782   EXPECT_TOKEN(Tokens[6], tok::period, TT_DesignatedInitializerPeriod);
2783   EXPECT_TOKEN(Tokens[13], tok::period, TT_DesignatedInitializerPeriod);
2784 
2785   Tokens = annotate("Foo foo[] = {[0]{}};");
2786   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2787   EXPECT_TOKEN(Tokens[6], tok::l_square, TT_DesignatedInitializerLSquare);
2788   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
2789 }
2790 
2791 TEST_F(TokenAnnotatorTest, UnderstandsJavaScript) {
2792   auto Annotate = [this](StringRef Code) {
2793     return annotate(Code, getLLVMStyle(FormatStyle::LK_JavaScript));
2794   };
2795 
2796   // Dictionary.
2797   auto Tokens = Annotate("var x = {'x' : 1, 'y' : 2};");
2798   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2799   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_DictLiteral);
2800   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_SelectorName);
2801   EXPECT_TOKEN(Tokens[5], tok::colon, TT_DictLiteral);
2802   EXPECT_TOKEN(Tokens[8], tok::string_literal, TT_SelectorName);
2803   EXPECT_TOKEN(Tokens[9], tok::colon, TT_DictLiteral);
2804   // Change when we need to annotate these.
2805   EXPECT_BRACE_KIND(Tokens[3], BK_Unknown);
2806   EXPECT_BRACE_KIND(Tokens[11], BK_Unknown);
2807   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_Unknown);
2808 }
2809 
2810 TEST_F(TokenAnnotatorTest, UnderstandsAttributes) {
2811   auto Tokens = annotate("bool foo __attribute__((unused));");
2812   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2813   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_StartOfName);
2814   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2815   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_Unknown);
2816   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_Unknown);
2817   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_AttributeRParen);
2818 
2819   Tokens = annotate("bool foo __declspec(dllimport);");
2820   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2821   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2822   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2823 
2824   Tokens = annotate("bool __attribute__((unused)) foo;");
2825   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2826   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_AttributeLParen);
2827   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_Unknown);
2828   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_Unknown);
2829   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_AttributeRParen);
2830   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_StartOfName);
2831 
2832   Tokens = annotate("void __attribute__((x)) Foo();");
2833   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2834   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_AttributeLParen);
2835   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_Unknown);
2836   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_Unknown);
2837   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_AttributeRParen);
2838   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_FunctionDeclarationName);
2839 
2840   FormatStyle Style = getLLVMStyle();
2841   Style.AttributeMacros.push_back("FOO");
2842   Tokens = annotate("bool foo FOO(unused);", Style);
2843   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2844   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
2845   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2846   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2847 }
2848 
2849 TEST_F(TokenAnnotatorTest, UnderstandsControlStatements) {
2850   auto Tokens = annotate("while (true) {}");
2851   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2852   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2853   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2854 
2855   Tokens = annotate("for (;;) {}");
2856   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2857   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_ControlStatementLBrace);
2858   EXPECT_TOKEN(Tokens[6], tok::r_brace, TT_ControlStatementRBrace);
2859 
2860   Tokens = annotate("do {} while (true);");
2861   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2862   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_ControlStatementLBrace);
2863   EXPECT_TOKEN(Tokens[2], tok::r_brace, TT_ControlStatementRBrace);
2864 
2865   Tokens = annotate("if (true) {} else if (false) {} else {}");
2866   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
2867   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2868   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2869   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_ControlStatementLBrace);
2870   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_ControlStatementRBrace);
2871   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_ElseLBrace);
2872   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_ElseRBrace);
2873 
2874   Tokens = annotate("switch (foo) {}");
2875   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2876   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2877   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2878 }
2879 
2880 TEST_F(TokenAnnotatorTest, UnderstandsDoWhile) {
2881   auto Tokens = annotate("do { ++i; } while ( i > 5 );");
2882   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2883   EXPECT_TOKEN(Tokens[6], tok::kw_while, TT_DoWhile);
2884 
2885   Tokens = annotate("do ++i; while ( i > 5 );");
2886   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2887   EXPECT_TOKEN(Tokens[4], tok::kw_while, TT_DoWhile);
2888 }
2889 
2890 TEST_F(TokenAnnotatorTest, StartOfName) {
2891   auto Tokens = annotate("#pragma clang diagnostic push");
2892   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2893   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2894   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2895   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
2896 
2897   Tokens = annotate("#pragma clang diagnostic ignored \"-Wzero-length-array\"");
2898   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2899   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2900   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2901   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
2902 
2903   Tokens = annotate("#define FOO Foo foo");
2904   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2905   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2906   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2907   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_StartOfName);
2908 
2909   Tokens = annotate("@interface NSCoder (TestCoder)");
2910   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2911   EXPECT_TOKEN(Tokens[0], tok::at, TT_ObjCDecl);
2912   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_StartOfName);
2913 }
2914 
2915 TEST_F(TokenAnnotatorTest, BraceKind) {
2916   auto Tokens = annotate("void f() {};");
2917   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2918   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2919   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2920   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2921   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2922 
2923   Tokens = annotate("class Foo<int> f() {}");
2924   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2925   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_FunctionDeclarationName);
2926   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_FunctionLBrace);
2927   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
2928   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
2929 
2930   Tokens = annotate("template <typename T> class Foo<T> f() {}");
2931   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2932   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_FunctionDeclarationName);
2933   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2934   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2935   EXPECT_BRACE_KIND(Tokens[14], BK_Block);
2936 
2937   Tokens = annotate("void f() override {};");
2938   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2939   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2940   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
2941   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2942   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2943 
2944   Tokens = annotate("void f() noexcept(false) {};");
2945   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2946   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2947   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_FunctionLBrace);
2948   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
2949   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
2950 
2951   Tokens = annotate("auto f() -> void {};");
2952   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2953   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2954   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
2955   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2956   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
2957 
2958   Tokens = annotate("void f() { /**/ };");
2959   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2960   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2961   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2962   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2963   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2964 
2965   Tokens = annotate("void f() { //\n"
2966                     "};");
2967   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2968   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2969   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2970   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2971   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2972 
2973   Tokens = annotate("void f() {\n"
2974                     "  //\n"
2975                     "};");
2976   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2977   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2978   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2979   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2980   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2981 
2982   Tokens = annotate("struct Foo {\n"
2983                     "  Foo() {};\n"
2984                     "  ~Foo() {};\n"
2985                     "};");
2986   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2987   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
2988   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
2989   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2990   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
2991   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_CtorDtorDeclName);
2992   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2993   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2994   EXPECT_BRACE_KIND(Tokens[14], BK_Block);
2995 
2996   Tokens = annotate("{\n"
2997                     "  char *a[] = {\n"
2998                     "      /* abc */ \"abc\",\n"
2999                     "#if FOO\n"
3000                     "      /* xyz */ \"xyz\",\n"
3001                     "#endif\n"
3002                     "      /* last */ \"last\"};\n"
3003                     "}");
3004   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
3005   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
3006   EXPECT_BRACE_KIND(Tokens[7], BK_BracedInit);
3007   EXPECT_BRACE_KIND(Tokens[21], BK_BracedInit);
3008 
3009   Tokens =
3010       annotate("#define SCOP_STAT(NAME, DESC) \\\n"
3011                "  {\"polly\", #NAME, \"Number of rejected regions: \" DESC}");
3012   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
3013   EXPECT_BRACE_KIND(Tokens[8], BK_BracedInit);
3014   EXPECT_BRACE_KIND(Tokens[16], BK_BracedInit);
3015 
3016   Tokens = annotate("struct {};");
3017   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
3018   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
3019   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
3020 
3021   Tokens = annotate("struct : Base {};");
3022   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
3023   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
3024   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3025 
3026   Tokens = annotate("struct Foo {};");
3027   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
3028   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
3029   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
3030 
3031   Tokens = annotate("struct ::Foo {};");
3032   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
3033   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
3034   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3035 
3036   Tokens = annotate("struct NS::Foo {};");
3037   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
3038   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3039   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
3040 
3041   Tokens = annotate("struct Foo<int> {};");
3042   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
3043   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
3044   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
3045 
3046   Tokens = annotate("struct Foo<int>::Bar {};");
3047   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
3048   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
3049   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
3050 
3051   Tokens = annotate("struct Foo<int> : Base {};");
3052   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
3053   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
3054   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
3055 
3056   Tokens = annotate("struct Foo final {};");
3057   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
3058   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
3059   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3060 
3061   Tokens = annotate("struct [[foo]] [[bar]] Foo final : Base1, Base2 {};");
3062   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
3063   EXPECT_BRACE_KIND(Tokens[17], BK_Block);
3064   EXPECT_BRACE_KIND(Tokens[18], BK_Block);
3065 
3066   Tokens = annotate("struct Foo x{};");
3067   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
3068   EXPECT_BRACE_KIND(Tokens[3], BK_BracedInit);
3069   EXPECT_BRACE_KIND(Tokens[4], BK_BracedInit);
3070 
3071   Tokens = annotate("struct ::Foo x{};");
3072   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
3073   EXPECT_BRACE_KIND(Tokens[4], BK_BracedInit);
3074   EXPECT_BRACE_KIND(Tokens[5], BK_BracedInit);
3075 
3076   Tokens = annotate("struct NS::Foo x{};");
3077   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
3078   EXPECT_BRACE_KIND(Tokens[5], BK_BracedInit);
3079   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
3080 
3081   Tokens = annotate("struct Foo<int> x{};");
3082   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
3083   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
3084   EXPECT_BRACE_KIND(Tokens[7], BK_BracedInit);
3085 
3086   Tokens = annotate("#ifdef DEBUG_ENABLED\n"
3087                     "#else\n"
3088                     "#endif\n"
3089                     "class RenderingServer : Object {\n"
3090                     "#ifndef DISABLE_DEPRECATED\n"
3091                     "  enum Features {\n"
3092                     "    FEATURE_SHADERS,\n"
3093                     "    FEATURE_MULTITHREADED,\n"
3094                     "  };\n"
3095                     "#endif\n"
3096                     "};");
3097   ASSERT_EQ(Tokens.size(), 29u) << Tokens;
3098   EXPECT_BRACE_KIND(Tokens[11], BK_Block);
3099   EXPECT_BRACE_KIND(Tokens[17], BK_Block);
3100   EXPECT_BRACE_KIND(Tokens[22], BK_Block);
3101   EXPECT_BRACE_KIND(Tokens[26], BK_Block);
3102 }
3103 
3104 TEST_F(TokenAnnotatorTest, UnderstandsElaboratedTypeSpecifier) {
3105   auto Tokens = annotate("auto foo() -> enum En {}");
3106   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
3107   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
3108 }
3109 
3110 TEST_F(TokenAnnotatorTest, BlockLBrace) {
3111   auto Tokens = annotate("{\n"
3112                          "  {\n"
3113                          "    foo();\n"
3114                          "  }\n"
3115                          "}");
3116   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
3117   EXPECT_TOKEN(Tokens[0], tok::l_brace, TT_BlockLBrace);
3118   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
3119   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_BlockLBrace);
3120   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
3121 
3122   Tokens = annotate("void bar() {\n"
3123                     "  {\n"
3124                     "    foo();\n"
3125                     "  }\n"
3126                     "}");
3127   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
3128   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
3129   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3130   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_BlockLBrace);
3131   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
3132 }
3133 
3134 TEST_F(TokenAnnotatorTest, SwitchExpression) {
3135   auto Style = getLLVMStyle(FormatStyle::LK_Java);
3136   auto Tokens = annotate("i = switch (day) {\n"
3137                          "  case THURSDAY, SATURDAY -> 8;\n"
3138                          "  case WEDNESDAY -> 9;\n"
3139                          "  default -> 1;\n"
3140                          "};",
3141                          Style);
3142   ASSERT_EQ(Tokens.size(), 26u) << Tokens;
3143   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_SwitchExpressionLBrace);
3144   EXPECT_TOKEN(Tokens[7], tok::kw_case, TT_SwitchExpressionLabel);
3145   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_CaseLabelArrow);
3146   EXPECT_TOKEN(Tokens[14], tok::kw_case, TT_SwitchExpressionLabel);
3147   EXPECT_TOKEN(Tokens[16], tok::arrow, TT_CaseLabelArrow);
3148   EXPECT_TOKEN(Tokens[19], tok::kw_default, TT_SwitchExpressionLabel);
3149   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_CaseLabelArrow);
3150 }
3151 
3152 TEST_F(TokenAnnotatorTest, CppAltOperatorKeywords) {
3153   auto Tokens = annotate("a = b and c;");
3154   ASSERT_EQ(Tokens.size(), 7u);
3155   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_BinaryOperator);
3156 
3157   Tokens = annotate("a = b and_eq c;");
3158   ASSERT_EQ(Tokens.size(), 7u);
3159   EXPECT_TOKEN(Tokens[3], tok::ampequal, TT_BinaryOperator);
3160 
3161   Tokens = annotate("a = b bitand c;");
3162   ASSERT_EQ(Tokens.size(), 7u);
3163   EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator);
3164 
3165   Tokens = annotate("a = b bitor c;");
3166   ASSERT_EQ(Tokens.size(), 7u);
3167   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_BinaryOperator);
3168 
3169   Tokens = annotate("a = b compl c;");
3170   ASSERT_EQ(Tokens.size(), 7u);
3171   EXPECT_TOKEN(Tokens[3], tok::tilde, TT_UnaryOperator);
3172 
3173   Tokens = annotate("a = b not c;");
3174   ASSERT_EQ(Tokens.size(), 7u);
3175   EXPECT_TOKEN(Tokens[3], tok::exclaim, TT_UnaryOperator);
3176 
3177   Tokens = annotate("a = b not_eq c;");
3178   ASSERT_EQ(Tokens.size(), 7u);
3179   EXPECT_TOKEN(Tokens[3], tok::exclaimequal, TT_BinaryOperator);
3180 
3181   Tokens = annotate("a = b or c;");
3182   ASSERT_EQ(Tokens.size(), 7u);
3183   EXPECT_TOKEN(Tokens[3], tok::pipepipe, TT_BinaryOperator);
3184 
3185   Tokens = annotate("a = b or_eq c;");
3186   ASSERT_EQ(Tokens.size(), 7u);
3187   EXPECT_TOKEN(Tokens[3], tok::pipeequal, TT_BinaryOperator);
3188 
3189   Tokens = annotate("a = b xor c;");
3190   ASSERT_EQ(Tokens.size(), 7u);
3191   EXPECT_TOKEN(Tokens[3], tok::caret, TT_BinaryOperator);
3192 
3193   Tokens = annotate("a = b xor_eq c;");
3194   ASSERT_EQ(Tokens.size(), 7u);
3195   EXPECT_TOKEN(Tokens[3], tok::caretequal, TT_BinaryOperator);
3196 
3197   Tokens = annotate("xor = foo;");
3198   ASSERT_EQ(Tokens.size(), 5u);
3199   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
3200 
3201   Tokens = annotate("int xor = foo;");
3202   ASSERT_EQ(Tokens.size(), 6u);
3203   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_StartOfName);
3204 }
3205 
3206 TEST_F(TokenAnnotatorTest, FunctionTryBlock) {
3207   auto Tokens =
3208       annotate("Foo::Foo(int x, int y) try\n"
3209                "    : foo{[] -> std::string { return {}; }(), x}, bar{y} {\n"
3210                "} catch (...) {\n"
3211                "}");
3212   ASSERT_EQ(Tokens.size(), 45u);
3213   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_CtorDtorDeclName);
3214   EXPECT_TOKEN(Tokens[11], tok::colon, TT_CtorInitializerColon);
3215   EXPECT_TOKEN(Tokens[14], tok::l_square, TT_LambdaLSquare);
3216   EXPECT_TOKEN(Tokens[16], tok::arrow, TT_TrailingReturnArrow);
3217   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
3218   EXPECT_TOKEN(Tokens[31], tok::comma, TT_CtorInitializerComma);
3219   EXPECT_TOKEN(Tokens[36], tok::l_brace, TT_FunctionLBrace);
3220 }
3221 
3222 TEST_F(TokenAnnotatorTest, TypenameMacro) {
3223   auto Style = getLLVMStyle();
3224   Style.TypenameMacros.push_back("STRUCT");
3225 
3226   auto Tokens = annotate("STRUCT(T, B) { int i; };", Style);
3227   ASSERT_EQ(Tokens.size(), 13u);
3228   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TypenameMacro);
3229   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_TypeDeclarationParen);
3230   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_TypeDeclarationParen);
3231   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_Unknown);
3232 }
3233 
3234 } // namespace
3235 } // namespace format
3236 } // namespace clang
3237