xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision 6f46bcc609f14121e6942763ba9871f98541ea0e)
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   EXPECT_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   EXPECT_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   EXPECT_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   EXPECT_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   EXPECT_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   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
88   EXPECT_TOKEN(Tokens[1], tok::star, TT_UnaryOperator);
89   Tokens = annotate("case &x:");
90   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
91   EXPECT_TOKEN(Tokens[1], tok::amp, TT_UnaryOperator);
92 
93   Tokens = annotate("bool b = 3 == int{3} && true;\n");
94   EXPECT_EQ(Tokens.size(), 13u) << Tokens;
95   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
96 
97   Tokens = annotate("struct {\n"
98                     "} *ptr;");
99   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
100   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
101   Tokens = annotate("union {\n"
102                     "} *ptr;");
103   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
104   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
105   Tokens = annotate("class {\n"
106                     "} *ptr;");
107   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
108   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
109 
110   Tokens = annotate("struct {\n"
111                     "} &&ptr = {};");
112   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
113   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
114   Tokens = annotate("union {\n"
115                     "} &&ptr = {};");
116   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
117   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
118   Tokens = annotate("class {\n"
119                     "} &&ptr = {};");
120   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
121   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
122   Tokens = annotate("int i = int{42} * 2;");
123   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
124   EXPECT_TOKEN(Tokens[7], tok::star, TT_BinaryOperator);
125 
126   Tokens = annotate("delete[] *ptr;");
127   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
128   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
129   Tokens = annotate("delete[] **ptr;");
130   EXPECT_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   EXPECT_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   EXPECT_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   EXPECT_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   EXPECT_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   EXPECT_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 
303 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) {
304   auto Tokens = annotate("x - 0");
305   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
306   EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator);
307   Tokens = annotate("0 + 0");
308   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
309   EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator);
310   Tokens = annotate("x + +0");
311   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
312   EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator);
313   Tokens = annotate("x ? -0 : +0");
314   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
315   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
316   EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator);
317   Tokens = annotate("(-0)");
318   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
319   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
320   Tokens = annotate("0, -0");
321   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
322   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
323   Tokens = annotate("for (; -1;) {\n}");
324   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
325   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
326   Tokens = annotate("x = -1;");
327   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
328   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
329   Tokens = annotate("x[-1]");
330   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
331   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
332   Tokens = annotate("x = {-1};");
333   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
334   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
335   Tokens = annotate("case -x:");
336   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
337   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
338   Tokens = annotate("co_await -x;");
339   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
340   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
341   Tokens = annotate("co_return -x;");
342   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
343   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
344   Tokens = annotate("co_yield -x;");
345   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
346   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
347   Tokens = annotate("delete -x;");
348   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
349   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
350   Tokens = annotate("return -x;");
351   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
352   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
353   Tokens = annotate("throw -x;");
354   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
355   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
356   Tokens = annotate("sizeof -x");
357   ASSERT_EQ(Tokens.size(), 4u) << 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::plus, TT_UnaryOperator);
362   Tokens = annotate("co_return +x;");
363   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
364   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
365   Tokens = annotate("co_yield +x;");
366   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
367   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
368   Tokens = annotate("delete +x;");
369   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
370   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
371   Tokens = annotate("return +x;");
372   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
373   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
374   Tokens = annotate("throw +x;");
375   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
376   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
377   Tokens = annotate("sizeof +x");
378   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
379   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
380   Tokens = annotate("(int)-x");
381   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
382   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
383   Tokens = annotate("(-x)");
384   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
385   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
386   Tokens = annotate("!+x");
387   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
388   EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator);
389   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
390 }
391 
392 TEST_F(TokenAnnotatorTest, UnderstandsClasses) {
393   auto Tokens = annotate("class C {};");
394   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
395   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
396   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_ClassRBrace);
397 
398   Tokens = annotate("const class C {} c;");
399   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
400   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace);
401   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_ClassRBrace);
402 
403   Tokens = annotate("const class {} c;");
404   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
405   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
406   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_ClassRBrace);
407 
408   Tokens = annotate("class [[deprecated(\"\")]] C { int i; };");
409   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
410   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_ClassLBrace);
411   EXPECT_TOKEN(Tokens[14], tok::r_brace, TT_ClassRBrace);
412 }
413 
414 TEST_F(TokenAnnotatorTest, UnderstandsStructs) {
415   auto Tokens = annotate("struct S {};");
416   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
417   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace);
418   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_StructRBrace);
419 
420   Tokens = annotate("struct EXPORT_MACRO [[nodiscard]] C { int i; };");
421   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
422   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_StructLBrace);
423   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_StructRBrace);
424 
425   Tokens = annotate("struct [[deprecated]] [[nodiscard]] C { int i; };");
426   EXPECT_EQ(Tokens.size(), 19u) << Tokens;
427   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_StructLBrace);
428   EXPECT_TOKEN(Tokens[16], tok::r_brace, TT_StructRBrace);
429 
430   Tokens = annotate("template <typename T> struct S<const T[N]> {};");
431   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
432   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
433   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
434   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
435   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
436   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_StructRBrace);
437 
438   Tokens = annotate("template <typename T> struct S<T const[N]> {};");
439   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
440   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
441   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
442   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
443   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
444   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_StructRBrace);
445 
446   Tokens = annotate("template <typename T, unsigned n> struct S<T const[n]> {\n"
447                     "  void f(T const (&a)[n]);\n"
448                     "};");
449   EXPECT_EQ(Tokens.size(), 35u) << Tokens;
450   EXPECT_TOKEN(Tokens[10], tok::less, TT_TemplateOpener);
451   EXPECT_TOKEN(Tokens[13], tok::l_square, TT_ArraySubscriptLSquare);
452   EXPECT_TOKEN(Tokens[16], tok::greater, TT_TemplateCloser);
453   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_StructLBrace);
454   EXPECT_TOKEN(Tokens[23], tok::l_paren, TT_FunctionTypeLParen);
455   EXPECT_TOKEN(Tokens[24], tok::amp, TT_UnaryOperator);
456   EXPECT_TOKEN(Tokens[27], tok::l_square, TT_ArraySubscriptLSquare);
457   EXPECT_TOKEN(Tokens[32], tok::r_brace, TT_StructRBrace);
458 }
459 
460 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
461   auto Tokens = annotate("union U {};");
462   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
463   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
464   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_UnionRBrace);
465 
466   Tokens = annotate("union U { void f() { return; } };");
467   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
468   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
469   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
470   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_UnionRBrace);
471 }
472 
473 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
474   auto Tokens = annotate("enum E {};");
475   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
476   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
477   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_EnumRBrace);
478 }
479 
480 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
481   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
482   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
483   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
484 
485   Tokens = annotate("template <typename T> void F(T) && = delete;");
486   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
487   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
488 }
489 
490 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
491   auto Tokens =
492       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
493   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
494   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
495 }
496 
497 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
498   auto Tokens =
499       annotate("template <typename T> "
500                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
501   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
502   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
503 }
504 
505 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) {
506   auto Tokens =
507       annotate("#define FOO(typeName) \\\n"
508                "  { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }");
509   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
510   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
511   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
512   EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener);
513   EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser);
514 }
515 
516 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) {
517   auto Tokens = annotate("if (std::tuple_size_v<T> > 0)");
518   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
519   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
520   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
521   EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator);
522 }
523 
524 TEST_F(TokenAnnotatorTest, UnderstandsNonTemplateAngleBrackets) {
525   auto Tokens = annotate("return a < b && c > d;");
526   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
527   EXPECT_TOKEN(Tokens[2], tok::less, TT_BinaryOperator);
528   EXPECT_TOKEN(Tokens[6], tok::greater, TT_BinaryOperator);
529 
530   Tokens = annotate("a < 0 ? b : a > 0 ? c : d;");
531   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
532   EXPECT_TOKEN(Tokens[1], tok::less, TT_BinaryOperator);
533   EXPECT_TOKEN(Tokens[7], tok::greater, TT_BinaryOperator);
534 
535   Tokens = annotate("ratio{-1, 2} < ratio{-1, 3} == -1 / 3 > -1 / 2;");
536   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
537   EXPECT_TOKEN(Tokens[7], tok::less, TT_BinaryOperator);
538   EXPECT_TOKEN(Tokens[20], tok::greater, TT_BinaryOperator);
539 }
540 
541 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
542   FormatStyle Style = getLLVMStyle();
543   Style.WhitespaceSensitiveMacros.push_back("FOO");
544 
545   auto Tokens = annotate("FOO(1+2 )\n", Style);
546   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
547   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
548 
549   Tokens = annotate("FOO(a:b:c)\n", Style);
550   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
551   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
552 }
553 
554 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
555   auto Tokens = annotate("delete (void *)p;");
556   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
557   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
558 
559   Tokens = annotate("delete[] (void *)p;");
560   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
561   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
562 
563   Tokens = annotate("delete[] /*comment*/ (void *)p;");
564   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
565   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
566 
567   Tokens = annotate("delete[/*comment*/] (void *)p;");
568   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
569   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
570 
571   Tokens = annotate("delete/*comment*/[] (void *)p;");
572   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
573   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
574 }
575 
576 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
577   auto Tokens = annotate("(void)p;");
578   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
579   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
580 
581   Tokens = annotate("auto x = (Foo)p;");
582   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
583   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
584 
585   Tokens = annotate("(std::vector<int>)p;");
586   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
587   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
588 
589   Tokens = annotate("return (Foo)p;");
590   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
591   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
592 
593   Tokens = annotate("throw (Foo)p;");
594   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
595   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
596 
597   Tokens = annotate("#define FOO(x) (((uint64_t)(x) * BAR) / 100)");
598   EXPECT_EQ(Tokens.size(), 21u) << Tokens;
599   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
600   EXPECT_TOKEN(Tokens[13], tok::r_paren, TT_Unknown);
601   EXPECT_TOKEN(Tokens[14], tok::star, TT_BinaryOperator);
602 
603   Tokens = annotate("return (Foo) & 10;");
604   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
605   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_Unknown);
606   EXPECT_TOKEN(Tokens[4], tok::amp, TT_BinaryOperator);
607 }
608 
609 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
610   auto Tokens = annotate("void f() throw(int);");
611   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
612   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
613 }
614 
615 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
616   auto Tokens = annotate("void f() &;");
617   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
618   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
619 
620   Tokens = annotate("void operator=(T) &&;");
621   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
622   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
623 
624   Tokens = annotate("template <typename T> void f() &;");
625   EXPECT_EQ(Tokens.size(), 12u) << Tokens;
626   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
627 
628   Tokens = annotate("template <typename T> void operator=(T) &;");
629   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
630   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
631 }
632 
633 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
634   auto Tokens = annotate("x.operator+()");
635   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
636   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
637   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
638   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
639   Tokens = annotate("x.operator=()");
640   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
641   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
642   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
643   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
644   Tokens = annotate("x.operator+=()");
645   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
646   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
647   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
648   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
649   Tokens = annotate("x.operator,()");
650   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
651   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
652   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
653   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
654   Tokens = annotate("x.operator()()");
655   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
656   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
657   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
658   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
659   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
660   Tokens = annotate("x.operator[]()");
661   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
662   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
663   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
664   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
665   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
666   Tokens = annotate("x.operator\"\"_a()");
667   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
668   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
669   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
670   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
671   Tokens = annotate("x.operator\"\" _a()");
672   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
673   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
674   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
675   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
676   Tokens = annotate("x.operator\"\"if()");
677   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
678   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
679   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
680   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
681   Tokens = annotate("x.operator\"\"s()");
682   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
683   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
684   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
685   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
686   Tokens = annotate("x.operator\"\" s()");
687   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
688   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
689   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
690   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
691 
692   Tokens = annotate("int operator+(int);");
693   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
694   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
695   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
696   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
697   Tokens = annotate("auto operator=(T&) {}");
698   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
699   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
700   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
701   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
702   Tokens = annotate("auto operator()() {}");
703   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
704   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
705   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
706   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
707   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
708 
709   Tokens = annotate("class Foo {\n"
710                     "  int operator+(a* b);\n"
711                     "}");
712   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
713   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
714   EXPECT_TOKEN(Tokens[5], tok::plus, TT_OverloadedOperator);
715   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_OverloadedOperatorLParen);
716   EXPECT_TOKEN(Tokens[8], tok::star, TT_PointerOrReference);
717 
718   Tokens = annotate("class Foo {\n"
719                     "  int c = operator+(a * b);\n"
720                     "}");
721   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
722   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_Unknown);
723   EXPECT_TOKEN(Tokens[7], tok::plus, TT_OverloadedOperator);
724   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_OverloadedOperatorLParen);
725   EXPECT_TOKEN(Tokens[10], tok::star, TT_BinaryOperator);
726 
727   Tokens = annotate("void foo() {\n"
728                     "  operator+(a * b);\n"
729                     "}");
730   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
731   EXPECT_TOKEN(Tokens[5], tok::kw_operator, TT_Unknown);
732   EXPECT_TOKEN(Tokens[6], tok::plus, TT_OverloadedOperator);
733   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
734   EXPECT_TOKEN(Tokens[9], tok::star, TT_BinaryOperator);
735 
736   Tokens = annotate("return operator+(a * b, c & d) + operator+(a && b && c);");
737   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
738   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_Unknown);
739   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
740   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
741   EXPECT_TOKEN(Tokens[5], tok::star, TT_BinaryOperator);
742   EXPECT_TOKEN(Tokens[9], tok::amp, TT_BinaryOperator);
743   EXPECT_TOKEN(Tokens[13], tok::kw_operator, TT_Unknown);
744   EXPECT_TOKEN(Tokens[14], tok::plus, TT_OverloadedOperator);
745   EXPECT_TOKEN(Tokens[15], tok::l_paren, TT_OverloadedOperatorLParen);
746   EXPECT_TOKEN(Tokens[17], tok::ampamp, TT_BinaryOperator);
747   EXPECT_TOKEN(Tokens[19], tok::ampamp, TT_BinaryOperator);
748 
749   Tokens = annotate("class Foo {\n"
750                     "  void foo() {\n"
751                     "    operator+(a * b);\n"
752                     "  }\n"
753                     "}");
754   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
755   EXPECT_TOKEN(Tokens[8], tok::kw_operator, TT_Unknown);
756   EXPECT_TOKEN(Tokens[9], tok::plus, TT_OverloadedOperator);
757   EXPECT_TOKEN(Tokens[10], tok::l_paren, TT_OverloadedOperatorLParen);
758   EXPECT_TOKEN(Tokens[12], tok::star, TT_BinaryOperator);
759 
760   Tokens = annotate("std::vector<Foo> operator()(Foo &foo);");
761   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
762   EXPECT_TOKEN(Tokens[3], tok::less, TT_TemplateOpener);
763   EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
764   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_FunctionDeclarationName);
765   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperator);
766   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_OverloadedOperator);
767   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_OverloadedOperatorLParen);
768   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
769 
770   Tokens = annotate("decltype(auto) operator()(T &x);");
771   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
772   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_TypeDeclarationParen);
773   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_TypeDeclarationParen);
774   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
775   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperator);
776   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_OverloadedOperator);
777   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
778   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
779 }
780 
781 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
782   struct {
783     const char *Text;
784     tok::TokenKind Kind;
785   } Operators[] = {{"+", tok::plus},
786                    {"-", tok::minus},
787                    // FIXME:
788                    // {"*", tok::star},
789                    {"/", tok::slash},
790                    {"%", tok::percent},
791                    {"^", tok::caret},
792                    // FIXME:
793                    // {"&", tok::amp},
794                    {"|", tok::pipe},
795                    {"~", tok::tilde},
796                    {"!", tok::exclaim},
797                    {"=", tok::equal},
798                    // FIXME:
799                    // {"<", tok::less},
800                    {">", tok::greater},
801                    {"+=", tok::plusequal},
802                    {"-=", tok::minusequal},
803                    {"*=", tok::starequal},
804                    {"/=", tok::slashequal},
805                    {"%=", tok::percentequal},
806                    {"^=", tok::caretequal},
807                    {"&=", tok::ampequal},
808                    {"|=", tok::pipeequal},
809                    {"<<", tok::lessless},
810                    {">>", tok::greatergreater},
811                    {">>=", tok::greatergreaterequal},
812                    {"<<=", tok::lesslessequal},
813                    {"==", tok::equalequal},
814                    {"!=", tok::exclaimequal},
815                    {"<=", tok::lessequal},
816                    {">=", tok::greaterequal},
817                    {"<=>", tok::spaceship},
818                    {"&&", tok::ampamp},
819                    {"||", tok::pipepipe},
820                    {"++", tok::plusplus},
821                    {"--", tok::minusminus},
822                    {",", tok::comma},
823                    {"->*", tok::arrowstar},
824                    {"->", tok::arrow}};
825 
826   for (const auto &Operator : Operators) {
827     std::string Input("C<&operator");
828     Input += Operator.Text;
829     Input += " > a;";
830     auto Tokens = annotate(std::string(Input));
831     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
832     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
833     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
834     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
835   }
836 
837   auto Tokens = annotate("C<&operator< <X>> lt;");
838   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
839   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
840   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
841   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
842   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
843   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
844 }
845 
846 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
847   auto Tokens = annotate("template <typename T>\n"
848                          "concept C = (Foo && Bar) && (Bar && Baz);");
849 
850   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
851   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
852   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
853   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
854 
855   Tokens = annotate("template <typename T>\n"
856                     "concept C = Foo && !Bar;");
857 
858   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
859   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
860   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
861 
862   Tokens = annotate("template <typename T>\n"
863                     "concept C = requires(T t) {\n"
864                     "  { t.foo() };\n"
865                     "} && Bar<T> && Baz<T>;");
866   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
867   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
868   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
869   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
870   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
871   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
872 
873   Tokens = annotate("template<typename T>\n"
874                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
875                     "struct Foo;");
876   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
877   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
878   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
879   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
880   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
881   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
882   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
883   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
884   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
885   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
886   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
887 
888   Tokens =
889       annotate("template<typename T>\n"
890                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
891                "struct Foo;");
892   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
893   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
894   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
895   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
896   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
897   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
898   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
899   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
900   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
901   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
902   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
903   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
904 
905   Tokens = annotate("template <typename T>\n"
906                     "void foo(T) noexcept requires Bar<T>;");
907   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
908   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
909 
910   Tokens = annotate("template <typename T>\n"
911                     "requires Bar<T> || Baz<T>\n"
912                     "auto foo(T) -> int;");
913   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
914   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
915   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
916   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
917   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
918 
919   Tokens = annotate("template <typename T>\n"
920                     "requires Bar<T>\n"
921                     "bool foo(T) { return false; }");
922   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
923   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
924   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
925   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
926 
927   Tokens = annotate("template <typename T>\n"
928                     "requires Bar<T>\n"
929                     "decltype(auto) foo(T) { return false; }");
930   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
931   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
932   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
933   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
934 
935   Tokens = annotate("template <typename T>\n"
936                     "struct S {\n"
937                     "  void foo() const requires Bar<T>;\n"
938                     "  void bar() const & requires Baz<T>;\n"
939                     "  void bar() && requires Baz2<T>;\n"
940                     "  void baz() const & noexcept requires Baz<T>;\n"
941                     "  void baz() && noexcept requires Baz2<T>;\n"
942                     "};\n"
943                     "\n"
944                     "void S::bar() const & requires Baz<T> { }");
945   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
946   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
947   EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference);
948   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
949   EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference);
950   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
951   EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference);
952   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
953   EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference);
954   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
955   EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference);
956   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
957 
958   Tokens = annotate("void Class::member() && requires(Constant) {}");
959   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
960   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
961 
962   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
963   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
964   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
965 
966   Tokens =
967       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
968   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
969   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
970 
971   Tokens = annotate("void Class::member() && requires(typename "
972                     "Namespace::Outer<T>::Inner::Constant) {}");
973   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
974   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
975 
976   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
977                     "  template<class T>\n"
978                     "    requires requires { number_zero_v<T>; }\n"
979                     "  [[nodiscard]] constexpr operator T() const { "
980                     "return number_zero_v<T>; }\n"
981                     "};");
982   ASSERT_EQ(Tokens.size(), 44u) << Tokens;
983   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
984   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
985   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
986   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
987   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
988   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
989 
990   Tokens =
991       annotate("template <class A, class B> concept C ="
992                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
993   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
994   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
995   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
996   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
997   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
998   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
999   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
1000   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
1001 
1002   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
1003   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1004   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1005 
1006   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
1007   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1008   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1009 
1010   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
1011   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1012   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1013 
1014   Tokens =
1015       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
1016   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1017   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1018 
1019   Tokens =
1020       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
1021   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1022   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1023 
1024   Tokens =
1025       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
1026   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1027   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
1028 
1029   Tokens = annotate("void foo() requires((A<T>) && C) {}");
1030   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1031   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1032   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_BinaryOperator);
1033 
1034   Tokens = annotate("void foo() requires(((A<T>) && C)) {}");
1035   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1036   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1037   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
1038 
1039   Tokens = annotate("void foo() requires([](T&&){}(t)) {}");
1040   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1041   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1042   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1043 
1044   Tokens = annotate("void foo() requires([](T&& u){}(t)) {}");
1045   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
1046   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1047   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1048 
1049   Tokens = annotate("void f() & requires(true) {}");
1050   EXPECT_EQ(Tokens.size(), 12u) << Tokens;
1051   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1052   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1053 
1054   Tokens = annotate("void f() & requires(C<true, true>) {}");
1055   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
1056   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1057   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1058 }
1059 
1060 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
1061   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
1062   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1063   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1064   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1065   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1066 
1067   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
1068   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1069   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1070   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1071   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
1072 
1073   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
1074   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1075   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
1076   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
1077   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
1078 
1079   Tokens = annotate("foo(requires(const T t) {});");
1080   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1081   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1082   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1083   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1084 
1085   Tokens = annotate("foo(requires(const int t) {});");
1086   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1087   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1088   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1089   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1090 
1091   Tokens = annotate("foo(requires(const T t) {});");
1092   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1093   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1094   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1095   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1096 
1097   Tokens = annotate("foo(requires(int const* volatile t) {});");
1098   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1099   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1100   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1101   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1102   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1103 
1104   Tokens = annotate("foo(requires(T const* volatile t) {});");
1105   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1106   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1107   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1108   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1109   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1110 
1111   Tokens = annotate("foo(requires(T& t) {});");
1112   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1113   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1114   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1115   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
1116   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1117 
1118   Tokens = annotate("foo(requires(T&& t) {});");
1119   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1120   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1121   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1122   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
1123   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1124 
1125   Tokens = annotate("bool foo = requires(T& t) {};");
1126   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1127   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1128   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1129   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1130   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1131 
1132   Tokens = annotate("bool foo = requires(T&& t) {};");
1133   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1134   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1135   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1136   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
1137   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1138 
1139   Tokens =
1140       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
1141   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1142   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1143   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1144   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
1145   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
1146 
1147   Tokens = annotate("template <typename T>\n"
1148                     "concept C = requires(T T) {\n"
1149                     "  requires Bar<T> && Foo<T>;\n"
1150                     "};");
1151   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
1152   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1153   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1154   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1155   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
1156                TT_RequiresClauseInARequiresExpression);
1157 
1158   Tokens = annotate("template <typename T>\n"
1159                     "concept C = requires(T T) {\n"
1160                     "  { t.func() } -> std::same_as<int>;"
1161                     "  requires Bar<T> && Foo<T>;\n"
1162                     "};");
1163   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
1164   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1165   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1166   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1167   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
1168                TT_RequiresClauseInARequiresExpression);
1169 
1170   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
1171   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
1172                     "requires true; };");
1173   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1174   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1175   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1176   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
1177 
1178   Tokens = annotate("bool foo = requires(C<true, true> c) {\n"
1179                     "  { c.foo(); }\n"
1180                     "};");
1181   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1182   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1183   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1184   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1185 }
1186 
1187 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
1188   // Everything after #pragma region should be ImplicitStringLiteral
1189   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
1190   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1191   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
1192   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
1193   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
1194 
1195   // Make sure it's annotated correctly inside a function as well
1196   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
1197   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1198   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
1199   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
1200   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
1201 }
1202 
1203 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
1204   const char *BaseCode = nullptr;
1205   const char *ConstrainedCode = nullptr;
1206   auto BaseTokenCount = 0u;
1207   auto RequiresTokenCount = 0u;
1208   auto PrefixTokenCount = 0u;
1209 
1210   auto TestRequires = [&](int Line) {
1211     const auto BaseTokens = annotate(BaseCode);
1212     const auto ConstrainedTokens = annotate(ConstrainedCode);
1213 
1214 #define LINE " (Line " << Line << ')'
1215 
1216     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
1217     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
1218         << LINE;
1219 
1220     for (auto I = 0u; I < BaseTokenCount; ++I) {
1221       EXPECT_EQ(
1222           *BaseTokens[I],
1223           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
1224           << I << LINE;
1225     }
1226 
1227 #undef LINE
1228   };
1229 
1230   BaseCode = "template<typename T>\n"
1231              "T Pi = 3.14;";
1232   ConstrainedCode = "template<typename T>\n"
1233                     "  requires Foo<T>\n"
1234                     "T Pi = 3.14;";
1235   BaseTokenCount = 11;
1236   RequiresTokenCount = 5;
1237   PrefixTokenCount = 5;
1238   TestRequires(__LINE__);
1239 
1240   BaseCode = "template<typename T>\n"
1241              "struct Bar;";
1242   ConstrainedCode = "template<typename T>\n"
1243                     "  requires Foo<T>\n"
1244                     "struct Bar;";
1245   BaseTokenCount = 9;
1246   TestRequires(__LINE__);
1247 
1248   BaseCode = "template<typename T>\n"
1249              "struct Bar {\n"
1250              "  T foo();\n"
1251              "  T bar();\n"
1252              "};";
1253   ConstrainedCode = "template<typename T>\n"
1254                     "  requires Foo<T>\n"
1255                     "struct Bar {\n"
1256                     "  T foo();\n"
1257                     "  T bar();\n"
1258                     "};";
1259   BaseTokenCount = 21;
1260   TestRequires(__LINE__);
1261 
1262   BaseCode = "template<typename T>\n"
1263              "Bar(T) -> Bar<T>;";
1264   ConstrainedCode = "template<typename T>\n"
1265                     "  requires Foo<T>\n"
1266                     "Bar(T) -> Bar<T>;";
1267   BaseTokenCount = 16;
1268   TestRequires(__LINE__);
1269 
1270   BaseCode = "template<typename T>\n"
1271              "T foo();";
1272   ConstrainedCode = "template<typename T>\n"
1273                     "  requires Foo<T>\n"
1274                     "T foo();";
1275   BaseTokenCount = 11;
1276   TestRequires(__LINE__);
1277 
1278   BaseCode = "template<typename T>\n"
1279              "T foo() {\n"
1280              "  auto bar = baz();\n"
1281              "  return bar + T{};\n"
1282              "}";
1283   ConstrainedCode = "template<typename T>\n"
1284                     "  requires Foo<T>\n"
1285                     "T foo() {\n"
1286                     "  auto bar = baz();\n"
1287                     "  return bar + T{};\n"
1288                     "}";
1289   BaseTokenCount = 26;
1290   TestRequires(__LINE__);
1291 
1292   BaseCode = "template<typename T>\n"
1293              "T foo();";
1294   ConstrainedCode = "template<typename T>\n"
1295                     "T foo() requires Foo<T>;";
1296   BaseTokenCount = 11;
1297   PrefixTokenCount = 9;
1298   TestRequires(__LINE__);
1299 
1300   BaseCode = "template<typename T>\n"
1301              "T foo() {\n"
1302              "  auto bar = baz();\n"
1303              "  return bar + T{};\n"
1304              "}";
1305   ConstrainedCode = "template<typename T>\n"
1306                     "T foo() requires Foo<T> {\n"
1307                     "  auto bar = baz();\n"
1308                     "  return bar + T{};\n"
1309                     "}";
1310   BaseTokenCount = 26;
1311   TestRequires(__LINE__);
1312 
1313   BaseCode = "template<typename T>\n"
1314              "T foo();";
1315   ConstrainedCode = "template<typename T>\n"
1316                     "  requires(Foo<T>)\n"
1317                     "T foo();";
1318   BaseTokenCount = 11;
1319   RequiresTokenCount = 7;
1320   PrefixTokenCount = 5;
1321   TestRequires(__LINE__);
1322 
1323   BaseCode = "template<typename T>\n"
1324              "Bar(T) -> Bar<typename T::I>;";
1325   ConstrainedCode = "template<typename T>\n"
1326                     "  requires requires(T &&t) {\n"
1327                     "             typename T::I;\n"
1328                     "           }\n"
1329                     "Bar(T) -> Bar<typename T::I>;";
1330   BaseTokenCount = 19;
1331   RequiresTokenCount = 14;
1332   PrefixTokenCount = 5;
1333   TestRequires(__LINE__);
1334 
1335   BaseCode = "struct [[nodiscard]] zero_t {\n"
1336              "  template<class T>\n"
1337              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1338              "};";
1339   ConstrainedCode =
1340       "struct [[nodiscard]] zero_t {\n"
1341       "  template<class T>\n"
1342       "    requires requires { v<T>; }\n"
1343       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1344       "};";
1345   BaseTokenCount = 35;
1346   RequiresTokenCount = 9;
1347   PrefixTokenCount = 13;
1348   TestRequires(__LINE__);
1349 
1350   BaseCode = "constexpr Foo(Foo const &other)\n"
1351              "    : value{other.value} {\n"
1352              "  do_magic();\n"
1353              "  do_more_magic();\n"
1354              "}";
1355   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1356                     "  requires std::is_copy_constructible<T>\n"
1357                     "    : value{other.value} {\n"
1358                     "  do_magic();\n"
1359                     "  do_more_magic();\n"
1360                     "}";
1361   BaseTokenCount = 26;
1362   RequiresTokenCount = 7;
1363   PrefixTokenCount = 8;
1364   TestRequires(__LINE__);
1365 
1366   BaseCode = "constexpr Foo(Foo const &other)\n"
1367              "    : value{other.value} {\n"
1368              "  do_magic();\n"
1369              "  do_more_magic();\n"
1370              "}";
1371   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1372                     "  requires (std::is_copy_constructible<T>)\n"
1373                     "    : value{other.value} {\n"
1374                     "  do_magic();\n"
1375                     "  do_more_magic();\n"
1376                     "}";
1377   RequiresTokenCount = 9;
1378   TestRequires(__LINE__);
1379 }
1380 
1381 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1382   auto Tokens = annotate("__asm{\n"
1383                          "a:\n"
1384                          "};");
1385   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1386   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1387   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1388   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
1389 }
1390 
1391 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1392   auto Tokens = annotate("int (^)() = ^ ()\n"
1393                          "  external_source_symbol() { //\n"
1394                          "  return 1;\n"
1395                          "};");
1396   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1397   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1398   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1399 
1400   Tokens = annotate("int *p = ^int*(){ //\n"
1401                     "  return nullptr;\n"
1402                     "}();");
1403   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1404   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1405 }
1406 
1407 TEST_F(TokenAnnotatorTest, UnderstandsObjCMethodExpr) {
1408   auto Tokens = annotate("void f() {\n"
1409                          "  //\n"
1410                          "  BOOL a = [b.c n] > 1;\n"
1411                          "}");
1412   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
1413   EXPECT_TOKEN(Tokens[9], tok::l_square, TT_ObjCMethodExpr);
1414   EXPECT_TOKEN(Tokens[15], tok::greater, TT_BinaryOperator);
1415 }
1416 
1417 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1418   auto Tokens = annotate("[]() constexpr {}");
1419   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1420   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1421   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1422 
1423   Tokens = annotate("[]() consteval {}");
1424   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1425   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1426   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1427 
1428   Tokens = annotate("[]() mutable {}");
1429   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1430   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1431   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1432 
1433   Tokens = annotate("[]() static {}");
1434   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1435   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1436   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1437 
1438   Tokens = annotate("[]() -> auto {}");
1439   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1440   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1441   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1442   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1443 
1444   Tokens = annotate("[]() -> auto & {}");
1445   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1446   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1447   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1448   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1449 
1450   Tokens = annotate("[]() -> auto * {}");
1451   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1452   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1453   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1454   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1455 
1456   Tokens = annotate("[] {}");
1457   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1458   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1459   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1460 
1461   Tokens = annotate("[] noexcept {}");
1462   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1463   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1464   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1465 
1466   Tokens = annotate("[] -> auto {}");
1467   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1468   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1469   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_LambdaArrow);
1470   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1471 
1472   Tokens = annotate("[] <typename T> () {}");
1473   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1474   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1475   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1476   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1477 
1478   Tokens = annotate("[] <typename T> {}");
1479   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1480   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1481   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1482   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1483 
1484   Tokens = annotate("[] <typename... T> () {}");
1485   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1486   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1487   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1488   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1489 
1490   Tokens = annotate("[] <typename... T> {}");
1491   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1492   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1493   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1494   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1495 
1496   Tokens = annotate("[] <int... T> () {}");
1497   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1498   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1499   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1500   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1501 
1502   Tokens = annotate("[] <int... T> {}");
1503   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1504   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1505   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1506   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1507 
1508   Tokens = annotate("[] <Foo... T> () {}");
1509   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1510   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1511   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1512   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1513 
1514   Tokens = annotate("[] <Foo... T> {}");
1515   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1516   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1517   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1518   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1519 
1520   // Lambdas with a requires-clause
1521   Tokens = annotate("[] <typename T> (T t) requires Bar<T> {}");
1522   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1523   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1524   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1525   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1526   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1527   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1528 
1529   Tokens = annotate("[] <typename T> (T &&t) requires Bar<T> {}");
1530   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1531   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1532   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1533   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_PointerOrReference);
1534   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1535   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1536   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1537 
1538   Tokens = annotate("[] <typename T> (T t) requires Foo<T> || Bar<T> {}");
1539   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1540   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1541   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1542   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1543   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1544   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1545 
1546   Tokens = annotate("[] <typename T> (T t) -> T requires Bar<T> {}");
1547   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1548   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1549   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1550   EXPECT_TOKEN(Tokens[10], tok::arrow, TT_LambdaArrow);
1551   EXPECT_TOKEN(Tokens[12], tok::kw_requires, TT_RequiresClause);
1552   EXPECT_TRUE(Tokens[16]->ClosesRequiresClause);
1553   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1554 
1555   Tokens = annotate("[] <typename T> requires Bar<T> (T t) {}");
1556   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1557   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1558   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1559   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1560   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1561   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1562 
1563   Tokens = annotate("[] <typename T> requires Bar<T> (T &&t) {}");
1564   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1565   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1566   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1567   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1568   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1569   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_PointerOrReference);
1570   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1571 
1572   Tokens = annotate("[] <typename T> requires Foo<T> || Bar<T> (T t) {}");
1573   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1574   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1575   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1576   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1577   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1578   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1579 
1580   Tokens = annotate("[] <typename T> requires true (T&& t) {}");
1581   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1582   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1583   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1584   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1585   EXPECT_TRUE(Tokens[7]->ClosesRequiresClause);
1586   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1587   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1588 
1589   Tokens = annotate("[] <typename T> requires Bar<T> {}");
1590   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1591   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1592   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1593   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1594   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1595   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_LambdaLBrace);
1596 
1597   Tokens = annotate("[] <typename T> requires Bar<T> noexcept {}");
1598   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1599   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1600   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1601   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1602   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1603   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1604 
1605   Tokens = annotate("[] <typename T> requires Bar<T> -> T {}");
1606   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1607   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1608   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1609   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1610   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1611   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_LambdaArrow);
1612   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1613 
1614   Tokens = annotate("[] <typename T> requires Foo<T> (T t) requires Bar<T> {}");
1615   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1616   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1617   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1618   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1619   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1620   EXPECT_TOKEN(Tokens[15], tok::kw_requires, TT_RequiresClause);
1621   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1622   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1623 }
1624 
1625 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1626   auto Tokens = annotate("template <typename T>\n"
1627                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1628                          "string OldFunction(const string &parameter) {}");
1629   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1630   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1631 
1632   Tokens = annotate("template <typename T>\n"
1633                     "A(T) noexcept;");
1634   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1635   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1636 }
1637 
1638 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1639   auto Tokens = annotate("void f [[noreturn]] ();");
1640   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1641   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1642 
1643   Tokens = annotate("void f [[noreturn]] () {}");
1644   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1645   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1646 
1647   Tokens = annotate("#define FOO Foo::\n"
1648                     "FOO Foo();");
1649   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1650   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_FunctionDeclarationName);
1651 
1652   Tokens = annotate("struct Foo {\n"
1653                     "  Bar (*func)();\n"
1654                     "};");
1655   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1656   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
1657   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_FunctionTypeLParen);
1658 }
1659 
1660 TEST_F(TokenAnnotatorTest, UnderstandsCtorAndDtorDeclNames) {
1661   auto Tokens = annotate("class Foo { public: Foo(); };");
1662   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1663   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_CtorDtorDeclName);
1664 
1665   Tokens = annotate("class Foo { public: ~Foo(); };");
1666   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1667   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_CtorDtorDeclName);
1668 
1669   Tokens = annotate("struct Foo { [[deprecated]] Foo() {} };");
1670   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1671   EXPECT_TOKEN(Tokens[8], tok::identifier, TT_CtorDtorDeclName);
1672   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1673 
1674   Tokens = annotate("struct Foo { [[deprecated]] ~Foo() {} };");
1675   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1676   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1677   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1678 
1679   Tokens = annotate("struct Foo { Foo() [[deprecated]] {} };");
1680   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1681   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1682   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1683 
1684   Tokens = annotate("struct Foo { ~Foo() [[deprecated]] {} };");
1685   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1686   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_CtorDtorDeclName);
1687   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1688 
1689   Tokens = annotate("struct Foo { [[deprecated]] explicit Foo() {} };");
1690   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1691   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1692   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1693 
1694   Tokens = annotate("struct Foo { virtual [[deprecated]] ~Foo() {} };");
1695   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1696   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_CtorDtorDeclName);
1697   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1698 
1699   Tokens = annotate("Foo::Foo() {}");
1700   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1701   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_CtorDtorDeclName);
1702   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
1703 
1704   Tokens = annotate("Foo::~Foo() {}");
1705   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1706   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1707   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
1708 
1709   Tokens = annotate("struct Test {\n"
1710                     "  Test()\n"
1711                     "      : l([] {\n"
1712                     "          Short::foo();\n"
1713                     "        }) {}\n"
1714                     "};");
1715   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1716   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1717   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_Unknown);
1718 }
1719 
1720 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1721   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1722   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1723   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1724   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1725   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1726 }
1727 
1728 TEST_F(TokenAnnotatorTest, UnderstandsTrailingReturnArrow) {
1729   auto Tokens = annotate("auto f() -> int;");
1730   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1731   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1732 
1733   Tokens = annotate("auto operator->() -> int;");
1734   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1735   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_OverloadedOperator);
1736   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1737 
1738   Tokens = annotate("auto operator++(int) -> int;");
1739   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1740   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1741 
1742   Tokens = annotate("auto operator=() -> int;");
1743   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1744   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1745 
1746   Tokens = annotate("auto operator=(int) -> int;");
1747   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1748   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1749 
1750   Tokens = annotate("auto foo() -> auto { return Val; }");
1751   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1752   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1753 
1754   Tokens = annotate("struct S { auto bar() const -> int; };");
1755   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1756   EXPECT_TOKEN(Tokens[8], tok::arrow, TT_TrailingReturnArrow);
1757 
1758   // Not trailing return arrows
1759   Tokens = annotate("auto a = b->c;");
1760   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1761   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1762 
1763   Tokens = annotate("auto a = (b)->c;");
1764   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1765   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1766 
1767   Tokens = annotate("auto a = b()->c;");
1768   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1769   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1770 
1771   Tokens = annotate("auto a = b->c();");
1772   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1773   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1774 
1775   Tokens = annotate("decltype(auto) a = b()->c;");
1776   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1777   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1778 
1779   Tokens = annotate("void f() { auto a = b->c(); }");
1780   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1781   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1782 
1783   Tokens = annotate("void f() { auto a = b()->c; }");
1784   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1785   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_Unknown);
1786 
1787   Tokens = annotate("#define P(ptr) auto p = (ptr)->p");
1788   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1789   EXPECT_TOKEN(Tokens[12], tok::arrow, TT_Unknown);
1790 
1791   // Mixed
1792   Tokens = annotate("auto f() -> int { auto a = b()->c; }");
1793   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1794   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1795   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
1796 }
1797 
1798 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacros) {
1799   // '__attribute__' has special handling.
1800   auto Tokens = annotate("__attribute__(X) void Foo(void);");
1801   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1802   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
1803   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1804   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1805 
1806   // Generic macro has no special handling in this location.
1807   Tokens = annotate("A(X) void Foo(void);");
1808   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1809   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
1810   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_Unknown);
1811 
1812   // Add a custom AttributeMacro. Test that it has the same behavior.
1813   FormatStyle Style = getLLVMStyle();
1814   Style.AttributeMacros.push_back("A");
1815 
1816   // An "AttributeMacro" gets annotated like '__attribute__'.
1817   Tokens = annotate("A(X) void Foo(void);", Style);
1818   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1819   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
1820   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1821   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1822 }
1823 
1824 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCDecl) {
1825   // '__attribute__' has special handling.
1826   auto Tokens = annotate("__attribute__(X) @interface Foo");
1827   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1828   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
1829   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1830   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1831 
1832   // Generic macro has no special handling in this location.
1833   Tokens = annotate("A(X) @interface Foo");
1834   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1835   // Note: Don't check token-type as a random token in this position is hard to
1836   // reason about.
1837   EXPECT_TOKEN_KIND(Tokens[0], tok::identifier);
1838   EXPECT_TOKEN_KIND(Tokens[1], tok::l_paren);
1839 
1840   // Add a custom AttributeMacro. Test that it has the same behavior.
1841   FormatStyle Style = getLLVMStyle();
1842   Style.AttributeMacros.push_back("A");
1843 
1844   // An "AttributeMacro" gets annotated like '__attribute__'.
1845   Tokens = annotate("A(X) @interface Foo", Style);
1846   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1847   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
1848   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1849   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1850 }
1851 
1852 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCMethodDecl) {
1853   // '__attribute__' has special handling.
1854   auto Tokens = annotate("- (id)init __attribute__(X);");
1855   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1856   EXPECT_TOKEN(Tokens[5], tok::kw___attribute, TT_Unknown);
1857   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
1858   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
1859 
1860   // Generic macro has no special handling in this location.
1861   Tokens = annotate("- (id)init A(X);");
1862   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1863   // Note: Don't check token-type as a random token in this position is hard to
1864   // reason about.
1865   EXPECT_TOKEN_KIND(Tokens[5], tok::identifier);
1866   EXPECT_TOKEN_KIND(Tokens[6], tok::l_paren);
1867 
1868   // Add a custom AttributeMacro. Test that it has the same behavior.
1869   FormatStyle Style = getLLVMStyle();
1870   Style.AttributeMacros.push_back("A");
1871 
1872   // An "AttributeMacro" gets annotated like '__attribute__'.
1873   Tokens = annotate("- (id)init A(X);", Style);
1874   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1875   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_AttributeMacro);
1876   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
1877   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
1878 }
1879 
1880 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCProperty) {
1881   // '__attribute__' has special handling.
1882   auto Tokens = annotate("@property(weak) id delegate __attribute__(X);");
1883   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1884   EXPECT_TOKEN(Tokens[7], tok::kw___attribute, TT_Unknown);
1885   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
1886   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
1887 
1888   // Generic macro has no special handling in this location.
1889   Tokens = annotate("@property(weak) id delegate A(X);");
1890   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1891   // Note: Don't check token-type as a random token in this position is hard to
1892   // reason about.
1893   EXPECT_TOKEN_KIND(Tokens[7], tok::identifier);
1894   EXPECT_TOKEN_KIND(Tokens[8], tok::l_paren);
1895 
1896   // Add a custom AttributeMacro. Test that it has the same behavior.
1897   FormatStyle Style = getLLVMStyle();
1898   Style.AttributeMacros.push_back("A");
1899 
1900   // An "AttributeMacro" gets annotated like '__attribute__'.
1901   Tokens = annotate("@property(weak) id delegate A(X);", Style);
1902   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1903   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_AttributeMacro);
1904   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
1905   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
1906 }
1907 
1908 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
1909   auto Annotate = [this](llvm::StringRef Code) {
1910     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
1911   };
1912   // Test that unary operators get labeled as such and that operators like '++'
1913   // don't get split.
1914   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
1915                             tok::tilde, tok::amp,      tok::pipe,
1916                             tok::caret, tok::plusplus, tok::minusminus};
1917   for (auto Kind : Unary) {
1918     auto Tokens =
1919         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
1920     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1921     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
1922   }
1923   // Operators formed by joining two operators like '^~'. For some of these
1924   // joined operators, we don't have a separate type, so we only test for their
1925   // precedence.
1926   std::pair<prec::Level, std::string> JoinedBinary[] = {
1927       {prec::Comma, "<->"},       {prec::Assignment, "+="},
1928       {prec::Assignment, "-="},   {prec::Assignment, "*="},
1929       {prec::Assignment, "/="},   {prec::Assignment, "%="},
1930       {prec::Assignment, "&="},   {prec::Assignment, "^="},
1931       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
1932       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
1933       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
1934       {prec::Equality, "=="},     {prec::Equality, "!="},
1935       {prec::Equality, "==="},    {prec::Equality, "!=="},
1936       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
1937       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
1938   };
1939   for (auto Operator : JoinedBinary) {
1940     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
1941     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1942     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
1943     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
1944   }
1945   // '~^' and '^~' can be unary as well as binary operators.
1946   auto Tokens = Annotate("x = ~^x;");
1947   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1948   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1949   Tokens = Annotate("x = ^~x;");
1950   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1951   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1952   // The unary operators '~&' and '~|' can only be unary operators. The current
1953   // implementation treats each of them as separate unary '~' and '&' or '|'
1954   // operators, which is enough for formatting purposes. In FormatTestVerilog,
1955   // there is a test that there is no space in between. And even if a new line
1956   // is inserted between the '~' and '|', the semantic meaning is the same as
1957   // the joined operator, so the CanBreakBefore property doesn't need to be
1958   // false for the second operator.
1959   Tokens = Annotate("x = ~&x;");
1960   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1961   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1962   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
1963   Tokens = Annotate("x = ~|x;");
1964   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1965   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1966   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
1967   // Test for block label colons.
1968   Tokens = Annotate("begin : x\n"
1969                     "end : x");
1970   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1971   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
1972   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
1973   // Test that the dimension colon is annotated correctly.
1974   Tokens = Annotate("var [1 : 0] x;");
1975   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1976   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
1977   Tokens = Annotate("extern function [1 : 0] x;");
1978   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1979   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
1980   Tokens = Annotate("module test\n"
1981                     "    (input wire [7 : 0] a[7 : 0]);\n"
1982                     "endmodule");
1983   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1984   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_VerilogDimensionedTypeName);
1985   EXPECT_TOKEN(Tokens[7], tok::colon, TT_BitFieldColon);
1986   EXPECT_TOKEN(Tokens[13], tok::colon, TT_BitFieldColon);
1987   // Test case labels and ternary operators.
1988   Tokens = Annotate("case (x)\n"
1989                     "  x:\n"
1990                     "    x;\n"
1991                     "endcase\n");
1992   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1993   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CaseLabelColon);
1994   Tokens = Annotate("case (x)\n"
1995                     "  x ? x : x:\n"
1996                     "    x;\n"
1997                     "endcase\n");
1998   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1999   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
2000   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
2001   EXPECT_TOKEN(Tokens[9], tok::colon, TT_CaseLabelColon);
2002   // Non-blocking assignments.
2003   Tokens = Annotate("a <= b;");
2004   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2005   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2006   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2007   Tokens = Annotate("if (a <= b) break;");
2008   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2009   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2010   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2011   Tokens = Annotate("a <= b <= a;");
2012   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2013   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2014   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2015   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2016   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2017 
2018   // Port lists in module instantiation.
2019   Tokens = Annotate("module_x instance_1(port_1), instance_2(port_2);");
2020   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2021   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2022   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_VerilogInstancePortLParen);
2023   Tokens = Annotate("module_x #(parameter) instance_1(port_1), "
2024                     "instance_2(port_2);");
2025   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2026   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2027   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_VerilogInstancePortLParen);
2028   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_VerilogInstancePortLParen);
2029 
2030   // Condition parentheses.
2031   Tokens = Annotate("assert (x);");
2032   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2033   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2034   Tokens = Annotate("assert #0 (x);");
2035   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2036   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_ConditionLParen);
2037   Tokens = Annotate("assert final (x);");
2038   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2039   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2040   Tokens = Annotate("foreach (x[x]) continue;");
2041   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2042   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2043   Tokens = Annotate("repeat (x[x]) continue;");
2044   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2045   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2046   Tokens = Annotate("case (x) endcase;");
2047   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2048   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2049 
2050   // Sensitivity list. The TT_Unknown type is clearly not binding for the
2051   // future, please adapt if those tokens get annotated.  This test is only here
2052   // to prevent the comma from being annotated as TT_VerilogInstancePortComma.
2053   Tokens = Annotate("always @(posedge x, posedge y);");
2054   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2055   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_Unknown);
2056   EXPECT_TOKEN(Tokens[5], tok::comma, TT_Unknown);
2057   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2058 
2059   // String literals in concatenation.
2060   Tokens = Annotate("x = {\"\"};");
2061   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2062   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2063   Tokens = Annotate("x = {\"\", \"\"};");
2064   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2065   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2066   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2067   Tokens = Annotate("x = '{{\"\"}};");
2068   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2069   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2070   // Cases where the string should not be annotated that type.  Fix the
2071   // `TT_Unknown` if needed in the future.
2072   Tokens = Annotate("x = {\"\" == \"\"};");
2073   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2074   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_Unknown);
2075   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_Unknown);
2076   Tokens = Annotate("x = {(\"\")};");
2077   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2078   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2079   Tokens = Annotate("x = '{\"\"};");
2080   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2081   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2082 }
2083 
2084 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
2085   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
2086 
2087   // The TT_Unknown is clearly not binding for the future, please adapt if those
2088   // tokens get annotated.
2089   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2090   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2091   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2092   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
2093   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2094   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2095   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2096   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
2097   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
2098   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2099 
2100   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
2101   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2102   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2103   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2104   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
2105   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
2106   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2107   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2108   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
2109   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
2110   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2111 }
2112 
2113 TEST_F(TokenAnnotatorTest, UnderstandsConditionParens) {
2114   auto Tokens = annotate("if (x) {}");
2115   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2116   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2117   Tokens = annotate("if constexpr (x) {}");
2118   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2119   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2120   Tokens = annotate("if CONSTEXPR (x) {}");
2121   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2122   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2123   Tokens = annotate("if (x) {} else if (x) {}");
2124   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2125   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2126   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_ConditionLParen);
2127 }
2128 
2129 TEST_F(TokenAnnotatorTest, CSharpNullableTypes) {
2130   FormatStyle Style = getGoogleStyle(FormatStyle::LK_CSharp);
2131 
2132   auto Tokens = annotate("int? a;", Style);
2133   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
2134   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2135 
2136   Tokens = annotate("int? a = 1;", Style);
2137   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
2138   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2139 
2140   Tokens = annotate("int?)", Style);
2141   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
2142   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2143 
2144   Tokens = annotate("int?>", Style);
2145   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
2146   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2147 
2148   Tokens = annotate("cond? id : id2", Style);
2149   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
2150   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2151 
2152   Tokens = annotate("cond ? cond2 ? : id1 : id2", Style);
2153   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
2154   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2155 }
2156 
2157 TEST_F(TokenAnnotatorTest, UnderstandsLabels) {
2158   auto Tokens = annotate("{ x: break; }");
2159   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2160   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2161   Tokens = annotate("{ case x: break; }");
2162   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2163   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2164   Tokens = annotate("{ x: { break; } }");
2165   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2166   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2167   Tokens = annotate("{ case x: { break; } }");
2168   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2169   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2170 }
2171 
2172 TEST_F(TokenAnnotatorTest, UnderstandsNestedBlocks) {
2173   // The closing braces are not annotated. It doesn't seem to cause a problem.
2174   // So we only test for the opening braces.
2175   auto Tokens = annotate("{\n"
2176                          "  {\n"
2177                          "    { int a = 0; }\n"
2178                          "  }\n"
2179                          "  {}\n"
2180                          "}");
2181   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2182   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2183   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
2184   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
2185   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2186 }
2187 
2188 TEST_F(TokenAnnotatorTest, UnderstandDesignatedInitializers) {
2189   auto Tokens = annotate("SomeStruct { .a = 1 };");
2190   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2191   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2192   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2193 
2194   Tokens = annotate("SomeStruct { .a = 1, .b = 2 };");
2195   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2196   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2197   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2198   EXPECT_TOKEN(Tokens[7], tok::period, TT_DesignatedInitializerPeriod);
2199 
2200   Tokens = annotate("SomeStruct {\n"
2201                     "#ifdef FOO\n"
2202                     "  .a = 1,\n"
2203                     "#endif\n"
2204                     "  .b = 2\n"
2205                     "};");
2206   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2207   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2208   EXPECT_TOKEN(Tokens[5], tok::period, TT_DesignatedInitializerPeriod);
2209   EXPECT_TOKEN(Tokens[12], tok::period, TT_DesignatedInitializerPeriod);
2210 
2211   Tokens = annotate("SomeStruct {\n"
2212                     "#if defined FOO\n"
2213                     "  .a = 1,\n"
2214                     "#endif\n"
2215                     "  .b = 2\n"
2216                     "};");
2217   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2218   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2219   EXPECT_TOKEN(Tokens[6], tok::period, TT_DesignatedInitializerPeriod);
2220   EXPECT_TOKEN(Tokens[13], tok::period, TT_DesignatedInitializerPeriod);
2221 }
2222 
2223 TEST_F(TokenAnnotatorTest, UnderstandsJavaScript) {
2224   auto Annotate = [this](llvm::StringRef Code) {
2225     return annotate(Code, getLLVMStyle(FormatStyle::LK_JavaScript));
2226   };
2227 
2228   // Dictionary.
2229   auto Tokens = Annotate("var x = {'x' : 1, 'y' : 2};");
2230   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2231   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_DictLiteral);
2232   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_SelectorName);
2233   EXPECT_TOKEN(Tokens[5], tok::colon, TT_DictLiteral);
2234   EXPECT_TOKEN(Tokens[8], tok::string_literal, TT_SelectorName);
2235   EXPECT_TOKEN(Tokens[9], tok::colon, TT_DictLiteral);
2236   // Change when we need to annotate these.
2237   EXPECT_BRACE_KIND(Tokens[3], BK_Unknown);
2238   EXPECT_BRACE_KIND(Tokens[11], BK_Unknown);
2239   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_Unknown);
2240 }
2241 
2242 TEST_F(TokenAnnotatorTest, UnderstandsAttributes) {
2243   auto Tokens = annotate("bool foo __attribute__((unused));");
2244   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2245   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2246   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_Unknown);
2247   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_Unknown);
2248   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_AttributeRParen);
2249 
2250   Tokens = annotate("bool foo __declspec(dllimport);");
2251   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2252   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2253   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2254 
2255   FormatStyle Style = getLLVMStyle();
2256   Style.AttributeMacros.push_back("FOO");
2257   Tokens = annotate("bool foo FOO(unused);", Style);
2258   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2259   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
2260   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2261   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2262 }
2263 
2264 TEST_F(TokenAnnotatorTest, UnderstandsControlStatements) {
2265   auto Tokens = annotate("while (true) {}");
2266   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2267   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2268   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2269 
2270   Tokens = annotate("for (;;) {}");
2271   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2272   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_ControlStatementLBrace);
2273   EXPECT_TOKEN(Tokens[6], tok::r_brace, TT_ControlStatementRBrace);
2274 
2275   Tokens = annotate("do {} while (true);");
2276   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2277   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_ControlStatementLBrace);
2278   EXPECT_TOKEN(Tokens[2], tok::r_brace, TT_ControlStatementRBrace);
2279 
2280   Tokens = annotate("if (true) {} else if (false) {} else {}");
2281   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
2282   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2283   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2284   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_ControlStatementLBrace);
2285   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_ControlStatementRBrace);
2286   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_ElseLBrace);
2287   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_ElseRBrace);
2288 
2289   Tokens = annotate("switch (foo) {}");
2290   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2291   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2292   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2293 }
2294 
2295 } // namespace
2296 } // namespace format
2297 } // namespace clang
2298