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