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