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