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