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