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