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