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