xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision 8e9b1e9aa83b44fad44954bbd01c824def2b190f)
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(llvm::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 
494 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
495   auto Tokens = annotate("union U {};");
496   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
497   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
498   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_UnionRBrace);
499 
500   Tokens = annotate("union U { void f() { return; } };");
501   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
502   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
503   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
504   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_UnionRBrace);
505 }
506 
507 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
508   auto Tokens = annotate("enum E {};");
509   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
510   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
511   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_EnumRBrace);
512 }
513 
514 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
515   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
516   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
517   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
518 
519   Tokens = annotate("template <typename T> void F(T) && = delete;");
520   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
521   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
522 }
523 
524 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
525   auto Tokens =
526       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
527   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
528   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
529 }
530 
531 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
532   auto Tokens =
533       annotate("template <typename T> "
534                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
535   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
536   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
537 }
538 
539 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) {
540   auto Tokens =
541       annotate("#define FOO(typeName) \\\n"
542                "  { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }");
543   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
544   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
545   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
546   EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener);
547   EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser);
548 }
549 
550 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) {
551   auto Tokens = annotate("if (std::tuple_size_v<T> > 0)");
552   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
553   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
554   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
555   EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator);
556 }
557 
558 TEST_F(TokenAnnotatorTest, UnderstandsNonTemplateAngleBrackets) {
559   auto Tokens = annotate("return a < b && c > d;");
560   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
561   EXPECT_TOKEN(Tokens[2], tok::less, TT_BinaryOperator);
562   EXPECT_TOKEN(Tokens[6], tok::greater, TT_BinaryOperator);
563 
564   Tokens = annotate("a < 0 ? b : a > 0 ? c : d;");
565   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
566   EXPECT_TOKEN(Tokens[1], tok::less, TT_BinaryOperator);
567   EXPECT_TOKEN(Tokens[7], tok::greater, TT_BinaryOperator);
568 
569   Tokens = annotate("ratio{-1, 2} < ratio{-1, 3} == -1 / 3 > -1 / 2;");
570   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
571   EXPECT_TOKEN(Tokens[7], tok::less, TT_BinaryOperator);
572   EXPECT_TOKEN(Tokens[20], tok::greater, TT_BinaryOperator);
573 }
574 
575 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
576   FormatStyle Style = getLLVMStyle();
577   Style.WhitespaceSensitiveMacros.push_back("FOO");
578 
579   auto Tokens = annotate("FOO(1+2 )", Style);
580   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
581   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
582 
583   Tokens = annotate("FOO(a:b:c)", Style);
584   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
585   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
586 }
587 
588 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
589   auto Tokens = annotate("delete (void *)p;");
590   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
591   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
592 
593   Tokens = annotate("delete[] (void *)p;");
594   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
595   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
596 
597   Tokens = annotate("delete[] /*comment*/ (void *)p;");
598   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
599   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
600 
601   Tokens = annotate("delete[/*comment*/] (void *)p;");
602   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
603   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
604 
605   Tokens = annotate("delete/*comment*/[] (void *)p;");
606   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
607   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
608 }
609 
610 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
611   auto Tokens = annotate("(void)p;");
612   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
613   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
614 
615   Tokens = annotate("(uint32_t)&&label;");
616   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
617   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
618   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_UnaryOperator);
619   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
620 
621   Tokens = annotate("auto x = (Foo)p;");
622   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
623   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
624 
625   Tokens = annotate("(std::vector<int>)p;");
626   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
627   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
628 
629   Tokens = annotate("return (Foo)p;");
630   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
631   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
632 
633   Tokens = annotate("throw (Foo)p;");
634   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
635   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
636 
637   Tokens = annotate("#define FOO(x) (((uint64_t)(x) * BAR) / 100)");
638   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
639   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
640   EXPECT_TOKEN(Tokens[13], tok::r_paren, TT_Unknown);
641   EXPECT_TOKEN(Tokens[14], tok::star, TT_BinaryOperator);
642 
643   Tokens = annotate("#define foo(i) ((i) - bar)");
644   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
645   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_Unknown);
646   EXPECT_TOKEN(Tokens[10], tok::minus, TT_BinaryOperator);
647 
648   Tokens = annotate("return (Foo) & 10;");
649   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
650   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_Unknown);
651   EXPECT_TOKEN(Tokens[4], tok::amp, TT_BinaryOperator);
652 
653   Tokens = annotate("#define FOO(bar) foo((uint64_t)&bar)");
654   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
655   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
656   EXPECT_TOKEN(Tokens[11], tok::amp, TT_UnaryOperator);
657 
658   Tokens = annotate("#define FOO(bar) foo((Foo) & bar)");
659   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
660   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_Unknown);
661   EXPECT_TOKEN(Tokens[11], tok::amp, TT_BinaryOperator);
662 
663   auto Style = getLLVMStyle();
664   Style.TypeNames.push_back("Foo");
665   Tokens = annotate("#define FOO(bar) foo((Foo)&bar)", Style);
666   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
667   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_TypeName);
668   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
669   EXPECT_TOKEN(Tokens[11], tok::amp, TT_UnaryOperator);
670 }
671 
672 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
673   auto Tokens = annotate("void f() throw(int);");
674   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
675   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
676 }
677 
678 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
679   auto Tokens = annotate("void f() &;");
680   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
681   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
682 
683   Tokens = annotate("void operator=(T) &&;");
684   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
685   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
686 
687   Tokens = annotate("template <typename T> void f() &;");
688   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
689   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
690 
691   Tokens = annotate("template <typename T> void operator=(T) &;");
692   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
693   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
694 }
695 
696 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
697   auto Tokens = annotate("x.operator+()");
698   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
699   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
700   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
701   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
702   Tokens = annotate("x.operator=()");
703   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
704   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
705   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
706   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
707   Tokens = annotate("x.operator+=()");
708   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
709   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
710   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
711   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
712   Tokens = annotate("x.operator,()");
713   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
714   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
715   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
716   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
717   Tokens = annotate("x.operator()()");
718   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
719   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
720   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
721   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
722   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
723   Tokens = annotate("x.operator[]()");
724   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
725   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
726   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
727   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
728   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
729   Tokens = annotate("x.operator\"\"_a()");
730   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
731   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
732   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
733   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
734   Tokens = annotate("x.operator\"\" _a()");
735   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
736   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
737   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
738   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
739   Tokens = annotate("x.operator\"\"if()");
740   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
741   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
742   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
743   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
744   Tokens = annotate("x.operator\"\"s()");
745   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
746   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
747   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
748   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
749   Tokens = annotate("x.operator\"\" s()");
750   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
751   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
752   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
753   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
754 
755   Tokens = annotate("int operator+(int);");
756   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
757   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
758   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
759   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
760   Tokens = annotate("auto operator=(T&) {}");
761   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
762   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
763   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
764   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
765   Tokens = annotate("auto operator()() {}");
766   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
767   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
768   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
769   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
770   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
771 
772   Tokens = annotate("class Foo {\n"
773                     "  int operator+(a* b);\n"
774                     "}");
775   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
776   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
777   EXPECT_TOKEN(Tokens[5], tok::plus, TT_OverloadedOperator);
778   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_OverloadedOperatorLParen);
779   EXPECT_TOKEN(Tokens[8], tok::star, TT_PointerOrReference);
780 
781   Tokens = annotate("class Foo {\n"
782                     "  int c = operator+(a * b);\n"
783                     "}");
784   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
785   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_Unknown);
786   EXPECT_TOKEN(Tokens[7], tok::plus, TT_OverloadedOperator);
787   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_OverloadedOperatorLParen);
788   EXPECT_TOKEN(Tokens[10], tok::star, TT_BinaryOperator);
789 
790   Tokens = annotate("void foo() {\n"
791                     "  operator+(a * b);\n"
792                     "}");
793   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
794   EXPECT_TOKEN(Tokens[5], tok::kw_operator, TT_Unknown);
795   EXPECT_TOKEN(Tokens[6], tok::plus, TT_OverloadedOperator);
796   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
797   EXPECT_TOKEN(Tokens[9], tok::star, TT_BinaryOperator);
798 
799   Tokens = annotate("return operator+(a * b, c & d) + operator+(a && b && c);");
800   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
801   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_Unknown);
802   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
803   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
804   EXPECT_TOKEN(Tokens[5], tok::star, TT_BinaryOperator);
805   EXPECT_TOKEN(Tokens[9], tok::amp, TT_BinaryOperator);
806   EXPECT_TOKEN(Tokens[13], tok::kw_operator, TT_Unknown);
807   EXPECT_TOKEN(Tokens[14], tok::plus, TT_OverloadedOperator);
808   EXPECT_TOKEN(Tokens[15], tok::l_paren, TT_OverloadedOperatorLParen);
809   EXPECT_TOKEN(Tokens[17], tok::ampamp, TT_BinaryOperator);
810   EXPECT_TOKEN(Tokens[19], tok::ampamp, TT_BinaryOperator);
811 
812   Tokens = annotate("class Foo {\n"
813                     "  void foo() {\n"
814                     "    operator+(a * b);\n"
815                     "  }\n"
816                     "}");
817   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
818   EXPECT_TOKEN(Tokens[8], tok::kw_operator, TT_Unknown);
819   EXPECT_TOKEN(Tokens[9], tok::plus, TT_OverloadedOperator);
820   EXPECT_TOKEN(Tokens[10], tok::l_paren, TT_OverloadedOperatorLParen);
821   EXPECT_TOKEN(Tokens[12], tok::star, TT_BinaryOperator);
822 
823   Tokens = annotate("std::vector<Foo> operator()(Foo &foo);");
824   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
825   EXPECT_TOKEN(Tokens[3], tok::less, TT_TemplateOpener);
826   EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
827   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_FunctionDeclarationName);
828   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperator);
829   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_OverloadedOperator);
830   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_OverloadedOperatorLParen);
831   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
832 
833   Tokens = annotate("decltype(auto) operator()(T &x);");
834   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
835   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_TypeDeclarationParen);
836   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_TypeDeclarationParen);
837   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
838   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperator);
839   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_OverloadedOperator);
840   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
841   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
842 }
843 
844 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
845   struct {
846     const char *Text;
847     tok::TokenKind Kind;
848   } Operators[] = {{"+", tok::plus},
849                    {"-", tok::minus},
850                    // FIXME:
851                    // {"*", tok::star},
852                    {"/", tok::slash},
853                    {"%", tok::percent},
854                    {"^", tok::caret},
855                    // FIXME:
856                    // {"&", tok::amp},
857                    {"|", tok::pipe},
858                    {"~", tok::tilde},
859                    {"!", tok::exclaim},
860                    {"=", tok::equal},
861                    // FIXME:
862                    // {"<", tok::less},
863                    {">", tok::greater},
864                    {"+=", tok::plusequal},
865                    {"-=", tok::minusequal},
866                    {"*=", tok::starequal},
867                    {"/=", tok::slashequal},
868                    {"%=", tok::percentequal},
869                    {"^=", tok::caretequal},
870                    {"&=", tok::ampequal},
871                    {"|=", tok::pipeequal},
872                    {"<<", tok::lessless},
873                    {">>", tok::greatergreater},
874                    {">>=", tok::greatergreaterequal},
875                    {"<<=", tok::lesslessequal},
876                    {"==", tok::equalequal},
877                    {"!=", tok::exclaimequal},
878                    {"<=", tok::lessequal},
879                    {">=", tok::greaterequal},
880                    {"<=>", tok::spaceship},
881                    {"&&", tok::ampamp},
882                    {"||", tok::pipepipe},
883                    {"++", tok::plusplus},
884                    {"--", tok::minusminus},
885                    {",", tok::comma},
886                    {"->*", tok::arrowstar},
887                    {"->", tok::arrow}};
888 
889   for (const auto &Operator : Operators) {
890     std::string Input("C<&operator");
891     Input += Operator.Text;
892     Input += " > a;";
893     auto Tokens = annotate(std::string(Input));
894     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
895     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
896     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
897     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
898   }
899 
900   auto Tokens = annotate("C<&operator< <X>> lt;");
901   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
902   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
903   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
904   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
905   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
906   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
907 }
908 
909 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
910   auto Tokens = annotate("template <typename T>\n"
911                          "concept C = (Foo && Bar) && (Bar && Baz);");
912 
913   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
914   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
915   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
916   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
917 
918   Tokens = annotate("template <typename T>\n"
919                     "concept C = Foo && !Bar;");
920 
921   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
922   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
923   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
924 
925   Tokens = annotate("template <typename T>\n"
926                     "concept C = requires(T t) {\n"
927                     "  { t.foo() };\n"
928                     "} && Bar<T> && Baz<T>;");
929   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
930   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
931   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
932   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
933   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
934   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
935 
936   Tokens = annotate("template<typename T>\n"
937                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
938                     "struct Foo;");
939   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
940   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
941   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
942   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
943   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
944   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
945   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
946   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
947   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
948   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
949   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
950 
951   Tokens =
952       annotate("template<typename T>\n"
953                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
954                "struct Foo;");
955   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
956   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
957   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
958   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
959   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
960   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
961   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
962   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
963   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
964   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
965   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
966   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
967 
968   Tokens = annotate("template <typename T>\n"
969                     "void foo(T) noexcept requires Bar<T>;");
970   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
971   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
972 
973   Tokens = annotate("template <typename T>\n"
974                     "requires Bar<T> || Baz<T>\n"
975                     "auto foo(T) -> int;");
976   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
977   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
978   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
979   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
980   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
981 
982   Tokens = annotate("template <typename T>\n"
983                     "requires Bar<T>\n"
984                     "bool foo(T) { return false; }");
985   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
986   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
987   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
988   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
989 
990   Tokens = annotate("template <typename T>\n"
991                     "requires Bar<T>\n"
992                     "decltype(auto) foo(T) { return false; }");
993   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
994   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
995   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
996   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
997 
998   Tokens = annotate("template <typename T>\n"
999                     "struct S {\n"
1000                     "  void foo() const requires Bar<T>;\n"
1001                     "  void bar() const & requires Baz<T>;\n"
1002                     "  void bar() && requires Baz2<T>;\n"
1003                     "  void baz() const & noexcept requires Baz<T>;\n"
1004                     "  void baz() && noexcept requires Baz2<T>;\n"
1005                     "};\n"
1006                     "\n"
1007                     "void S::bar() const & requires Baz<T> { }");
1008   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
1009   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
1010   EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference);
1011   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
1012   EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference);
1013   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
1014   EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference);
1015   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
1016   EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference);
1017   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
1018   EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference);
1019   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
1020 
1021   Tokens = annotate("void Class::member() && requires(Constant) {}");
1022   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1023   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1024 
1025   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
1026   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1027   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1028 
1029   Tokens =
1030       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
1031   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1032   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1033 
1034   Tokens = annotate("void Class::member() && requires(typename "
1035                     "Namespace::Outer<T>::Inner::Constant) {}");
1036   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
1037   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1038 
1039   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
1040                     "  template<class T>\n"
1041                     "    requires requires { number_zero_v<T>; }\n"
1042                     "  [[nodiscard]] constexpr operator T() const { "
1043                     "return number_zero_v<T>; }\n"
1044                     "};");
1045   ASSERT_EQ(Tokens.size(), 44u) << Tokens;
1046   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
1047   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
1048   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
1049   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
1050   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
1051   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
1052 
1053   Tokens =
1054       annotate("template <class A, class B> concept C ="
1055                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
1056   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
1057   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
1058   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
1059   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
1060   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
1061   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
1062   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
1063   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
1064 
1065   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
1066   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1067   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1068 
1069   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
1070   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1071   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1072 
1073   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
1074   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1075   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1076 
1077   Tokens =
1078       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
1079   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1080   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1081 
1082   Tokens =
1083       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
1084   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1085   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1086 
1087   Tokens =
1088       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
1089   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1090   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
1091 
1092   Tokens = annotate("void foo() requires((A<T>) && C) {}");
1093   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1094   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1095   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_BinaryOperator);
1096 
1097   Tokens = annotate("void foo() requires(((A<T>) && C)) {}");
1098   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1099   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1100   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
1101 
1102   Tokens = annotate("void foo() requires([](T&&){}(t)) {}");
1103   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1104   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1105   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1106 
1107   Tokens = annotate("void foo() requires([](T&& u){}(t)) {}");
1108   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
1109   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1110   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1111 
1112   Tokens = annotate("void f() & requires(true) {}");
1113   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1114   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1115   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1116 
1117   Tokens = annotate("void f() & requires(C<true, true>) {}");
1118   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1119   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1120   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1121 
1122   Tokens = annotate("template <typename T>\n"
1123                     "concept C = (!Foo<T>) && Bar;");
1124   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1125   EXPECT_TOKEN(Tokens[15], tok::ampamp, TT_BinaryOperator);
1126 
1127   Tokens = annotate("void f() & requires(C<decltype(x)>) {}");
1128   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1129   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1130   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1131 
1132   Tokens = annotate("auto f() -> int& requires(C<decltype(x)>) {}");
1133   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1134   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1135   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1136 
1137   Tokens = annotate("bool x = t && requires(decltype(t) x) { x.foo(); };");
1138   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1139   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresExpression);
1140 
1141   Tokens = annotate("bool x = t && requires(Foo<decltype(t)> x) { x.foo(); };");
1142   ASSERT_EQ(Tokens.size(), 26u) << Tokens;
1143   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresExpression);
1144 
1145   Tokens = annotate("bool x = t && requires(Foo<C1 || C2> x) { x.foo(); };");
1146   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1147   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresExpression);
1148 }
1149 
1150 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
1151   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
1152   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1153   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1154   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1155   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1156 
1157   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
1158   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1159   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1160   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1161   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
1162 
1163   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
1164   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1165   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
1166   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
1167   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
1168 
1169   Tokens = annotate("foo(requires(const T t) {});");
1170   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1171   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1172   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1173   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1174 
1175   Tokens = annotate("foo(requires(const int t) {});");
1176   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1177   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1178   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1179   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1180 
1181   Tokens = annotate("foo(requires(const T t) {});");
1182   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1183   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1184   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1185   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1186 
1187   Tokens = annotate("foo(requires(int const* volatile t) {});");
1188   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1189   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1190   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1191   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1192   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1193 
1194   Tokens = annotate("foo(requires(T const* volatile t) {});");
1195   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1196   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1197   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1198   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1199   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1200 
1201   Tokens = annotate("foo(requires(T& t) {});");
1202   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1203   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1204   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1205   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
1206   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1207 
1208   Tokens = annotate("foo(requires(T&& t) {});");
1209   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1210   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1211   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1212   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
1213   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1214 
1215   Tokens = annotate("bool foo = requires(T& t) {};");
1216   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1217   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1218   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1219   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1220   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1221 
1222   Tokens = annotate("bool foo = requires(T&& t) {};");
1223   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1224   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1225   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1226   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
1227   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1228 
1229   Tokens =
1230       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
1231   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1232   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1233   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1234   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
1235   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
1236 
1237   Tokens = annotate("template <typename T>\n"
1238                     "concept C = requires(T T) {\n"
1239                     "  requires Bar<T> && Foo<T>;\n"
1240                     "};");
1241   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
1242   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1243   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1244   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1245   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
1246                TT_RequiresClauseInARequiresExpression);
1247 
1248   Tokens = annotate("template <typename T>\n"
1249                     "concept C = requires(T T) {\n"
1250                     "  { t.func() } -> std::same_as<int>;"
1251                     "  requires Bar<T> && Foo<T>;\n"
1252                     "};");
1253   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
1254   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1255   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1256   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1257   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
1258                TT_RequiresClauseInARequiresExpression);
1259 
1260   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
1261   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
1262                     "requires true; };");
1263   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1264   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1265   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1266   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
1267 
1268   Tokens = annotate("bool foo = requires(C<true, true> c) {\n"
1269                     "  { c.foo(); }\n"
1270                     "};");
1271   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1272   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1273   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1274   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1275 }
1276 
1277 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
1278   // Everything after #pragma region should be ImplicitStringLiteral
1279   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
1280   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1281   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
1282   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
1283   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
1284 
1285   // Make sure it's annotated correctly inside a function as well
1286   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
1287   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1288   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
1289   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
1290   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
1291 }
1292 
1293 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
1294   const char *BaseCode = nullptr;
1295   const char *ConstrainedCode = nullptr;
1296   auto BaseTokenCount = 0u;
1297   auto RequiresTokenCount = 0u;
1298   auto PrefixTokenCount = 0u;
1299 
1300   auto TestRequires = [&](int Line) {
1301     const auto BaseTokens = annotate(BaseCode);
1302     const auto ConstrainedTokens = annotate(ConstrainedCode);
1303 
1304 #define LINE " (Line " << Line << ')'
1305 
1306     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
1307     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
1308         << LINE;
1309 
1310     for (auto I = 0u; I < BaseTokenCount; ++I) {
1311       EXPECT_EQ(
1312           *BaseTokens[I],
1313           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
1314           << I << LINE;
1315     }
1316 
1317 #undef LINE
1318   };
1319 
1320   BaseCode = "template<typename T>\n"
1321              "T Pi = 3.14;";
1322   ConstrainedCode = "template<typename T>\n"
1323                     "  requires Foo<T>\n"
1324                     "T Pi = 3.14;";
1325   BaseTokenCount = 11;
1326   RequiresTokenCount = 5;
1327   PrefixTokenCount = 5;
1328   TestRequires(__LINE__);
1329 
1330   BaseCode = "template<typename T>\n"
1331              "struct Bar;";
1332   ConstrainedCode = "template<typename T>\n"
1333                     "  requires Foo<T>\n"
1334                     "struct Bar;";
1335   BaseTokenCount = 9;
1336   TestRequires(__LINE__);
1337 
1338   BaseCode = "template<typename T>\n"
1339              "struct Bar {\n"
1340              "  T foo();\n"
1341              "  T bar();\n"
1342              "};";
1343   ConstrainedCode = "template<typename T>\n"
1344                     "  requires Foo<T>\n"
1345                     "struct Bar {\n"
1346                     "  T foo();\n"
1347                     "  T bar();\n"
1348                     "};";
1349   BaseTokenCount = 21;
1350   TestRequires(__LINE__);
1351 
1352   BaseCode = "template<typename T>\n"
1353              "Bar(T) -> Bar<T>;";
1354   ConstrainedCode = "template<typename T>\n"
1355                     "  requires Foo<T>\n"
1356                     "Bar(T) -> Bar<T>;";
1357   BaseTokenCount = 16;
1358   TestRequires(__LINE__);
1359 
1360   BaseCode = "template<typename T>\n"
1361              "T foo();";
1362   ConstrainedCode = "template<typename T>\n"
1363                     "  requires Foo<T>\n"
1364                     "T foo();";
1365   BaseTokenCount = 11;
1366   TestRequires(__LINE__);
1367 
1368   BaseCode = "template<typename T>\n"
1369              "T foo() {\n"
1370              "  auto bar = baz();\n"
1371              "  return bar + T{};\n"
1372              "}";
1373   ConstrainedCode = "template<typename T>\n"
1374                     "  requires Foo<T>\n"
1375                     "T foo() {\n"
1376                     "  auto bar = baz();\n"
1377                     "  return bar + T{};\n"
1378                     "}";
1379   BaseTokenCount = 26;
1380   TestRequires(__LINE__);
1381 
1382   BaseCode = "template<typename T>\n"
1383              "T foo();";
1384   ConstrainedCode = "template<typename T>\n"
1385                     "T foo() requires Foo<T>;";
1386   BaseTokenCount = 11;
1387   PrefixTokenCount = 9;
1388   TestRequires(__LINE__);
1389 
1390   BaseCode = "template<typename T>\n"
1391              "T foo() {\n"
1392              "  auto bar = baz();\n"
1393              "  return bar + T{};\n"
1394              "}";
1395   ConstrainedCode = "template<typename T>\n"
1396                     "T foo() requires Foo<T> {\n"
1397                     "  auto bar = baz();\n"
1398                     "  return bar + T{};\n"
1399                     "}";
1400   BaseTokenCount = 26;
1401   TestRequires(__LINE__);
1402 
1403   BaseCode = "template<typename T>\n"
1404              "T foo();";
1405   ConstrainedCode = "template<typename T>\n"
1406                     "  requires(Foo<T>)\n"
1407                     "T foo();";
1408   BaseTokenCount = 11;
1409   RequiresTokenCount = 7;
1410   PrefixTokenCount = 5;
1411   TestRequires(__LINE__);
1412 
1413   BaseCode = "template<typename T>\n"
1414              "Bar(T) -> Bar<typename T::I>;";
1415   ConstrainedCode = "template<typename T>\n"
1416                     "  requires requires(T &&t) {\n"
1417                     "             typename T::I;\n"
1418                     "           }\n"
1419                     "Bar(T) -> Bar<typename T::I>;";
1420   BaseTokenCount = 19;
1421   RequiresTokenCount = 14;
1422   PrefixTokenCount = 5;
1423   TestRequires(__LINE__);
1424 
1425   BaseCode = "struct [[nodiscard]] zero_t {\n"
1426              "  template<class T>\n"
1427              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1428              "};";
1429   ConstrainedCode =
1430       "struct [[nodiscard]] zero_t {\n"
1431       "  template<class T>\n"
1432       "    requires requires { v<T>; }\n"
1433       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1434       "};";
1435   BaseTokenCount = 35;
1436   RequiresTokenCount = 9;
1437   PrefixTokenCount = 13;
1438   TestRequires(__LINE__);
1439 
1440   BaseCode = "constexpr Foo(Foo const &other)\n"
1441              "    : value{other.value} {\n"
1442              "  do_magic();\n"
1443              "  do_more_magic();\n"
1444              "}";
1445   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1446                     "  requires std::is_copy_constructible<T>\n"
1447                     "    : value{other.value} {\n"
1448                     "  do_magic();\n"
1449                     "  do_more_magic();\n"
1450                     "}";
1451   BaseTokenCount = 26;
1452   RequiresTokenCount = 7;
1453   PrefixTokenCount = 8;
1454   TestRequires(__LINE__);
1455 
1456   BaseCode = "constexpr Foo(Foo const &other)\n"
1457              "    : value{other.value} {\n"
1458              "  do_magic();\n"
1459              "  do_more_magic();\n"
1460              "}";
1461   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1462                     "  requires (std::is_copy_constructible<T>)\n"
1463                     "    : value{other.value} {\n"
1464                     "  do_magic();\n"
1465                     "  do_more_magic();\n"
1466                     "}";
1467   RequiresTokenCount = 9;
1468   TestRequires(__LINE__);
1469 
1470   BaseCode = "template<typename T>\n"
1471              "ANNOTATE(\"S\"\n"
1472              "         \"S\")\n"
1473              "void foo();";
1474   ConstrainedCode = "template<typename T>\n"
1475                     "  requires(true)\n"
1476                     "ANNOTATE(\"S\"\n"
1477                     "         \"S\")\n"
1478                     "void foo();";
1479   BaseTokenCount = 16;
1480   RequiresTokenCount = 4;
1481   PrefixTokenCount = 5;
1482   TestRequires(__LINE__);
1483 }
1484 
1485 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1486   auto Tokens = annotate("__asm{\n"
1487                          "a:\n"
1488                          "};");
1489   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1490   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1491   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1492   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
1493 }
1494 
1495 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1496   auto Tokens = annotate("int (^)() = ^ ()\n"
1497                          "  external_source_symbol() { //\n"
1498                          "  return 1;\n"
1499                          "};");
1500   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1501   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1502   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1503 
1504   Tokens = annotate("int *p = ^int*(){ //\n"
1505                     "  return nullptr;\n"
1506                     "}();");
1507   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1508   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1509 }
1510 
1511 TEST_F(TokenAnnotatorTest, UnderstandsObjCMethodExpr) {
1512   auto Tokens = annotate("void f() {\n"
1513                          "  //\n"
1514                          "  BOOL a = [b.c n] > 1;\n"
1515                          "}");
1516   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1517   EXPECT_TOKEN(Tokens[9], tok::l_square, TT_ObjCMethodExpr);
1518   EXPECT_TOKEN(Tokens[15], tok::greater, TT_BinaryOperator);
1519 }
1520 
1521 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1522   auto Tokens = annotate("[]() constexpr {}");
1523   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1524   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1525   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1526 
1527   Tokens = annotate("[]() consteval {}");
1528   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1529   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1530   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1531 
1532   Tokens = annotate("[]() mutable {}");
1533   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1534   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1535   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1536 
1537   Tokens = annotate("[]() static {}");
1538   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1539   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1540   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1541 
1542   Tokens = annotate("[]() -> auto {}");
1543   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1544   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1545   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1546   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1547 
1548   Tokens = annotate("[]() -> auto & {}");
1549   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1550   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1551   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1552   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1553 
1554   Tokens = annotate("[]() -> auto * {}");
1555   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1556   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1557   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1558   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1559 
1560   Tokens = annotate("[] {}");
1561   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1562   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1563   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1564 
1565   Tokens = annotate("[] noexcept {}");
1566   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1567   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1568   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1569 
1570   Tokens = annotate("[] -> auto {}");
1571   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1572   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1573   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_TrailingReturnArrow);
1574   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1575 
1576   Tokens = annotate("[] <typename T> () {}");
1577   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1578   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1579   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1580   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1581 
1582   Tokens = annotate("[] <typename T> {}");
1583   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1584   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1585   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1586   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1587 
1588   Tokens = annotate("[] <typename... T> () {}");
1589   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1590   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1591   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1592   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1593 
1594   Tokens = annotate("[] <typename... T> {}");
1595   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1596   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1597   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1598   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1599 
1600   Tokens = annotate("[] <int... T> () {}");
1601   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1602   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1603   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1604   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1605 
1606   Tokens = annotate("[] <int... T> {}");
1607   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1608   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1609   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1610   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1611 
1612   Tokens = annotate("[] <Foo... T> () {}");
1613   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1614   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1615   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1616   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1617 
1618   Tokens = annotate("[] <Foo... T> {}");
1619   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1620   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1621   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1622   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1623 
1624   // Lambdas with a requires-clause
1625   Tokens = annotate("[] <typename T> (T t) requires Bar<T> {}");
1626   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1627   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1628   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1629   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1630   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1631   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1632 
1633   Tokens = annotate("[] <typename T> (T &&t) requires Bar<T> {}");
1634   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1635   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1636   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1637   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_PointerOrReference);
1638   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1639   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1640   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1641 
1642   Tokens = annotate("[] <typename T> (T t) requires Foo<T> || Bar<T> {}");
1643   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1644   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1645   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1646   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1647   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1648   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1649 
1650   Tokens = annotate("[] <typename T> (T t) -> T requires Bar<T> {}");
1651   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1652   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1653   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1654   EXPECT_TOKEN(Tokens[10], tok::arrow, TT_TrailingReturnArrow);
1655   EXPECT_TOKEN(Tokens[12], tok::kw_requires, TT_RequiresClause);
1656   EXPECT_TRUE(Tokens[16]->ClosesRequiresClause);
1657   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1658 
1659   Tokens = annotate("[] <typename T> requires Bar<T> (T t) {}");
1660   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1661   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1662   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1663   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1664   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1665   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1666 
1667   Tokens = annotate("[] <typename T> requires Bar<T> (T &&t) {}");
1668   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1669   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1670   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1671   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1672   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1673   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_PointerOrReference);
1674   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1675 
1676   Tokens = annotate("[] <typename T> requires Foo<T> || Bar<T> (T t) {}");
1677   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1678   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1679   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1680   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1681   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1682   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1683 
1684   Tokens = annotate("[] <typename T> requires true (T&& t) {}");
1685   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1686   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1687   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1688   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1689   EXPECT_TRUE(Tokens[7]->ClosesRequiresClause);
1690   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1691   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1692 
1693   Tokens = annotate("[] <typename T> requires Bar<T> {}");
1694   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1695   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1696   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1697   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1698   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1699   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_LambdaLBrace);
1700 
1701   Tokens = annotate("[] <typename T> requires Bar<T> noexcept {}");
1702   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1703   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1704   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1705   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1706   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1707   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1708 
1709   Tokens = annotate("[] <typename T> requires Bar<T> -> T {}");
1710   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1711   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1712   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1713   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1714   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1715   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_TrailingReturnArrow);
1716   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1717 
1718   Tokens = annotate("[] <typename T> requires Foo<T> (T t) requires Bar<T> {}");
1719   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1720   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1721   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1722   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1723   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1724   EXPECT_TOKEN(Tokens[15], tok::kw_requires, TT_RequiresClause);
1725   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1726   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1727 
1728   Tokens = annotate("[] <typename T = int> (T t) {}");
1729   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1730   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1731   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1732   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1733   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1734 
1735   Tokens = annotate("[] <int I = 0> (T t) {}");
1736   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1737   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1738   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1739   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1740   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1741 
1742   Tokens = annotate("[] <bool b = false> (T t) {}");
1743   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1744   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1745   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1746   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1747   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1748 
1749   Tokens = annotate("[] <bool b = true && false> (T&& t) {}");
1750   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1751   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1752   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1753   EXPECT_TOKEN(Tokens[7], tok::ampamp, TT_BinaryOperator);
1754   EXPECT_TOKEN(Tokens[9], tok::greater, TT_TemplateCloser);
1755   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_PointerOrReference);
1756   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1757 
1758   Tokens = annotate("[] <typename T = int> requires Foo<T> (T t) {}");
1759   ASSERT_EQ(Tokens.size(), 20u) << 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::greater, TT_TemplateCloser);
1763   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1764   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1765 }
1766 
1767 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1768   auto Tokens = annotate("template <typename T>\n"
1769                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1770                          "string OldFunction(const string &parameter) {}");
1771   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1772   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1773 
1774   Tokens = annotate("template <typename T>\n"
1775                     "A(T) noexcept;");
1776   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1777   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1778 }
1779 
1780 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1781   auto Tokens = annotate("void f [[noreturn]] ();");
1782   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1783   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1784 
1785   Tokens = annotate("void f [[noreturn]] () {}");
1786   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1787   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1788 
1789   Tokens = annotate("#define FOO Foo::\n"
1790                     "FOO Foo();");
1791   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1792   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_FunctionDeclarationName);
1793 
1794   Tokens = annotate("struct Foo {\n"
1795                     "  Bar (*func)();\n"
1796                     "};");
1797   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1798   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
1799   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_FunctionTypeLParen);
1800 
1801   Tokens = annotate("void instanceof();");
1802   ASSERT_EQ(Tokens.size(), 6u);
1803   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1804 
1805   Tokens = annotate("int iso_time(time_t);");
1806   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1807   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1808 
1809   auto Style = getLLVMStyle();
1810   Style.TypeNames.push_back("MyType");
1811   Tokens = annotate("int iso_time(MyType);", Style);
1812   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1813   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1814   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_TypeName);
1815 }
1816 
1817 TEST_F(TokenAnnotatorTest, UnderstandsCtorAndDtorDeclNames) {
1818   auto Tokens = annotate("class Foo { public: Foo(); };");
1819   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1820   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_CtorDtorDeclName);
1821 
1822   Tokens = annotate("class Foo { public: ~Foo(); };");
1823   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1824   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_CtorDtorDeclName);
1825 
1826   Tokens = annotate("struct Foo { [[deprecated]] Foo() {} };");
1827   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1828   EXPECT_TOKEN(Tokens[8], tok::identifier, TT_CtorDtorDeclName);
1829   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1830 
1831   Tokens = annotate("struct Foo { [[deprecated]] ~Foo() {} };");
1832   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1833   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1834   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1835 
1836   Tokens = annotate("struct Foo { Foo() [[deprecated]] {} };");
1837   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1838   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1839   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1840 
1841   Tokens = annotate("struct Foo { ~Foo() [[deprecated]] {} };");
1842   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1843   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_CtorDtorDeclName);
1844   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1845 
1846   Tokens = annotate("struct Foo { [[deprecated]] explicit Foo() {} };");
1847   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1848   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1849   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1850 
1851   Tokens = annotate("struct Foo { virtual [[deprecated]] ~Foo() {} };");
1852   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1853   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_CtorDtorDeclName);
1854   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1855 
1856   Tokens = annotate("Foo::Foo() {}");
1857   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1858   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_CtorDtorDeclName);
1859   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
1860 
1861   Tokens = annotate("Foo::~Foo() {}");
1862   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1863   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1864   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
1865 
1866   Tokens = annotate("struct Test {\n"
1867                     "  Test()\n"
1868                     "      : l([] {\n"
1869                     "          Short::foo();\n"
1870                     "        }) {}\n"
1871                     "};");
1872   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1873   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1874   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_Unknown);
1875 }
1876 
1877 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1878   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1879   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1880   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1881   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1882   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1883 }
1884 
1885 TEST_F(TokenAnnotatorTest, UnderstandsTrailingReturnArrow) {
1886   auto Tokens = annotate("auto f() -> int;");
1887   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1888   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1889 
1890   Tokens = annotate("auto operator->() -> int;");
1891   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1892   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_OverloadedOperator);
1893   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1894 
1895   Tokens = annotate("auto operator++(int) -> int;");
1896   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1897   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1898 
1899   Tokens = annotate("auto operator=() -> int;");
1900   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1901   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1902 
1903   Tokens = annotate("auto operator=(int) -> int;");
1904   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1905   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1906 
1907   Tokens = annotate("auto foo() -> auto { return Val; }");
1908   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1909   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1910 
1911   Tokens = annotate("struct S { auto bar() const -> int; };");
1912   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1913   EXPECT_TOKEN(Tokens[8], tok::arrow, TT_TrailingReturnArrow);
1914 
1915   // Not trailing return arrows
1916   Tokens = annotate("auto a = b->c;");
1917   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1918   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1919 
1920   Tokens = annotate("auto a = (b)->c;");
1921   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1922   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1923 
1924   Tokens = annotate("auto a = b()->c;");
1925   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1926   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1927 
1928   Tokens = annotate("auto a = b->c();");
1929   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1930   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1931 
1932   Tokens = annotate("decltype(auto) a = b()->c;");
1933   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1934   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1935 
1936   Tokens = annotate("void f() { auto a = b->c(); }");
1937   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1938   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1939 
1940   Tokens = annotate("void f() { auto a = b()->c; }");
1941   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1942   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_Unknown);
1943 
1944   Tokens = annotate("#define P(ptr) auto p = (ptr)->p");
1945   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1946   EXPECT_TOKEN(Tokens[12], tok::arrow, TT_Unknown);
1947 
1948   Tokens = annotate("void f() FOO(foo->bar);");
1949   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1950   EXPECT_TOKEN(Tokens[7], tok::arrow, TT_Unknown);
1951 
1952   Tokens = annotate("__attribute__((cold)) C() : Base(obj->func()) {}");
1953   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1954   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
1955 
1956   // Mixed
1957   Tokens = annotate("auto f() -> int { auto a = b()->c; }");
1958   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1959   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1960   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
1961 }
1962 
1963 TEST_F(TokenAnnotatorTest, UnderstandHashInMacro) {
1964   auto Tokens = annotate("#define Foo(Bar) \\\n"
1965                          "  { \\\n"
1966                          "    #Bar \\\n"
1967                          "  }");
1968   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1969   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
1970   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
1971 
1972   Tokens = annotate("#define Foo(Bar) \\\n"
1973                     "  { #Bar }");
1974   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1975   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
1976   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
1977 
1978   Tokens = annotate("#define FOO(typeName, realClass) \\\n"
1979                     "  {#typeName, foo<Foo>(new foo<realClass>(#typeName))}");
1980   ASSERT_EQ(Tokens.size(), 29u) << Tokens;
1981   EXPECT_BRACE_KIND(Tokens[8], BK_BracedInit);
1982   EXPECT_BRACE_KIND(Tokens[27], BK_BracedInit);
1983 }
1984 
1985 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacros) {
1986   // '__attribute__' has special handling.
1987   auto Tokens = annotate("__attribute__(X) void Foo(void);");
1988   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1989   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
1990   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1991   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1992 
1993   // Generic macro has no special handling in this location.
1994   Tokens = annotate("A(X) void Foo(void);");
1995   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1996   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
1997   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_Unknown);
1998 
1999   // Add a custom AttributeMacro. Test that it has the same behavior.
2000   FormatStyle Style = getLLVMStyle();
2001   Style.AttributeMacros.push_back("A");
2002 
2003   // An "AttributeMacro" gets annotated like '__attribute__'.
2004   Tokens = annotate("A(X) void Foo(void);", Style);
2005   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2006   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
2007   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2008   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
2009 }
2010 
2011 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCDecl) {
2012   // '__attribute__' has special handling.
2013   auto Tokens = annotate("__attribute__(X) @interface Foo");
2014   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2015   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
2016   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2017   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
2018 
2019   // Generic macro has no special handling in this location.
2020   Tokens = annotate("A(X) @interface Foo");
2021   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2022   // Note: Don't check token-type as a random token in this position is hard to
2023   // reason about.
2024   EXPECT_TOKEN_KIND(Tokens[0], tok::identifier);
2025   EXPECT_TOKEN_KIND(Tokens[1], tok::l_paren);
2026 
2027   // Add a custom AttributeMacro. Test that it has the same behavior.
2028   FormatStyle Style = getLLVMStyle();
2029   Style.AttributeMacros.push_back("A");
2030 
2031   // An "AttributeMacro" gets annotated like '__attribute__'.
2032   Tokens = annotate("A(X) @interface Foo", Style);
2033   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2034   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
2035   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2036   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
2037 }
2038 
2039 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCMethodDecl) {
2040   // '__attribute__' has special handling.
2041   auto Tokens = annotate("- (id)init __attribute__(X);");
2042   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2043   EXPECT_TOKEN(Tokens[5], tok::kw___attribute, TT_Unknown);
2044   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
2045   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
2046 
2047   // Generic macro has no special handling in this location.
2048   Tokens = annotate("- (id)init A(X);");
2049   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2050   // Note: Don't check token-type as a random token in this position is hard to
2051   // reason about.
2052   EXPECT_TOKEN_KIND(Tokens[5], tok::identifier);
2053   EXPECT_TOKEN_KIND(Tokens[6], tok::l_paren);
2054 
2055   // Add a custom AttributeMacro. Test that it has the same behavior.
2056   FormatStyle Style = getLLVMStyle();
2057   Style.AttributeMacros.push_back("A");
2058 
2059   // An "AttributeMacro" gets annotated like '__attribute__'.
2060   Tokens = annotate("- (id)init A(X);", Style);
2061   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2062   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_AttributeMacro);
2063   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
2064   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
2065 }
2066 
2067 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCProperty) {
2068   // '__attribute__' has special handling.
2069   auto Tokens = annotate("@property(weak) id delegate __attribute__(X);");
2070   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2071   EXPECT_TOKEN(Tokens[7], tok::kw___attribute, TT_Unknown);
2072   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
2073   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
2074 
2075   // Generic macro has no special handling in this location.
2076   Tokens = annotate("@property(weak) id delegate A(X);");
2077   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2078   // Note: Don't check token-type as a random token in this position is hard to
2079   // reason about.
2080   EXPECT_TOKEN_KIND(Tokens[7], tok::identifier);
2081   EXPECT_TOKEN_KIND(Tokens[8], tok::l_paren);
2082 
2083   // Add a custom AttributeMacro. Test that it has the same behavior.
2084   FormatStyle Style = getLLVMStyle();
2085   Style.AttributeMacros.push_back("A");
2086 
2087   // An "AttributeMacro" gets annotated like '__attribute__'.
2088   Tokens = annotate("@property(weak) id delegate A(X);", Style);
2089   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2090   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_AttributeMacro);
2091   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
2092   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
2093 }
2094 
2095 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
2096   auto Annotate = [this](llvm::StringRef Code) {
2097     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
2098   };
2099   // Test that unary operators get labeled as such and that operators like '++'
2100   // don't get split.
2101   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
2102                             tok::tilde, tok::amp,      tok::pipe,
2103                             tok::caret, tok::plusplus, tok::minusminus};
2104   for (auto Kind : Unary) {
2105     auto Tokens =
2106         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
2107     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2108     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
2109   }
2110   // Operators formed by joining two operators like '^~'. For some of these
2111   // joined operators, we don't have a separate type, so we only test for their
2112   // precedence.
2113   std::pair<prec::Level, std::string> JoinedBinary[] = {
2114       {prec::Comma, "->"},        {prec::Comma, "<->"},
2115       {prec::Assignment, "+="},   {prec::Assignment, "-="},
2116       {prec::Assignment, "*="},   {prec::Assignment, "/="},
2117       {prec::Assignment, "%="},   {prec::Assignment, "&="},
2118       {prec::Assignment, "^="},   {prec::Assignment, "<<="},
2119       {prec::Assignment, ">>="},  {prec::Assignment, "<<<="},
2120       {prec::Assignment, ">>>="}, {prec::LogicalOr, "||"},
2121       {prec::LogicalAnd, "&&"},   {prec::Equality, "=="},
2122       {prec::Equality, "!="},     {prec::Equality, "==="},
2123       {prec::Equality, "!=="},    {prec::Equality, "==?"},
2124       {prec::Equality, "!=?"},    {prec::ExclusiveOr, "~^"},
2125       {prec::ExclusiveOr, "^~"},
2126   };
2127   for (auto Operator : JoinedBinary) {
2128     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
2129     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2130     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
2131     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
2132   }
2133   // '~^' and '^~' can be unary as well as binary operators.
2134   auto Tokens = Annotate("x = ~^x;");
2135   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2136   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
2137   Tokens = Annotate("x = ^~x;");
2138   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2139   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
2140   // The unary operators '~&' and '~|' can only be unary operators. The current
2141   // implementation treats each of them as separate unary '~' and '&' or '|'
2142   // operators, which is enough for formatting purposes. In FormatTestVerilog,
2143   // there is a test that there is no space in between. And even if a new line
2144   // is inserted between the '~' and '|', the semantic meaning is the same as
2145   // the joined operator, so the CanBreakBefore property doesn't need to be
2146   // false for the second operator.
2147   Tokens = Annotate("x = ~&x;");
2148   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2149   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2150   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
2151   Tokens = Annotate("x = ~|x;");
2152   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2153   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2154   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
2155   // Test for block label colons.
2156   Tokens = Annotate("begin : x\n"
2157                     "end : x");
2158   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2159   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
2160   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
2161   // Test that the dimension colon is annotated correctly.
2162   Tokens = Annotate("var [1 : 0] x;");
2163   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2164   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
2165   Tokens = Annotate("extern function [1 : 0] x;");
2166   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2167   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
2168   Tokens = Annotate("module test\n"
2169                     "    (input wire [7 : 0] a[7 : 0]);\n"
2170                     "endmodule");
2171   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2172   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_VerilogDimensionedTypeName);
2173   EXPECT_TOKEN(Tokens[7], tok::colon, TT_BitFieldColon);
2174   EXPECT_TOKEN(Tokens[13], tok::colon, TT_BitFieldColon);
2175   // Test case labels and ternary operators.
2176   Tokens = Annotate("case (x)\n"
2177                     "  x:\n"
2178                     "    x;\n"
2179                     "endcase");
2180   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2181   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CaseLabelColon);
2182   Tokens = Annotate("case (x)\n"
2183                     "  x ? x : x:\n"
2184                     "    x;\n"
2185                     "endcase");
2186   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2187   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
2188   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
2189   EXPECT_TOKEN(Tokens[9], tok::colon, TT_CaseLabelColon);
2190   // Non-blocking assignments.
2191   Tokens = Annotate("a <= b;");
2192   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2193   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2194   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2195   Tokens = Annotate("if (a <= b) break;");
2196   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2197   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2198   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2199   Tokens = Annotate("a <= b <= a;");
2200   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2201   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2202   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2203   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2204   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2205 
2206   // Port lists in module instantiation.
2207   Tokens = Annotate("module_x instance_1(port_1), instance_2(port_2);");
2208   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2209   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2210   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_VerilogInstancePortLParen);
2211   Tokens = Annotate("module_x #(parameter) instance_1(port_1), "
2212                     "instance_2(port_2);");
2213   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2214   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2215   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_VerilogInstancePortLParen);
2216   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_VerilogInstancePortLParen);
2217 
2218   // Condition parentheses.
2219   Tokens = Annotate("assert (x);");
2220   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2221   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2222   Tokens = Annotate("assert #0 (x);");
2223   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2224   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_ConditionLParen);
2225   Tokens = Annotate("assert final (x);");
2226   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2227   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2228   Tokens = Annotate("foreach (x[x]) continue;");
2229   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2230   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2231   Tokens = Annotate("repeat (x[x]) continue;");
2232   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2233   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2234   Tokens = Annotate("case (x) endcase;");
2235   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2236   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2237 
2238   // Sensitivity list. The TT_Unknown type is clearly not binding for the
2239   // future, please adapt if those tokens get annotated.  This test is only here
2240   // to prevent the comma from being annotated as TT_VerilogInstancePortComma.
2241   Tokens = Annotate("always @(posedge x, posedge y);");
2242   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2243   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_Unknown);
2244   EXPECT_TOKEN(Tokens[5], tok::comma, TT_Unknown);
2245   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2246 
2247   // String literals in concatenation.
2248   Tokens = Annotate("x = {\"\"};");
2249   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2250   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2251   Tokens = Annotate("x = {\"\", \"\"};");
2252   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2253   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2254   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2255   Tokens = Annotate("x = '{{\"\"}};");
2256   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2257   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2258   // Cases where the string should not be annotated that type.  Fix the
2259   // `TT_Unknown` if needed in the future.
2260   Tokens = Annotate("x = {\"\" == \"\"};");
2261   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2262   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_Unknown);
2263   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_Unknown);
2264   Tokens = Annotate("x = {(\"\")};");
2265   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2266   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2267   Tokens = Annotate("x = '{\"\"};");
2268   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2269   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2270 }
2271 
2272 TEST_F(TokenAnnotatorTest, UnderstandTableGenTokens) {
2273   auto Style = getLLVMStyle(FormatStyle::LK_TableGen);
2274   ASSERT_TRUE(Style.isTableGen());
2275 
2276   TestLexer Lexer(Allocator, Buffers, Style);
2277   AdditionalKeywords Keywords(Lexer.IdentTable);
2278   auto Annotate = [&Lexer](llvm::StringRef Code) {
2279     return Lexer.annotate(Code);
2280   };
2281 
2282   // Additional keywords representation test.
2283   auto Tokens = Annotate("def foo : Bar<1>;");
2284   ASSERT_TRUE(Keywords.isTableGenKeyword(*Tokens[0]));
2285   ASSERT_TRUE(Keywords.isTableGenDefinition(*Tokens[0]));
2286   ASSERT_TRUE(Tokens[0]->is(Keywords.kw_def));
2287   ASSERT_TRUE(Tokens[1]->is(TT_StartOfName));
2288 
2289   // Code, the multiline string token.
2290   Tokens = Annotate("[{ code is multiline string }]");
2291   ASSERT_EQ(Tokens.size(), 2u) << Tokens;
2292   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2293   EXPECT_FALSE(Tokens[0]->IsMultiline);
2294   // Case with multiple lines.
2295   Tokens = Annotate("[{ It can break\n"
2296                     "   across lines and the line breaks\n"
2297                     "   are retained in \n"
2298                     "   the string. }]");
2299   ASSERT_EQ(Tokens.size(), 2u) << Tokens;
2300   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2301   EXPECT_EQ(Tokens[0]->ColumnWidth, sizeof("[{ It can break\n") - 1);
2302   EXPECT_TRUE(Tokens[0]->IsMultiline);
2303   EXPECT_EQ(Tokens[0]->LastLineColumnWidth, sizeof("   the string. }]") - 1);
2304 
2305   // Numeric literals.
2306   Tokens = Annotate("1234");
2307   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2308   Tokens = Annotate("-1");
2309   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2310   Tokens = Annotate("+1234");
2311   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2312   Tokens = Annotate("0b0110");
2313   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2314   Tokens = Annotate("0x1abC");
2315   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2316 
2317   // Identifier tokens. In TableGen, identifiers can begin with a number.
2318   // In ambiguous cases, the lexer tries to lex it as a number.
2319   // Even if the try fails, it does not fall back to identifier lexing and
2320   // regard as an error.
2321   // The ambiguity is not documented. The result of those tests are based on the
2322   // implementation of llvm::TGLexer::LexToken.
2323   // This is invalid syntax of number, but not an identifier.
2324   Tokens = Annotate("0x1234x");
2325   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2326   Tokens = Annotate("identifier");
2327   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2328   // Identifier beginning with a number.
2329   Tokens = Annotate("0x");
2330   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2331   Tokens = Annotate("2dVector");
2332   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2333   Tokens = Annotate("01234Vector");
2334   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2335 
2336   // Structured statements.
2337   Tokens = Annotate("class Foo {}");
2338   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_FunctionLBrace);
2339   Tokens = Annotate("def Def: Foo {}");
2340   EXPECT_TOKEN(Tokens[2], tok::colon, TT_InheritanceColon);
2341   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2342   Tokens = Annotate("if cond then {} else {}");
2343   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ControlStatementLBrace);
2344   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_ElseLBrace);
2345   Tokens = Annotate("defset Foo Def2 = {}");
2346   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2347 
2348   // Bang Operators.
2349   Tokens = Annotate("!foreach");
2350   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenBangOperator);
2351   Tokens = Annotate("!if");
2352   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenBangOperator);
2353   Tokens = Annotate("!cond");
2354   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenCondOperator);
2355 
2356   auto AnnotateValue = [this, &Style](llvm::StringRef Code) {
2357     // Values are annotated only in specific context.
2358     auto Result = annotate(("def X { let V = " + Code + "; }").str(), Style);
2359     return decltype(Result){Result.begin() + 6, Result.end() - 3};
2360   };
2361   // Both of bang/cond operators.
2362   Tokens = AnnotateValue("!cond(!eq(x, 0): 1, true: x)");
2363   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
2364   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenCondOperator);
2365   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_TableGenBangOperator);
2366   EXPECT_TOKEN(Tokens[8], tok::colon, TT_TableGenCondOperatorColon);
2367   EXPECT_TOKEN(Tokens[10], tok::comma, TT_TableGenCondOperatorComma);
2368   EXPECT_TOKEN(Tokens[12], tok::colon, TT_TableGenCondOperatorColon);
2369   // DAGArg values with operator identifier
2370   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2371   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2372   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpener);
2373   EXPECT_TOKEN(Tokens[3], tok::colon, TT_TableGenDAGArgListColon);
2374   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown); // $src1
2375   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListComma);
2376   EXPECT_TOKEN(Tokens[7], tok::colon, TT_TableGenDAGArgListColon);
2377   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2378   // List literal
2379   Tokens = AnnotateValue("[1, 2, 3]");
2380   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2381   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_TableGenListOpener);
2382   EXPECT_TOKEN(Tokens[6], tok::r_square, TT_TableGenListCloser);
2383   // Suffixes of values
2384   Tokens = AnnotateValue("valid.field");
2385   ASSERT_EQ(Tokens.size(), 3u) << Tokens;
2386   EXPECT_TOKEN(Tokens[1], tok::period, TT_TableGenValueSuffix);
2387   // Code
2388   Tokens = AnnotateValue("[{ code is multiline string }]");
2389   ASSERT_EQ(Tokens.size(), 1u) << Tokens;
2390   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2391 
2392   // The definition
2393   Tokens = annotate("def Def : Parent<Child> {}", Style);
2394   ASSERT_EQ(Tokens.size(), 10u) << Tokens; // This contains eof.
2395   // We use inheritance colon and function brace. They are enough.
2396   EXPECT_TOKEN(Tokens[2], tok::colon, TT_InheritanceColon);
2397   EXPECT_TOKEN(Tokens[4], tok::less, TT_TemplateOpener);
2398   EXPECT_TOKEN(Tokens[6], tok::greater, TT_TemplateCloser);
2399   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
2400 
2401   // DAGArg breaking options. They use different token types depending on what
2402   // is specified.
2403   Style.TableGenBreakInsideDAGArg = FormatStyle::DAS_BreakElements;
2404 
2405   // When TableGenBreakInsideDAGArg is DAS_BreakElements and
2406   // TableGenBreakingDAGArgOperators is not specified, it makes all the DAGArg
2407   // elements to have line break.
2408   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2409   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2410   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2411   EXPECT_TOKEN(Tokens[1], tok::identifier,
2412                TT_TableGenDAGArgOperatorID); // ins
2413   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2414   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2415 
2416   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2417   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2418   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2419   EXPECT_TOKEN(Tokens[1], tok::identifier,
2420                TT_TableGenDAGArgOperatorID); // other
2421   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2422   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2423 
2424   // For non-identifier operators, breaks after the operator.
2425   Tokens = AnnotateValue("(!cast<Type>(\"Name\") type1:$src1, type2:$src2)");
2426   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2427   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2428   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_TableGenDAGArgOperatorToBreak);
2429   EXPECT_TOKEN(Tokens[11], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2430   EXPECT_TOKEN(Tokens[15], tok::r_paren, TT_TableGenDAGArgCloser);
2431 
2432   Style.TableGenBreakInsideDAGArg = FormatStyle::DAS_BreakAll;
2433 
2434   // When TableGenBreakInsideDAGArg is DAS_BreakAll and
2435   // TableGenBreakingDAGArgOperators is not specified, it makes all the DAGArg
2436   // to have line break inside it.
2437   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2438   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2439   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2440   EXPECT_TOKEN(Tokens[1], tok::identifier,
2441                TT_TableGenDAGArgOperatorToBreak); // ins
2442   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2443   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2444 
2445   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2446   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2447   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2448   EXPECT_TOKEN(Tokens[1], tok::identifier,
2449                TT_TableGenDAGArgOperatorToBreak); // other
2450   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2451   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2452 
2453   // If TableGenBreakingDAGArgOperators is specified, it is limited to the
2454   // specified operators.
2455   Style.TableGenBreakingDAGArgOperators = {"ins", "outs"};
2456   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2457   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2458   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2459   EXPECT_TOKEN(Tokens[1], tok::identifier,
2460                TT_TableGenDAGArgOperatorToBreak); // ins
2461   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2462   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2463 
2464   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2465   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2466   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpener);
2467   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_Unknown); // other
2468   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListComma);
2469   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2470 
2471   // If TableGenBreakingDAGArgOperators is enabled, it uses
2472   // TT_TableGenDAGArgListColonToAlign to annotate the colon to align.
2473   Style.AlignConsecutiveTableGenBreakingDAGArgColons.Enabled = true;
2474   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2475   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2476   EXPECT_TOKEN(Tokens[1], tok::identifier,
2477                TT_TableGenDAGArgOperatorToBreak); // ins
2478   EXPECT_TOKEN(Tokens[3], tok::colon, TT_TableGenDAGArgListColonToAlign);
2479   EXPECT_TOKEN(Tokens[7], tok::colon, TT_TableGenDAGArgListColonToAlign);
2480 
2481   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2482   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2483   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_Unknown); // other
2484   EXPECT_TOKEN(Tokens[3], tok::colon, TT_TableGenDAGArgListColon);
2485   EXPECT_TOKEN(Tokens[7], tok::colon, TT_TableGenDAGArgListColon);
2486 }
2487 
2488 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
2489   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
2490 
2491   // The TT_Unknown is clearly not binding for the future, please adapt if those
2492   // tokens get annotated.
2493   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2494   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2495   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2496   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
2497   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2498   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2499   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2500   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
2501   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
2502   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2503   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2504 
2505   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
2506   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2507   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2508   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2509   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
2510   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
2511   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2512   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2513   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
2514   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
2515   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2516   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2517 
2518   Tokens = annotate("class Class {\n"
2519                     "  Class() : BaseClass() {\n"
2520                     "#if 0\n"
2521                     "    // comment\n"
2522                     "#endif\n"
2523                     "  }\n"
2524                     "  Class f();\n"
2525                     "}");
2526   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
2527   EXPECT_TOKEN(Tokens[6], tok::colon, TT_CtorInitializerColon);
2528   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_FunctionLBrace);
2529   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2530 }
2531 
2532 TEST_F(TokenAnnotatorTest, UnderstandsConditionParens) {
2533   auto Tokens = annotate("if (x) {}");
2534   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2535   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2536   Tokens = annotate("if constexpr (x) {}");
2537   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2538   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2539   Tokens = annotate("if CONSTEXPR (x) {}");
2540   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2541   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2542   Tokens = annotate("if (x) {} else if (x) {}");
2543   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2544   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2545   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_ConditionLParen);
2546 }
2547 
2548 TEST_F(TokenAnnotatorTest, CSharpNullableTypes) {
2549   FormatStyle Style = getGoogleStyle(FormatStyle::LK_CSharp);
2550 
2551   auto Tokens = annotate("int? a;", Style);
2552   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2553   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2554 
2555   Tokens = annotate("int? a = 1;", Style);
2556   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2557   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2558 
2559   Tokens = annotate("int?)", Style);
2560   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
2561   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2562 
2563   Tokens = annotate("int?>", Style);
2564   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
2565   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2566 
2567   Tokens = annotate("cond? id : id2", Style);
2568   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2569   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2570 
2571   Tokens = annotate("cond ? cond2 ? : id1 : id2", Style);
2572   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2573   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2574 }
2575 
2576 TEST_F(TokenAnnotatorTest, UnderstandsLabels) {
2577   auto Tokens = annotate("{ x: break; }");
2578   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2579   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2580   Tokens = annotate("{ case x: break; }");
2581   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2582   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2583   Tokens = annotate("{ x: { break; } }");
2584   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2585   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2586   Tokens = annotate("{ case x: { break; } }");
2587   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2588   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2589 }
2590 
2591 TEST_F(TokenAnnotatorTest, UnderstandsNestedBlocks) {
2592   // The closing braces are not annotated. It doesn't seem to cause a problem.
2593   // So we only test for the opening braces.
2594   auto Tokens = annotate("{\n"
2595                          "  {\n"
2596                          "    { int a = 0; }\n"
2597                          "  }\n"
2598                          "  {}\n"
2599                          "}");
2600   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2601   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2602   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
2603   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
2604   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2605 }
2606 
2607 TEST_F(TokenAnnotatorTest, UnderstandDesignatedInitializers) {
2608   auto Tokens = annotate("SomeStruct { .a = 1 };");
2609   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2610   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2611   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2612 
2613   Tokens = annotate("SomeStruct { .a = 1, .b = 2 };");
2614   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2615   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2616   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2617   EXPECT_TOKEN(Tokens[7], tok::period, TT_DesignatedInitializerPeriod);
2618 
2619   Tokens = annotate("SomeStruct {\n"
2620                     "#ifdef FOO\n"
2621                     "  .a = 1,\n"
2622                     "#endif\n"
2623                     "  .b = 2\n"
2624                     "};");
2625   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2626   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2627   EXPECT_TOKEN(Tokens[5], tok::period, TT_DesignatedInitializerPeriod);
2628   EXPECT_TOKEN(Tokens[12], tok::period, TT_DesignatedInitializerPeriod);
2629 
2630   Tokens = annotate("SomeStruct {\n"
2631                     "#if defined FOO\n"
2632                     "  .a = 1,\n"
2633                     "#endif\n"
2634                     "  .b = 2\n"
2635                     "};");
2636   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2637   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2638   EXPECT_TOKEN(Tokens[6], tok::period, TT_DesignatedInitializerPeriod);
2639   EXPECT_TOKEN(Tokens[13], tok::period, TT_DesignatedInitializerPeriod);
2640 
2641   Tokens = annotate("Foo foo[] = {[0]{}};");
2642   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2643   EXPECT_TOKEN(Tokens[6], tok::l_square, TT_DesignatedInitializerLSquare);
2644   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
2645 }
2646 
2647 TEST_F(TokenAnnotatorTest, UnderstandsJavaScript) {
2648   auto Annotate = [this](llvm::StringRef Code) {
2649     return annotate(Code, getLLVMStyle(FormatStyle::LK_JavaScript));
2650   };
2651 
2652   // Dictionary.
2653   auto Tokens = Annotate("var x = {'x' : 1, 'y' : 2};");
2654   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2655   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_DictLiteral);
2656   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_SelectorName);
2657   EXPECT_TOKEN(Tokens[5], tok::colon, TT_DictLiteral);
2658   EXPECT_TOKEN(Tokens[8], tok::string_literal, TT_SelectorName);
2659   EXPECT_TOKEN(Tokens[9], tok::colon, TT_DictLiteral);
2660   // Change when we need to annotate these.
2661   EXPECT_BRACE_KIND(Tokens[3], BK_Unknown);
2662   EXPECT_BRACE_KIND(Tokens[11], BK_Unknown);
2663   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_Unknown);
2664 }
2665 
2666 TEST_F(TokenAnnotatorTest, UnderstandsAttributes) {
2667   auto Tokens = annotate("bool foo __attribute__((unused));");
2668   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2669   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_StartOfName);
2670   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2671   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_Unknown);
2672   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_Unknown);
2673   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_AttributeRParen);
2674 
2675   Tokens = annotate("bool foo __declspec(dllimport);");
2676   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2677   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2678   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2679 
2680   Tokens = annotate("bool __attribute__((unused)) foo;");
2681   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2682   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_AttributeLParen);
2683   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_Unknown);
2684   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_Unknown);
2685   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_AttributeRParen);
2686   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_StartOfName);
2687 
2688   Tokens = annotate("void __attribute__((x)) Foo();");
2689   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2690   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_AttributeLParen);
2691   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_Unknown);
2692   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_Unknown);
2693   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_AttributeRParen);
2694   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_FunctionDeclarationName);
2695 
2696   FormatStyle Style = getLLVMStyle();
2697   Style.AttributeMacros.push_back("FOO");
2698   Tokens = annotate("bool foo FOO(unused);", Style);
2699   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2700   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
2701   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2702   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2703 }
2704 
2705 TEST_F(TokenAnnotatorTest, UnderstandsControlStatements) {
2706   auto Tokens = annotate("while (true) {}");
2707   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2708   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2709   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2710 
2711   Tokens = annotate("for (;;) {}");
2712   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2713   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_ControlStatementLBrace);
2714   EXPECT_TOKEN(Tokens[6], tok::r_brace, TT_ControlStatementRBrace);
2715 
2716   Tokens = annotate("do {} while (true);");
2717   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2718   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_ControlStatementLBrace);
2719   EXPECT_TOKEN(Tokens[2], tok::r_brace, TT_ControlStatementRBrace);
2720 
2721   Tokens = annotate("if (true) {} else if (false) {} else {}");
2722   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
2723   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2724   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2725   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_ControlStatementLBrace);
2726   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_ControlStatementRBrace);
2727   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_ElseLBrace);
2728   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_ElseRBrace);
2729 
2730   Tokens = annotate("switch (foo) {}");
2731   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2732   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2733   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2734 }
2735 
2736 TEST_F(TokenAnnotatorTest, UnderstandsDoWhile) {
2737   auto Tokens = annotate("do { ++i; } while ( i > 5 );");
2738   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2739   EXPECT_TOKEN(Tokens[6], tok::kw_while, TT_DoWhile);
2740 
2741   Tokens = annotate("do ++i; while ( i > 5 );");
2742   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2743   EXPECT_TOKEN(Tokens[4], tok::kw_while, TT_DoWhile);
2744 }
2745 
2746 TEST_F(TokenAnnotatorTest, StartOfName) {
2747   auto Tokens = annotate("#pragma clang diagnostic push");
2748   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2749   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2750   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2751   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
2752 
2753   Tokens = annotate("#pragma clang diagnostic ignored \"-Wzero-length-array\"");
2754   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2755   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2756   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2757   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
2758 
2759   Tokens = annotate("#define FOO Foo foo");
2760   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2761   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2762   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2763   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_StartOfName);
2764 
2765   Tokens = annotate("@interface NSCoder (TestCoder)");
2766   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2767   EXPECT_TOKEN(Tokens[0], tok::at, TT_ObjCDecl);
2768   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_StartOfName);
2769 }
2770 
2771 TEST_F(TokenAnnotatorTest, BraceKind) {
2772   auto Tokens = annotate("void f() {};");
2773   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2774   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2775   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2776   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2777   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2778 
2779   Tokens = annotate("class Foo<int> f() {}");
2780   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2781   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_FunctionDeclarationName);
2782   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_FunctionLBrace);
2783   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
2784   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
2785 
2786   Tokens = annotate("template <typename T> class Foo<T> f() {}");
2787   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2788   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_FunctionDeclarationName);
2789   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2790   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2791   EXPECT_BRACE_KIND(Tokens[14], BK_Block);
2792 
2793   Tokens = annotate("void f() override {};");
2794   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2795   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2796   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
2797   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2798   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2799 
2800   Tokens = annotate("void f() noexcept(false) {};");
2801   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2802   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2803   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_FunctionLBrace);
2804   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
2805   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
2806 
2807   Tokens = annotate("auto f() -> void {};");
2808   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2809   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2810   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
2811   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2812   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
2813 
2814   Tokens = annotate("void f() { /**/ };");
2815   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2816   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2817   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2818   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2819   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2820 
2821   Tokens = annotate("void f() { //\n"
2822                     "};");
2823   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2824   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2825   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2826   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2827   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2828 
2829   Tokens = annotate("void f() {\n"
2830                     "  //\n"
2831                     "};");
2832   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2833   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2834   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2835   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2836   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2837 
2838   Tokens = annotate("struct Foo {\n"
2839                     "  Foo() {};\n"
2840                     "  ~Foo() {};\n"
2841                     "};");
2842   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2843   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
2844   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
2845   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2846   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
2847   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_CtorDtorDeclName);
2848   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2849   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2850   EXPECT_BRACE_KIND(Tokens[14], BK_Block);
2851 
2852   Tokens = annotate("{\n"
2853                     "  char *a[] = {\n"
2854                     "      /* abc */ \"abc\",\n"
2855                     "#if FOO\n"
2856                     "      /* xyz */ \"xyz\",\n"
2857                     "#endif\n"
2858                     "      /* last */ \"last\"};\n"
2859                     "}");
2860   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
2861   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2862   EXPECT_BRACE_KIND(Tokens[7], BK_BracedInit);
2863   EXPECT_BRACE_KIND(Tokens[21], BK_BracedInit);
2864 
2865   Tokens =
2866       annotate("#define SCOP_STAT(NAME, DESC) \\\n"
2867                "  {\"polly\", #NAME, \"Number of rejected regions: \" DESC}");
2868   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
2869   EXPECT_BRACE_KIND(Tokens[8], BK_BracedInit);
2870   EXPECT_BRACE_KIND(Tokens[16], BK_BracedInit);
2871 
2872   Tokens = annotate("struct {};");
2873   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2874   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
2875   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
2876 
2877   Tokens = annotate("struct : Base {};");
2878   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2879   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
2880   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2881 
2882   Tokens = annotate("struct Foo {};");
2883   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2884   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
2885   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
2886 
2887   Tokens = annotate("struct ::Foo {};");
2888   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2889   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
2890   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2891 
2892   Tokens = annotate("struct NS::Foo {};");
2893   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2894   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2895   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2896 
2897   Tokens = annotate("struct Foo<int> {};");
2898   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2899   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2900   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2901 
2902   Tokens = annotate("struct Foo final {};");
2903   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2904   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
2905   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2906 
2907   Tokens = annotate("struct [[foo]] [[bar]] Foo final : Base1, Base2 {};");
2908   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
2909   EXPECT_BRACE_KIND(Tokens[17], BK_Block);
2910   EXPECT_BRACE_KIND(Tokens[18], BK_Block);
2911 
2912   Tokens = annotate("struct Foo x{};");
2913   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2914   EXPECT_BRACE_KIND(Tokens[3], BK_BracedInit);
2915   EXPECT_BRACE_KIND(Tokens[4], BK_BracedInit);
2916 
2917   Tokens = annotate("struct ::Foo x{};");
2918   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2919   EXPECT_BRACE_KIND(Tokens[4], BK_BracedInit);
2920   EXPECT_BRACE_KIND(Tokens[5], BK_BracedInit);
2921 
2922   Tokens = annotate("struct NS::Foo x{};");
2923   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2924   EXPECT_BRACE_KIND(Tokens[5], BK_BracedInit);
2925   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
2926 
2927   Tokens = annotate("struct Foo<int> x{};");
2928   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2929   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
2930   EXPECT_BRACE_KIND(Tokens[7], BK_BracedInit);
2931 
2932   Tokens = annotate("#ifdef DEBUG_ENABLED\n"
2933                     "#else\n"
2934                     "#endif\n"
2935                     "class RenderingServer : Object {\n"
2936                     "#ifndef DISABLE_DEPRECATED\n"
2937                     "  enum Features {\n"
2938                     "    FEATURE_SHADERS,\n"
2939                     "    FEATURE_MULTITHREADED,\n"
2940                     "  };\n"
2941                     "#endif\n"
2942                     "};");
2943   ASSERT_EQ(Tokens.size(), 29u) << Tokens;
2944   EXPECT_BRACE_KIND(Tokens[11], BK_Block);
2945   EXPECT_BRACE_KIND(Tokens[17], BK_Block);
2946   EXPECT_BRACE_KIND(Tokens[22], BK_Block);
2947   EXPECT_BRACE_KIND(Tokens[26], BK_Block);
2948 }
2949 
2950 TEST_F(TokenAnnotatorTest, UnderstandsElaboratedTypeSpecifier) {
2951   auto Tokens = annotate("auto foo() -> enum En {}");
2952   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2953   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
2954 }
2955 
2956 TEST_F(TokenAnnotatorTest, BlockLBrace) {
2957   auto Tokens = annotate("{\n"
2958                          "  {\n"
2959                          "    foo();\n"
2960                          "  }\n"
2961                          "}");
2962   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2963   EXPECT_TOKEN(Tokens[0], tok::l_brace, TT_BlockLBrace);
2964   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2965   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_BlockLBrace);
2966   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
2967 
2968   Tokens = annotate("void bar() {\n"
2969                     "  {\n"
2970                     "    foo();\n"
2971                     "  }\n"
2972                     "}");
2973   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2974   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2975   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2976   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_BlockLBrace);
2977   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2978 }
2979 
2980 } // namespace
2981 } // namespace format
2982 } // namespace clang
2983