xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision 88934a82dced0116227e4ad9af8896d8fa0943b8)
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;");
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 )", 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)", 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   Tokens = annotate("[] <typename T = int> (T t) {}");
1625   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1626   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1627   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1628   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1629   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1630 
1631   Tokens = annotate("[] <int I = 0> (T t) {}");
1632   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1633   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1634   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1635   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1636   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1637 
1638   Tokens = annotate("[] <bool b = false> (T t) {}");
1639   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1640   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1641   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1642   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1643   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1644 
1645   Tokens = annotate("[] <bool b = true && false> (T&& t) {}");
1646   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1647   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1648   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1649   EXPECT_TOKEN(Tokens[7], tok::ampamp, TT_BinaryOperator);
1650   EXPECT_TOKEN(Tokens[9], tok::greater, TT_TemplateCloser);
1651   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_PointerOrReference);
1652   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1653 
1654   Tokens = annotate("[] <typename T = int> requires Foo<T> (T t) {}");
1655   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1656   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1657   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1658   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1659   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1660   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1661 }
1662 
1663 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1664   auto Tokens = annotate("template <typename T>\n"
1665                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1666                          "string OldFunction(const string &parameter) {}");
1667   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1668   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1669 
1670   Tokens = annotate("template <typename T>\n"
1671                     "A(T) noexcept;");
1672   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1673   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1674 }
1675 
1676 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1677   auto Tokens = annotate("void f [[noreturn]] ();");
1678   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1679   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1680 
1681   Tokens = annotate("void f [[noreturn]] () {}");
1682   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1683   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1684 
1685   Tokens = annotate("#define FOO Foo::\n"
1686                     "FOO Foo();");
1687   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1688   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_FunctionDeclarationName);
1689 
1690   Tokens = annotate("struct Foo {\n"
1691                     "  Bar (*func)();\n"
1692                     "};");
1693   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1694   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
1695   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_FunctionTypeLParen);
1696 }
1697 
1698 TEST_F(TokenAnnotatorTest, UnderstandsCtorAndDtorDeclNames) {
1699   auto Tokens = annotate("class Foo { public: Foo(); };");
1700   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1701   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_CtorDtorDeclName);
1702 
1703   Tokens = annotate("class Foo { public: ~Foo(); };");
1704   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1705   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_CtorDtorDeclName);
1706 
1707   Tokens = annotate("struct Foo { [[deprecated]] Foo() {} };");
1708   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1709   EXPECT_TOKEN(Tokens[8], tok::identifier, TT_CtorDtorDeclName);
1710   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1711 
1712   Tokens = annotate("struct Foo { [[deprecated]] ~Foo() {} };");
1713   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1714   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1715   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1716 
1717   Tokens = annotate("struct Foo { Foo() [[deprecated]] {} };");
1718   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1719   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1720   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1721 
1722   Tokens = annotate("struct Foo { ~Foo() [[deprecated]] {} };");
1723   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1724   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_CtorDtorDeclName);
1725   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1726 
1727   Tokens = annotate("struct Foo { [[deprecated]] explicit Foo() {} };");
1728   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1729   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1730   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1731 
1732   Tokens = annotate("struct Foo { virtual [[deprecated]] ~Foo() {} };");
1733   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1734   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_CtorDtorDeclName);
1735   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1736 
1737   Tokens = annotate("Foo::Foo() {}");
1738   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1739   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_CtorDtorDeclName);
1740   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
1741 
1742   Tokens = annotate("Foo::~Foo() {}");
1743   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1744   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1745   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
1746 
1747   Tokens = annotate("struct Test {\n"
1748                     "  Test()\n"
1749                     "      : l([] {\n"
1750                     "          Short::foo();\n"
1751                     "        }) {}\n"
1752                     "};");
1753   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1754   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1755   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_Unknown);
1756 }
1757 
1758 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1759   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1760   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1761   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1762   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1763   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1764 }
1765 
1766 TEST_F(TokenAnnotatorTest, UnderstandsTrailingReturnArrow) {
1767   auto Tokens = annotate("auto f() -> int;");
1768   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1769   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1770 
1771   Tokens = annotate("auto operator->() -> int;");
1772   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1773   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_OverloadedOperator);
1774   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1775 
1776   Tokens = annotate("auto operator++(int) -> int;");
1777   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1778   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1779 
1780   Tokens = annotate("auto operator=() -> int;");
1781   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1782   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1783 
1784   Tokens = annotate("auto operator=(int) -> int;");
1785   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1786   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1787 
1788   Tokens = annotate("auto foo() -> auto { return Val; }");
1789   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1790   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1791 
1792   Tokens = annotate("struct S { auto bar() const -> int; };");
1793   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1794   EXPECT_TOKEN(Tokens[8], tok::arrow, TT_TrailingReturnArrow);
1795 
1796   // Not trailing return arrows
1797   Tokens = annotate("auto a = b->c;");
1798   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1799   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1800 
1801   Tokens = annotate("auto a = (b)->c;");
1802   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1803   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1804 
1805   Tokens = annotate("auto a = b()->c;");
1806   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1807   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1808 
1809   Tokens = annotate("auto a = b->c();");
1810   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1811   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1812 
1813   Tokens = annotate("decltype(auto) a = b()->c;");
1814   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1815   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1816 
1817   Tokens = annotate("void f() { auto a = b->c(); }");
1818   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1819   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1820 
1821   Tokens = annotate("void f() { auto a = b()->c; }");
1822   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1823   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_Unknown);
1824 
1825   Tokens = annotate("#define P(ptr) auto p = (ptr)->p");
1826   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1827   EXPECT_TOKEN(Tokens[12], tok::arrow, TT_Unknown);
1828 
1829   Tokens = annotate("void f() FOO(foo->bar);");
1830   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1831   EXPECT_TOKEN(Tokens[7], tok::arrow, TT_Unknown);
1832 
1833   // Mixed
1834   Tokens = annotate("auto f() -> int { auto a = b()->c; }");
1835   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1836   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1837   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
1838 }
1839 
1840 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacros) {
1841   // '__attribute__' has special handling.
1842   auto Tokens = annotate("__attribute__(X) void Foo(void);");
1843   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1844   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
1845   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1846   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1847 
1848   // Generic macro has no special handling in this location.
1849   Tokens = annotate("A(X) void Foo(void);");
1850   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1851   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
1852   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_Unknown);
1853 
1854   // Add a custom AttributeMacro. Test that it has the same behavior.
1855   FormatStyle Style = getLLVMStyle();
1856   Style.AttributeMacros.push_back("A");
1857 
1858   // An "AttributeMacro" gets annotated like '__attribute__'.
1859   Tokens = annotate("A(X) void Foo(void);", Style);
1860   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1861   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
1862   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1863   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1864 }
1865 
1866 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCDecl) {
1867   // '__attribute__' has special handling.
1868   auto Tokens = annotate("__attribute__(X) @interface Foo");
1869   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1870   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
1871   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1872   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1873 
1874   // Generic macro has no special handling in this location.
1875   Tokens = annotate("A(X) @interface Foo");
1876   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1877   // Note: Don't check token-type as a random token in this position is hard to
1878   // reason about.
1879   EXPECT_TOKEN_KIND(Tokens[0], tok::identifier);
1880   EXPECT_TOKEN_KIND(Tokens[1], tok::l_paren);
1881 
1882   // Add a custom AttributeMacro. Test that it has the same behavior.
1883   FormatStyle Style = getLLVMStyle();
1884   Style.AttributeMacros.push_back("A");
1885 
1886   // An "AttributeMacro" gets annotated like '__attribute__'.
1887   Tokens = annotate("A(X) @interface Foo", Style);
1888   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1889   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
1890   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1891   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1892 }
1893 
1894 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCMethodDecl) {
1895   // '__attribute__' has special handling.
1896   auto Tokens = annotate("- (id)init __attribute__(X);");
1897   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1898   EXPECT_TOKEN(Tokens[5], tok::kw___attribute, TT_Unknown);
1899   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
1900   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
1901 
1902   // Generic macro has no special handling in this location.
1903   Tokens = annotate("- (id)init A(X);");
1904   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1905   // Note: Don't check token-type as a random token in this position is hard to
1906   // reason about.
1907   EXPECT_TOKEN_KIND(Tokens[5], tok::identifier);
1908   EXPECT_TOKEN_KIND(Tokens[6], tok::l_paren);
1909 
1910   // Add a custom AttributeMacro. Test that it has the same behavior.
1911   FormatStyle Style = getLLVMStyle();
1912   Style.AttributeMacros.push_back("A");
1913 
1914   // An "AttributeMacro" gets annotated like '__attribute__'.
1915   Tokens = annotate("- (id)init A(X);", Style);
1916   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1917   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_AttributeMacro);
1918   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
1919   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
1920 }
1921 
1922 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCProperty) {
1923   // '__attribute__' has special handling.
1924   auto Tokens = annotate("@property(weak) id delegate __attribute__(X);");
1925   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1926   EXPECT_TOKEN(Tokens[7], tok::kw___attribute, TT_Unknown);
1927   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
1928   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
1929 
1930   // Generic macro has no special handling in this location.
1931   Tokens = annotate("@property(weak) id delegate A(X);");
1932   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1933   // Note: Don't check token-type as a random token in this position is hard to
1934   // reason about.
1935   EXPECT_TOKEN_KIND(Tokens[7], tok::identifier);
1936   EXPECT_TOKEN_KIND(Tokens[8], tok::l_paren);
1937 
1938   // Add a custom AttributeMacro. Test that it has the same behavior.
1939   FormatStyle Style = getLLVMStyle();
1940   Style.AttributeMacros.push_back("A");
1941 
1942   // An "AttributeMacro" gets annotated like '__attribute__'.
1943   Tokens = annotate("@property(weak) id delegate A(X);", Style);
1944   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1945   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_AttributeMacro);
1946   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
1947   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
1948 }
1949 
1950 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
1951   auto Annotate = [this](llvm::StringRef Code) {
1952     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
1953   };
1954   // Test that unary operators get labeled as such and that operators like '++'
1955   // don't get split.
1956   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
1957                             tok::tilde, tok::amp,      tok::pipe,
1958                             tok::caret, tok::plusplus, tok::minusminus};
1959   for (auto Kind : Unary) {
1960     auto Tokens =
1961         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
1962     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1963     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
1964   }
1965   // Operators formed by joining two operators like '^~'. For some of these
1966   // joined operators, we don't have a separate type, so we only test for their
1967   // precedence.
1968   std::pair<prec::Level, std::string> JoinedBinary[] = {
1969       {prec::Comma, "<->"},       {prec::Assignment, "+="},
1970       {prec::Assignment, "-="},   {prec::Assignment, "*="},
1971       {prec::Assignment, "/="},   {prec::Assignment, "%="},
1972       {prec::Assignment, "&="},   {prec::Assignment, "^="},
1973       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
1974       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
1975       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
1976       {prec::Equality, "=="},     {prec::Equality, "!="},
1977       {prec::Equality, "==="},    {prec::Equality, "!=="},
1978       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
1979       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
1980   };
1981   for (auto Operator : JoinedBinary) {
1982     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
1983     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1984     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
1985     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
1986   }
1987   // '~^' and '^~' can be unary as well as binary operators.
1988   auto Tokens = Annotate("x = ~^x;");
1989   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1990   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1991   Tokens = Annotate("x = ^~x;");
1992   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1993   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1994   // The unary operators '~&' and '~|' can only be unary operators. The current
1995   // implementation treats each of them as separate unary '~' and '&' or '|'
1996   // operators, which is enough for formatting purposes. In FormatTestVerilog,
1997   // there is a test that there is no space in between. And even if a new line
1998   // is inserted between the '~' and '|', the semantic meaning is the same as
1999   // the joined operator, so the CanBreakBefore property doesn't need to be
2000   // false for the second operator.
2001   Tokens = Annotate("x = ~&x;");
2002   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2003   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2004   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
2005   Tokens = Annotate("x = ~|x;");
2006   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2007   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2008   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
2009   // Test for block label colons.
2010   Tokens = Annotate("begin : x\n"
2011                     "end : x");
2012   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2013   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
2014   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
2015   // Test that the dimension colon is annotated correctly.
2016   Tokens = Annotate("var [1 : 0] x;");
2017   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2018   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
2019   Tokens = Annotate("extern function [1 : 0] x;");
2020   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2021   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
2022   Tokens = Annotate("module test\n"
2023                     "    (input wire [7 : 0] a[7 : 0]);\n"
2024                     "endmodule");
2025   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2026   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_VerilogDimensionedTypeName);
2027   EXPECT_TOKEN(Tokens[7], tok::colon, TT_BitFieldColon);
2028   EXPECT_TOKEN(Tokens[13], tok::colon, TT_BitFieldColon);
2029   // Test case labels and ternary operators.
2030   Tokens = Annotate("case (x)\n"
2031                     "  x:\n"
2032                     "    x;\n"
2033                     "endcase");
2034   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2035   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CaseLabelColon);
2036   Tokens = Annotate("case (x)\n"
2037                     "  x ? x : x:\n"
2038                     "    x;\n"
2039                     "endcase");
2040   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2041   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
2042   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
2043   EXPECT_TOKEN(Tokens[9], tok::colon, TT_CaseLabelColon);
2044   // Non-blocking assignments.
2045   Tokens = Annotate("a <= b;");
2046   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2047   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2048   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2049   Tokens = Annotate("if (a <= b) break;");
2050   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2051   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2052   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2053   Tokens = Annotate("a <= b <= a;");
2054   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2055   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2056   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2057   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2058   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2059 
2060   // Port lists in module instantiation.
2061   Tokens = Annotate("module_x instance_1(port_1), instance_2(port_2);");
2062   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2063   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2064   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_VerilogInstancePortLParen);
2065   Tokens = Annotate("module_x #(parameter) instance_1(port_1), "
2066                     "instance_2(port_2);");
2067   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2068   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2069   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_VerilogInstancePortLParen);
2070   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_VerilogInstancePortLParen);
2071 
2072   // Condition parentheses.
2073   Tokens = Annotate("assert (x);");
2074   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2075   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2076   Tokens = Annotate("assert #0 (x);");
2077   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2078   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_ConditionLParen);
2079   Tokens = Annotate("assert final (x);");
2080   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2081   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2082   Tokens = Annotate("foreach (x[x]) continue;");
2083   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2084   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2085   Tokens = Annotate("repeat (x[x]) continue;");
2086   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2087   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2088   Tokens = Annotate("case (x) endcase;");
2089   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2090   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2091 
2092   // Sensitivity list. The TT_Unknown type is clearly not binding for the
2093   // future, please adapt if those tokens get annotated.  This test is only here
2094   // to prevent the comma from being annotated as TT_VerilogInstancePortComma.
2095   Tokens = Annotate("always @(posedge x, posedge y);");
2096   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2097   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_Unknown);
2098   EXPECT_TOKEN(Tokens[5], tok::comma, TT_Unknown);
2099   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2100 
2101   // String literals in concatenation.
2102   Tokens = Annotate("x = {\"\"};");
2103   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2104   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2105   Tokens = Annotate("x = {\"\", \"\"};");
2106   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2107   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2108   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2109   Tokens = Annotate("x = '{{\"\"}};");
2110   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2111   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2112   // Cases where the string should not be annotated that type.  Fix the
2113   // `TT_Unknown` if needed in the future.
2114   Tokens = Annotate("x = {\"\" == \"\"};");
2115   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2116   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_Unknown);
2117   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_Unknown);
2118   Tokens = Annotate("x = {(\"\")};");
2119   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2120   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2121   Tokens = Annotate("x = '{\"\"};");
2122   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2123   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2124 }
2125 
2126 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
2127   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
2128 
2129   // The TT_Unknown is clearly not binding for the future, please adapt if those
2130   // tokens get annotated.
2131   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2132   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2133   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2134   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
2135   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2136   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2137   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2138   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
2139   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
2140   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2141 
2142   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
2143   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2144   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2145   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2146   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
2147   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
2148   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2149   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2150   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
2151   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
2152   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2153 }
2154 
2155 TEST_F(TokenAnnotatorTest, UnderstandsConditionParens) {
2156   auto Tokens = annotate("if (x) {}");
2157   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2158   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2159   Tokens = annotate("if constexpr (x) {}");
2160   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2161   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2162   Tokens = annotate("if CONSTEXPR (x) {}");
2163   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2164   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2165   Tokens = annotate("if (x) {} else if (x) {}");
2166   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2167   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2168   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_ConditionLParen);
2169 }
2170 
2171 TEST_F(TokenAnnotatorTest, CSharpNullableTypes) {
2172   FormatStyle Style = getGoogleStyle(FormatStyle::LK_CSharp);
2173 
2174   auto Tokens = annotate("int? a;", Style);
2175   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
2176   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2177 
2178   Tokens = annotate("int? a = 1;", Style);
2179   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
2180   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2181 
2182   Tokens = annotate("int?)", Style);
2183   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
2184   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2185 
2186   Tokens = annotate("int?>", Style);
2187   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
2188   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2189 
2190   Tokens = annotate("cond? id : id2", Style);
2191   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
2192   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2193 
2194   Tokens = annotate("cond ? cond2 ? : id1 : id2", Style);
2195   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
2196   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2197 }
2198 
2199 TEST_F(TokenAnnotatorTest, UnderstandsLabels) {
2200   auto Tokens = annotate("{ x: break; }");
2201   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2202   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2203   Tokens = annotate("{ case x: break; }");
2204   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2205   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2206   Tokens = annotate("{ x: { break; } }");
2207   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2208   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2209   Tokens = annotate("{ case x: { break; } }");
2210   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2211   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2212 }
2213 
2214 TEST_F(TokenAnnotatorTest, UnderstandsNestedBlocks) {
2215   // The closing braces are not annotated. It doesn't seem to cause a problem.
2216   // So we only test for the opening braces.
2217   auto Tokens = annotate("{\n"
2218                          "  {\n"
2219                          "    { int a = 0; }\n"
2220                          "  }\n"
2221                          "  {}\n"
2222                          "}");
2223   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2224   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2225   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
2226   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
2227   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2228 }
2229 
2230 TEST_F(TokenAnnotatorTest, UnderstandDesignatedInitializers) {
2231   auto Tokens = annotate("SomeStruct { .a = 1 };");
2232   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2233   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2234   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2235 
2236   Tokens = annotate("SomeStruct { .a = 1, .b = 2 };");
2237   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2238   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2239   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2240   EXPECT_TOKEN(Tokens[7], tok::period, TT_DesignatedInitializerPeriod);
2241 
2242   Tokens = annotate("SomeStruct {\n"
2243                     "#ifdef FOO\n"
2244                     "  .a = 1,\n"
2245                     "#endif\n"
2246                     "  .b = 2\n"
2247                     "};");
2248   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2249   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2250   EXPECT_TOKEN(Tokens[5], tok::period, TT_DesignatedInitializerPeriod);
2251   EXPECT_TOKEN(Tokens[12], tok::period, TT_DesignatedInitializerPeriod);
2252 
2253   Tokens = annotate("SomeStruct {\n"
2254                     "#if defined FOO\n"
2255                     "  .a = 1,\n"
2256                     "#endif\n"
2257                     "  .b = 2\n"
2258                     "};");
2259   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2260   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2261   EXPECT_TOKEN(Tokens[6], tok::period, TT_DesignatedInitializerPeriod);
2262   EXPECT_TOKEN(Tokens[13], tok::period, TT_DesignatedInitializerPeriod);
2263 }
2264 
2265 TEST_F(TokenAnnotatorTest, UnderstandsJavaScript) {
2266   auto Annotate = [this](llvm::StringRef Code) {
2267     return annotate(Code, getLLVMStyle(FormatStyle::LK_JavaScript));
2268   };
2269 
2270   // Dictionary.
2271   auto Tokens = Annotate("var x = {'x' : 1, 'y' : 2};");
2272   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2273   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_DictLiteral);
2274   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_SelectorName);
2275   EXPECT_TOKEN(Tokens[5], tok::colon, TT_DictLiteral);
2276   EXPECT_TOKEN(Tokens[8], tok::string_literal, TT_SelectorName);
2277   EXPECT_TOKEN(Tokens[9], tok::colon, TT_DictLiteral);
2278   // Change when we need to annotate these.
2279   EXPECT_BRACE_KIND(Tokens[3], BK_Unknown);
2280   EXPECT_BRACE_KIND(Tokens[11], BK_Unknown);
2281   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_Unknown);
2282 }
2283 
2284 TEST_F(TokenAnnotatorTest, UnderstandsAttributes) {
2285   auto Tokens = annotate("bool foo __attribute__((unused));");
2286   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2287   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2288   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_Unknown);
2289   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_Unknown);
2290   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_AttributeRParen);
2291 
2292   Tokens = annotate("bool foo __declspec(dllimport);");
2293   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2294   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2295   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2296 
2297   FormatStyle Style = getLLVMStyle();
2298   Style.AttributeMacros.push_back("FOO");
2299   Tokens = annotate("bool foo FOO(unused);", Style);
2300   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2301   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
2302   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2303   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2304 }
2305 
2306 TEST_F(TokenAnnotatorTest, UnderstandsControlStatements) {
2307   auto Tokens = annotate("while (true) {}");
2308   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2309   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2310   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2311 
2312   Tokens = annotate("for (;;) {}");
2313   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2314   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_ControlStatementLBrace);
2315   EXPECT_TOKEN(Tokens[6], tok::r_brace, TT_ControlStatementRBrace);
2316 
2317   Tokens = annotate("do {} while (true);");
2318   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2319   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_ControlStatementLBrace);
2320   EXPECT_TOKEN(Tokens[2], tok::r_brace, TT_ControlStatementRBrace);
2321 
2322   Tokens = annotate("if (true) {} else if (false) {} else {}");
2323   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
2324   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2325   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2326   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_ControlStatementLBrace);
2327   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_ControlStatementRBrace);
2328   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_ElseLBrace);
2329   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_ElseRBrace);
2330 
2331   Tokens = annotate("switch (foo) {}");
2332   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2333   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2334   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2335 }
2336 
2337 TEST_F(TokenAnnotatorTest, UnderstandsDoWhile) {
2338   auto Tokens = annotate("do { ++i; } while ( i > 5 );");
2339   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2340   EXPECT_TOKEN(Tokens[6], tok::kw_while, TT_DoWhile);
2341 
2342   Tokens = annotate("do ++i; while ( i > 5 );");
2343   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2344   EXPECT_TOKEN(Tokens[4], tok::kw_while, TT_DoWhile);
2345 }
2346 
2347 } // namespace
2348 } // namespace format
2349 } // namespace clang
2350