xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision 6dcde658b2380d7ca1451ea5d1099af3e294ea16)
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 
277 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) {
278   auto Tokens = annotate("x - 0");
279   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
280   EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator);
281   Tokens = annotate("0 + 0");
282   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
283   EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator);
284   Tokens = annotate("x + +0");
285   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
286   EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator);
287   Tokens = annotate("x ? -0 : +0");
288   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
289   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
290   EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator);
291   Tokens = annotate("(-0)");
292   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
293   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
294   Tokens = annotate("0, -0");
295   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
296   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
297   Tokens = annotate("for (; -1;) {\n}");
298   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
299   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
300   Tokens = annotate("x = -1;");
301   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
302   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
303   Tokens = annotate("x[-1]");
304   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
305   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
306   Tokens = annotate("x = {-1};");
307   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
308   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
309   Tokens = annotate("case -x:");
310   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
311   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
312   Tokens = annotate("co_await -x;");
313   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
314   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
315   Tokens = annotate("co_return -x;");
316   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
317   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
318   Tokens = annotate("co_yield -x;");
319   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
320   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
321   Tokens = annotate("delete -x;");
322   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
323   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
324   Tokens = annotate("return -x;");
325   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
326   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
327   Tokens = annotate("throw -x;");
328   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
329   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
330   Tokens = annotate("sizeof -x");
331   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
332   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
333   Tokens = annotate("co_await +x;");
334   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
335   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
336   Tokens = annotate("co_return +x;");
337   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
338   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
339   Tokens = annotate("co_yield +x;");
340   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
341   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
342   Tokens = annotate("delete +x;");
343   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
344   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
345   Tokens = annotate("return +x;");
346   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
347   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
348   Tokens = annotate("throw +x;");
349   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
350   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
351   Tokens = annotate("sizeof +x");
352   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
353   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
354   Tokens = annotate("(int)-x");
355   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
356   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
357   Tokens = annotate("(-x)");
358   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
359   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
360   Tokens = annotate("!+x");
361   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
362   EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator);
363   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
364 }
365 
366 TEST_F(TokenAnnotatorTest, UnderstandsClasses) {
367   auto Tokens = annotate("class C {};");
368   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
369   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
370 
371   Tokens = annotate("const class C {} c;");
372   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
373   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace);
374 
375   Tokens = annotate("const class {} c;");
376   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
377   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
378 
379   Tokens = annotate("class [[deprecated(\"\")]] C { int i; };");
380   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
381   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_ClassLBrace);
382 }
383 
384 TEST_F(TokenAnnotatorTest, UnderstandsStructs) {
385   auto Tokens = annotate("struct S {};");
386   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
387   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace);
388 
389   Tokens = annotate("struct EXPORT_MACRO [[nodiscard]] C { int i; };");
390   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
391   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_StructLBrace);
392 
393   Tokens = annotate("struct [[deprecated]] [[nodiscard]] C { int i; };");
394   EXPECT_EQ(Tokens.size(), 19u) << Tokens;
395   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_StructLBrace);
396 
397   Tokens = annotate("template <typename T> struct S<const T[N]> {};");
398   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
399   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
400   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
401   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
402   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
403 
404   Tokens = annotate("template <typename T> struct S<T const[N]> {};");
405   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
406   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
407   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
408   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
409   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
410 
411   Tokens = annotate("template <typename T, unsigned n> struct S<T const[n]> {\n"
412                     "  void f(T const (&a)[n]);\n"
413                     "};");
414   EXPECT_EQ(Tokens.size(), 35u) << Tokens;
415   EXPECT_TOKEN(Tokens[10], tok::less, TT_TemplateOpener);
416   EXPECT_TOKEN(Tokens[13], tok::l_square, TT_ArraySubscriptLSquare);
417   EXPECT_TOKEN(Tokens[16], tok::greater, TT_TemplateCloser);
418   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_StructLBrace);
419   EXPECT_TOKEN(Tokens[23], tok::l_paren, TT_FunctionTypeLParen);
420   EXPECT_TOKEN(Tokens[24], tok::amp, TT_UnaryOperator);
421   EXPECT_TOKEN(Tokens[27], tok::l_square, TT_ArraySubscriptLSquare);
422 }
423 
424 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
425   auto Tokens = annotate("union U {};");
426   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
427   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
428 
429   Tokens = annotate("union U { void f() { return; } };");
430   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
431   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
432   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
433 }
434 
435 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
436   auto Tokens = annotate("enum E {};");
437   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
438   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
439 }
440 
441 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
442   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
443   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
444   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
445 
446   Tokens = annotate("template <typename T> void F(T) && = delete;");
447   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
448   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
449 }
450 
451 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
452   auto Tokens =
453       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
454   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
455   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
456 }
457 
458 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
459   auto Tokens =
460       annotate("template <typename T> "
461                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
462   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
463   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
464 }
465 
466 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) {
467   auto Tokens =
468       annotate("#define FOO(typeName) \\\n"
469                "  { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }");
470   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
471   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
472   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
473   EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener);
474   EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser);
475 }
476 
477 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) {
478   auto Tokens = annotate("if (std::tuple_size_v<T> > 0)");
479   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
480   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
481   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
482   EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator);
483 }
484 
485 TEST_F(TokenAnnotatorTest, UnderstandsNonTemplateAngleBrackets) {
486   auto Tokens = annotate("return a < b && c > d;");
487   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
488   EXPECT_TOKEN(Tokens[2], tok::less, TT_BinaryOperator);
489   EXPECT_TOKEN(Tokens[6], tok::greater, TT_BinaryOperator);
490 
491   Tokens = annotate("a < 0 ? b : a > 0 ? c : d;");
492   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
493   EXPECT_TOKEN(Tokens[1], tok::less, TT_BinaryOperator);
494   EXPECT_TOKEN(Tokens[7], tok::greater, TT_BinaryOperator);
495 
496   Tokens = annotate("ratio{-1, 2} < ratio{-1, 3} == -1 / 3 > -1 / 2;");
497   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
498   EXPECT_TOKEN(Tokens[7], tok::less, TT_BinaryOperator);
499   EXPECT_TOKEN(Tokens[20], tok::greater, TT_BinaryOperator);
500 }
501 
502 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
503   FormatStyle Style = getLLVMStyle();
504   Style.WhitespaceSensitiveMacros.push_back("FOO");
505 
506   auto Tokens = annotate("FOO(1+2 )\n", Style);
507   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
508   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
509 
510   Tokens = annotate("FOO(a:b:c)\n", Style);
511   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
512   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
513 }
514 
515 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
516   auto Tokens = annotate("delete (void *)p;");
517   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
518   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
519 
520   Tokens = annotate("delete[] (void *)p;");
521   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
522   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
523 
524   Tokens = annotate("delete[] /*comment*/ (void *)p;");
525   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
526   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
527 
528   Tokens = annotate("delete[/*comment*/] (void *)p;");
529   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
530   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
531 
532   Tokens = annotate("delete/*comment*/[] (void *)p;");
533   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
534   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
535 }
536 
537 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
538   auto Tokens = annotate("(void)p;");
539   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
540   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
541 
542   Tokens = annotate("auto x = (Foo)p;");
543   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
544   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
545 
546   Tokens = annotate("(std::vector<int>)p;");
547   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
548   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
549 
550   Tokens = annotate("return (Foo)p;");
551   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
552   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
553 
554   Tokens = annotate("throw (Foo)p;");
555   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
556   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
557 }
558 
559 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
560   auto Tokens = annotate("void f() throw(int);");
561   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
562   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
563 }
564 
565 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
566   auto Tokens = annotate("void f() &;");
567   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
568   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
569 
570   Tokens = annotate("void operator=(T) &&;");
571   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
572   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
573 
574   Tokens = annotate("template <typename T> void f() &;");
575   EXPECT_EQ(Tokens.size(), 12u) << Tokens;
576   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
577 
578   Tokens = annotate("template <typename T> void operator=(T) &;");
579   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
580   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
581 }
582 
583 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
584   auto Tokens = annotate("x.operator+()");
585   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
586   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
587   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
588   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
589   Tokens = annotate("x.operator=()");
590   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
591   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
592   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
593   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
594   Tokens = annotate("x.operator+=()");
595   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
596   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
597   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
598   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
599   Tokens = annotate("x.operator,()");
600   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
601   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
602   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
603   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
604   Tokens = annotate("x.operator()()");
605   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
606   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
607   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
608   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
609   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
610   Tokens = annotate("x.operator[]()");
611   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
612   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
613   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
614   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
615   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
616   Tokens = annotate("x.operator\"\"_a()");
617   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
618   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
619   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
620   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
621   Tokens = annotate("x.operator\"\" _a()");
622   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
623   // FIXME
624   // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
625   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
626   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
627   Tokens = annotate("x.operator\"\"if()");
628   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
629   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
630   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
631   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
632   Tokens = annotate("x.operator\"\"s()");
633   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
634   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
635   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
636   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
637   Tokens = annotate("x.operator\"\" s()");
638   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
639   // FIXME
640   // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
641   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
642   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
643 
644   Tokens = annotate("int operator+(int);");
645   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
646   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
647   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
648   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
649   Tokens = annotate("auto operator=(T&) {}");
650   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
651   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
652   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
653   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
654   Tokens = annotate("auto operator()() {}");
655   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
656   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
657   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
658   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
659   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
660 }
661 
662 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
663   struct {
664     const char *Text;
665     tok::TokenKind Kind;
666   } Operators[] = {{"+", tok::plus},
667                    {"-", tok::minus},
668                    // FIXME:
669                    // {"*", tok::star},
670                    {"/", tok::slash},
671                    {"%", tok::percent},
672                    {"^", tok::caret},
673                    // FIXME:
674                    // {"&", tok::amp},
675                    {"|", tok::pipe},
676                    {"~", tok::tilde},
677                    {"!", tok::exclaim},
678                    {"=", tok::equal},
679                    // FIXME:
680                    // {"<", tok::less},
681                    {">", tok::greater},
682                    {"+=", tok::plusequal},
683                    {"-=", tok::minusequal},
684                    {"*=", tok::starequal},
685                    {"/=", tok::slashequal},
686                    {"%=", tok::percentequal},
687                    {"^=", tok::caretequal},
688                    {"&=", tok::ampequal},
689                    {"|=", tok::pipeequal},
690                    {"<<", tok::lessless},
691                    {">>", tok::greatergreater},
692                    {">>=", tok::greatergreaterequal},
693                    {"<<=", tok::lesslessequal},
694                    {"==", tok::equalequal},
695                    {"!=", tok::exclaimequal},
696                    {"<=", tok::lessequal},
697                    {">=", tok::greaterequal},
698                    {"<=>", tok::spaceship},
699                    {"&&", tok::ampamp},
700                    {"||", tok::pipepipe},
701                    {"++", tok::plusplus},
702                    {"--", tok::minusminus},
703                    {",", tok::comma},
704                    {"->*", tok::arrowstar},
705                    {"->", tok::arrow}};
706 
707   for (const auto &Operator : Operators) {
708     std::string Input("C<&operator");
709     Input += Operator.Text;
710     Input += " > a;";
711     auto Tokens = annotate(std::string(Input));
712     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
713     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
714     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
715     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
716   }
717 
718   auto Tokens = annotate("C<&operator< <X>> lt;");
719   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
720   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
721   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
722   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
723   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
724   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
725 }
726 
727 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
728   auto Tokens = annotate("template <typename T>\n"
729                          "concept C = (Foo && Bar) && (Bar && Baz);");
730 
731   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
732   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
733   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
734   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
735 
736   Tokens = annotate("template <typename T>\n"
737                     "concept C = Foo && !Bar;");
738 
739   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
740   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
741   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
742 
743   Tokens = annotate("template <typename T>\n"
744                     "concept C = requires(T t) {\n"
745                     "  { t.foo() };\n"
746                     "} && Bar<T> && Baz<T>;");
747   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
748   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
749   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
750   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
751   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
752   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
753 
754   Tokens = annotate("template<typename T>\n"
755                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
756                     "struct Foo;");
757   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
758   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
759   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
760   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
761   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
762   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
763   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
764   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
765   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
766   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
767   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
768 
769   Tokens =
770       annotate("template<typename T>\n"
771                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
772                "struct Foo;");
773   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
774   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
775   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
776   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
777   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
778   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
779   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
780   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
781   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
782   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
783   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
784   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
785 
786   Tokens = annotate("template <typename T>\n"
787                     "void foo(T) noexcept requires Bar<T>;");
788   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
789   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
790 
791   Tokens = annotate("template <typename T>\n"
792                     "requires Bar<T> || Baz<T>\n"
793                     "auto foo(T) -> int;");
794   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
795   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
796   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
797   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
798   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
799 
800   Tokens = annotate("template <typename T>\n"
801                     "requires Bar<T>\n"
802                     "bool foo(T) { return false; }");
803   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
804   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
805   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
806   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
807 
808   Tokens = annotate("template <typename T>\n"
809                     "requires Bar<T>\n"
810                     "decltype(auto) foo(T) { return false; }");
811   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
812   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
813   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
814   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
815 
816   Tokens = annotate("template <typename T>\n"
817                     "struct S {\n"
818                     "  void foo() const requires Bar<T>;\n"
819                     "  void bar() const & requires Baz<T>;\n"
820                     "  void bar() && requires Baz2<T>;\n"
821                     "  void baz() const & noexcept requires Baz<T>;\n"
822                     "  void baz() && noexcept requires Baz2<T>;\n"
823                     "};\n"
824                     "\n"
825                     "void S::bar() const & requires Baz<T> { }");
826   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
827   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
828   EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference);
829   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
830   EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference);
831   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
832   EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference);
833   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
834   EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference);
835   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
836   EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference);
837   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
838 
839   Tokens = annotate("void Class::member() && requires(Constant) {}");
840   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
841   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
842 
843   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
844   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
845   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
846 
847   Tokens =
848       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
849   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
850   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
851 
852   Tokens = annotate("void Class::member() && requires(typename "
853                     "Namespace::Outer<T>::Inner::Constant) {}");
854   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
855   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
856 
857   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
858                     "  template<class T>\n"
859                     "    requires requires { number_zero_v<T>; }\n"
860                     "  [[nodiscard]] constexpr operator T() const { "
861                     "return number_zero_v<T>; }\n"
862                     "};");
863   ASSERT_EQ(Tokens.size(), 44u) << Tokens;
864   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
865   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
866   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
867   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
868   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
869   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
870 
871   Tokens =
872       annotate("template <class A, class B> concept C ="
873                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
874   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
875   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
876   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
877   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
878   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
879   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
880   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
881   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
882 
883   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
884   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
885   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
886 
887   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
888   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
889   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
890 
891   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
892   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
893   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
894 
895   Tokens =
896       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
897   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
898   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
899 
900   Tokens =
901       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
902   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
903   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
904 
905   Tokens =
906       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
907   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
908   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
909 }
910 
911 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
912   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
913   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
914   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
915   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
916   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
917 
918   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
919   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
920   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
921   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
922   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
923 
924   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
925   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
926   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
927   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
928   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
929 
930   Tokens = annotate("foo(requires(const T t) {});");
931   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
932   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
933   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
934   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
935 
936   Tokens = annotate("foo(requires(const int t) {});");
937   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
938   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
939   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
940   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
941 
942   Tokens = annotate("foo(requires(const T t) {});");
943   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
944   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
945   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
946   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
947 
948   Tokens = annotate("foo(requires(int const* volatile t) {});");
949   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
950   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
951   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
952   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
953   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
954 
955   Tokens = annotate("foo(requires(T const* volatile t) {});");
956   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
957   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
958   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
959   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
960   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
961 
962   Tokens = annotate("foo(requires(T& t) {});");
963   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
964   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
965   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
966   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
967   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
968 
969   Tokens = annotate("foo(requires(T&& t) {});");
970   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
971   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
972   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
973   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
974   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
975 
976   Tokens = annotate("bool foo = requires(T& t) {};");
977   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
978   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
979   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
980   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
981   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
982 
983   Tokens = annotate("bool foo = requires(T&& t) {};");
984   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
985   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
986   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
987   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
988   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
989 
990   Tokens =
991       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
992   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
993   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
994   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
995   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
996   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
997 
998   Tokens = annotate("template <typename T>\n"
999                     "concept C = requires(T T) {\n"
1000                     "  requires Bar<T> && Foo<T>;\n"
1001                     "};");
1002   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
1003   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1004   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1005   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1006   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
1007                TT_RequiresClauseInARequiresExpression);
1008 
1009   Tokens = annotate("template <typename T>\n"
1010                     "concept C = requires(T T) {\n"
1011                     "  { t.func() } -> std::same_as<int>;"
1012                     "  requires Bar<T> && Foo<T>;\n"
1013                     "};");
1014   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
1015   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1016   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1017   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1018   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
1019                TT_RequiresClauseInARequiresExpression);
1020 
1021   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
1022   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
1023                     "requires true; };");
1024   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1025   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1026   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1027   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
1028 }
1029 
1030 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
1031   // Everything after #pragma region should be ImplicitStringLiteral
1032   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
1033   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1034   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
1035   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
1036   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
1037 
1038   // Make sure it's annotated correctly inside a function as well
1039   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
1040   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1041   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
1042   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
1043   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
1044 }
1045 
1046 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
1047   const char *BaseCode = nullptr;
1048   const char *ConstrainedCode = nullptr;
1049   auto BaseTokenCount = 0u;
1050   auto RequiresTokenCount = 0u;
1051   auto PrefixTokenCount = 0u;
1052 
1053   auto TestRequires = [&](int Line) {
1054     const auto BaseTokens = annotate(BaseCode);
1055     const auto ConstrainedTokens = annotate(ConstrainedCode);
1056 
1057 #define LINE " (Line " << Line << ')'
1058 
1059     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
1060     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
1061         << LINE;
1062 
1063     for (auto I = 0u; I < BaseTokenCount; ++I) {
1064       EXPECT_EQ(
1065           *BaseTokens[I],
1066           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
1067           << I << LINE;
1068     }
1069 
1070 #undef LINE
1071   };
1072 
1073   BaseCode = "template<typename T>\n"
1074              "T Pi = 3.14;";
1075   ConstrainedCode = "template<typename T>\n"
1076                     "  requires Foo<T>\n"
1077                     "T Pi = 3.14;";
1078   BaseTokenCount = 11;
1079   RequiresTokenCount = 5;
1080   PrefixTokenCount = 5;
1081   TestRequires(__LINE__);
1082 
1083   BaseCode = "template<typename T>\n"
1084              "struct Bar;";
1085   ConstrainedCode = "template<typename T>\n"
1086                     "  requires Foo<T>\n"
1087                     "struct Bar;";
1088   BaseTokenCount = 9;
1089   TestRequires(__LINE__);
1090 
1091   BaseCode = "template<typename T>\n"
1092              "struct Bar {\n"
1093              "  T foo();\n"
1094              "  T bar();\n"
1095              "};";
1096   ConstrainedCode = "template<typename T>\n"
1097                     "  requires Foo<T>\n"
1098                     "struct Bar {\n"
1099                     "  T foo();\n"
1100                     "  T bar();\n"
1101                     "};";
1102   BaseTokenCount = 21;
1103   TestRequires(__LINE__);
1104 
1105   BaseCode = "template<typename T>\n"
1106              "Bar(T) -> Bar<T>;";
1107   ConstrainedCode = "template<typename T>\n"
1108                     "  requires Foo<T>\n"
1109                     "Bar(T) -> Bar<T>;";
1110   BaseTokenCount = 16;
1111   TestRequires(__LINE__);
1112 
1113   BaseCode = "template<typename T>\n"
1114              "T foo();";
1115   ConstrainedCode = "template<typename T>\n"
1116                     "  requires Foo<T>\n"
1117                     "T foo();";
1118   BaseTokenCount = 11;
1119   TestRequires(__LINE__);
1120 
1121   BaseCode = "template<typename T>\n"
1122              "T foo() {\n"
1123              "  auto bar = baz();\n"
1124              "  return bar + T{};\n"
1125              "}";
1126   ConstrainedCode = "template<typename T>\n"
1127                     "  requires Foo<T>\n"
1128                     "T foo() {\n"
1129                     "  auto bar = baz();\n"
1130                     "  return bar + T{};\n"
1131                     "}";
1132   BaseTokenCount = 26;
1133   TestRequires(__LINE__);
1134 
1135   BaseCode = "template<typename T>\n"
1136              "T foo();";
1137   ConstrainedCode = "template<typename T>\n"
1138                     "T foo() requires Foo<T>;";
1139   BaseTokenCount = 11;
1140   PrefixTokenCount = 9;
1141   TestRequires(__LINE__);
1142 
1143   BaseCode = "template<typename T>\n"
1144              "T foo() {\n"
1145              "  auto bar = baz();\n"
1146              "  return bar + T{};\n"
1147              "}";
1148   ConstrainedCode = "template<typename T>\n"
1149                     "T foo() requires Foo<T> {\n"
1150                     "  auto bar = baz();\n"
1151                     "  return bar + T{};\n"
1152                     "}";
1153   BaseTokenCount = 26;
1154   TestRequires(__LINE__);
1155 
1156   BaseCode = "template<typename T>\n"
1157              "T foo();";
1158   ConstrainedCode = "template<typename T>\n"
1159                     "  requires(Foo<T>)\n"
1160                     "T foo();";
1161   BaseTokenCount = 11;
1162   RequiresTokenCount = 7;
1163   PrefixTokenCount = 5;
1164   TestRequires(__LINE__);
1165 
1166   BaseCode = "template<typename T>\n"
1167              "Bar(T) -> Bar<typename T::I>;";
1168   ConstrainedCode = "template<typename T>\n"
1169                     "  requires requires(T &&t) {\n"
1170                     "             typename T::I;\n"
1171                     "           }\n"
1172                     "Bar(T) -> Bar<typename T::I>;";
1173   BaseTokenCount = 19;
1174   RequiresTokenCount = 14;
1175   PrefixTokenCount = 5;
1176   TestRequires(__LINE__);
1177 
1178   BaseCode = "struct [[nodiscard]] zero_t {\n"
1179              "  template<class T>\n"
1180              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1181              "};";
1182   ConstrainedCode =
1183       "struct [[nodiscard]] zero_t {\n"
1184       "  template<class T>\n"
1185       "    requires requires { v<T>; }\n"
1186       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1187       "};";
1188   BaseTokenCount = 35;
1189   RequiresTokenCount = 9;
1190   PrefixTokenCount = 13;
1191   TestRequires(__LINE__);
1192 
1193   BaseCode = "constexpr Foo(Foo const &other)\n"
1194              "    : value{other.value} {\n"
1195              "  do_magic();\n"
1196              "  do_more_magic();\n"
1197              "}";
1198   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1199                     "  requires std::is_copy_constructible<T>\n"
1200                     "    : value{other.value} {\n"
1201                     "  do_magic();\n"
1202                     "  do_more_magic();\n"
1203                     "}";
1204   BaseTokenCount = 26;
1205   RequiresTokenCount = 7;
1206   PrefixTokenCount = 8;
1207   TestRequires(__LINE__);
1208 
1209   BaseCode = "constexpr Foo(Foo const &other)\n"
1210              "    : value{other.value} {\n"
1211              "  do_magic();\n"
1212              "  do_more_magic();\n"
1213              "}";
1214   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1215                     "  requires (std::is_copy_constructible<T>)\n"
1216                     "    : value{other.value} {\n"
1217                     "  do_magic();\n"
1218                     "  do_more_magic();\n"
1219                     "}";
1220   RequiresTokenCount = 9;
1221   TestRequires(__LINE__);
1222 }
1223 
1224 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1225   auto Tokens = annotate("__asm{\n"
1226                          "a:\n"
1227                          "};");
1228   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1229   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1230   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1231   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
1232 }
1233 
1234 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1235   auto Tokens = annotate("int (^)() = ^ ()\n"
1236                          "  external_source_symbol() { //\n"
1237                          "  return 1;\n"
1238                          "};");
1239   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1240   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1241   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1242 
1243   Tokens = annotate("int *p = ^int*(){ //\n"
1244                     "  return nullptr;\n"
1245                     "}();");
1246   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1247   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1248 }
1249 
1250 TEST_F(TokenAnnotatorTest, UnderstandsObjCMethodExpr) {
1251   auto Tokens = annotate("void f() {\n"
1252                          "  //\n"
1253                          "  BOOL a = [b.c n] > 1;\n"
1254                          "}");
1255   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
1256   EXPECT_TOKEN(Tokens[9], tok::l_square, TT_ObjCMethodExpr);
1257   EXPECT_TOKEN(Tokens[15], tok::greater, TT_BinaryOperator);
1258 }
1259 
1260 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1261   auto Tokens = annotate("[]() constexpr {}");
1262   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1263   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1264   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1265 
1266   Tokens = annotate("[]() consteval {}");
1267   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1268   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1269   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1270 
1271   Tokens = annotate("[]() mutable {}");
1272   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1273   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1274   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1275 
1276   Tokens = annotate("[]() static {}");
1277   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1278   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1279   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1280 
1281   Tokens = annotate("[]() -> auto {}");
1282   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1283   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1284   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1285   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1286 
1287   Tokens = annotate("[]() -> auto & {}");
1288   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1289   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1290   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1291   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1292 
1293   Tokens = annotate("[]() -> auto * {}");
1294   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1295   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1296   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1297   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1298 
1299   Tokens = annotate("[] {}");
1300   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1301   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1302   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1303 
1304   Tokens = annotate("[] noexcept {}");
1305   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1306   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1307   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1308 
1309   Tokens = annotate("[] -> auto {}");
1310   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1311   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1312   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_LambdaArrow);
1313   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1314 
1315   Tokens = annotate("[] <typename T> () {}");
1316   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1317   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1318   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1319   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1320 
1321   Tokens = annotate("[] <typename T> {}");
1322   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1323   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1324   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1325   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1326 
1327   Tokens = annotate("[] <typename... T> () {}");
1328   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1329   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1330   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1331   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1332 
1333   Tokens = annotate("[] <typename... T> {}");
1334   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1335   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1336   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1337   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1338 
1339   Tokens = annotate("[] <int... T> () {}");
1340   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1341   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1342   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1343   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1344 
1345   Tokens = annotate("[] <int... T> {}");
1346   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1347   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1348   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1349   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1350 
1351   Tokens = annotate("[] <Foo... T> () {}");
1352   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1353   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1354   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1355   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1356 
1357   Tokens = annotate("[] <Foo... T> {}");
1358   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1359   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1360   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1361   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1362 
1363   // Lambdas with a requires-clause
1364   Tokens = annotate("[] <typename T> (T t) requires Bar<T> {}");
1365   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1366   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1367   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1368   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1369   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1370   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1371 
1372   Tokens = annotate("[] <typename T> (T &&t) requires Bar<T> {}");
1373   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1374   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1375   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1376   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_PointerOrReference);
1377   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1378   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1379   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1380 
1381   Tokens = annotate("[] <typename T> (T t) requires Foo<T> || Bar<T> {}");
1382   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1383   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1384   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1385   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1386   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1387   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1388 
1389   Tokens = annotate("[] <typename T> (T t) -> T requires Bar<T> {}");
1390   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1391   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1392   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1393   EXPECT_TOKEN(Tokens[10], tok::arrow, TT_LambdaArrow);
1394   EXPECT_TOKEN(Tokens[12], tok::kw_requires, TT_RequiresClause);
1395   EXPECT_TRUE(Tokens[16]->ClosesRequiresClause);
1396   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1397 
1398   Tokens = annotate("[] <typename T> requires Bar<T> (T t) {}");
1399   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1400   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1401   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1402   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1403   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1404   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1405 
1406   Tokens = annotate("[] <typename T> requires Bar<T> (T &&t) {}");
1407   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1408   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1409   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1410   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1411   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1412   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_PointerOrReference);
1413   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1414 
1415   Tokens = annotate("[] <typename T> requires Foo<T> || Bar<T> (T t) {}");
1416   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1417   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1418   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1419   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1420   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1421   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1422 
1423   Tokens = annotate("[] <typename T> requires true (T&& t) {}");
1424   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1425   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1426   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1427   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1428   EXPECT_TRUE(Tokens[7]->ClosesRequiresClause);
1429   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1430   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1431 
1432   Tokens = annotate("[] <typename T> requires Bar<T> {}");
1433   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1434   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1435   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1436   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1437   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1438   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_LambdaLBrace);
1439 
1440   Tokens = annotate("[] <typename T> requires Bar<T> noexcept {}");
1441   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1442   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1443   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1444   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1445   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1446   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1447 
1448   Tokens = annotate("[] <typename T> requires Bar<T> -> T {}");
1449   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1450   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1451   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1452   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1453   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1454   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_LambdaArrow);
1455   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1456 
1457   Tokens = annotate("[] <typename T> requires Foo<T> (T t) requires Bar<T> {}");
1458   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1459   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1460   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1461   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1462   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1463   EXPECT_TOKEN(Tokens[15], tok::kw_requires, TT_RequiresClause);
1464   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1465   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1466 }
1467 
1468 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1469   auto Tokens = annotate("template <typename T>\n"
1470                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1471                          "string OldFunction(const string &parameter) {}");
1472   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1473   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1474 
1475   Tokens = annotate("template <typename T>\n"
1476                     "A(T) noexcept;");
1477   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1478   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1479 }
1480 
1481 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1482   auto Tokens = annotate("void f [[noreturn]] ();");
1483   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1484   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1485 
1486   Tokens = annotate("void f [[noreturn]] () {}");
1487   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1488   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1489 }
1490 
1491 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1492   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1493   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1494   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1495   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1496   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1497 }
1498 
1499 TEST_F(TokenAnnotatorTest, UnderstandsTrailingReturnArrow) {
1500   auto Tokens = annotate("auto f() -> int;");
1501   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1502   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1503 
1504   Tokens = annotate("auto operator->() -> int;");
1505   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1506   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_OverloadedOperator);
1507   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1508 
1509   Tokens = annotate("auto operator++(int) -> int;");
1510   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1511   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1512 
1513   Tokens = annotate("auto operator=() -> int;");
1514   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1515   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1516 
1517   Tokens = annotate("auto operator=(int) -> int;");
1518   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1519   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1520 
1521   Tokens = annotate("auto foo() -> auto { return Val; }");
1522   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1523   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1524 
1525   Tokens = annotate("struct S { auto bar() const -> int; };");
1526   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1527   EXPECT_TOKEN(Tokens[8], tok::arrow, TT_TrailingReturnArrow);
1528 
1529   // Not trailing return arrows
1530   Tokens = annotate("auto a = b->c;");
1531   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1532   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1533 
1534   Tokens = annotate("auto a = (b)->c;");
1535   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1536   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1537 
1538   Tokens = annotate("auto a = b()->c;");
1539   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1540   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1541 
1542   Tokens = annotate("auto a = b->c();");
1543   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1544   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1545 
1546   Tokens = annotate("decltype(auto) a = b()->c;");
1547   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1548   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1549 
1550   Tokens = annotate("void f() { auto a = b->c(); }");
1551   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1552   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1553 
1554   Tokens = annotate("void f() { auto a = b()->c; }");
1555   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1556   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_Unknown);
1557 
1558   // Mixed
1559   Tokens = annotate("auto f() -> int { auto a = b()->c; }");
1560   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1561   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1562   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
1563 }
1564 
1565 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
1566   auto Annotate = [this](llvm::StringRef Code) {
1567     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
1568   };
1569   // Test that unary operators get labeled as such and that operators like '++'
1570   // don't get split.
1571   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
1572                             tok::tilde, tok::amp,      tok::pipe,
1573                             tok::caret, tok::plusplus, tok::minusminus};
1574   for (auto Kind : Unary) {
1575     auto Tokens =
1576         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
1577     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1578     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
1579   }
1580   // Operators formed by joining two operators like '^~'. For some of these
1581   // joined operators, we don't have a separate type, so we only test for their
1582   // precedence.
1583   std::pair<prec::Level, std::string> JoinedBinary[] = {
1584       {prec::Comma, "<->"},       {prec::Assignment, "+="},
1585       {prec::Assignment, "-="},   {prec::Assignment, "*="},
1586       {prec::Assignment, "/="},   {prec::Assignment, "%="},
1587       {prec::Assignment, "&="},   {prec::Assignment, "^="},
1588       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
1589       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
1590       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
1591       {prec::Equality, "=="},     {prec::Equality, "!="},
1592       {prec::Equality, "==="},    {prec::Equality, "!=="},
1593       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
1594       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
1595   };
1596   for (auto Operator : JoinedBinary) {
1597     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
1598     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1599     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
1600     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
1601   }
1602   // '~^' and '^~' can be unary as well as binary operators.
1603   auto Tokens = Annotate("x = ~^x;");
1604   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1605   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1606   Tokens = Annotate("x = ^~x;");
1607   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1608   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1609   // The unary operators '~&' and '~|' can only be unary operators. The current
1610   // implementation treats each of them as separate unary '~' and '&' or '|'
1611   // operators, which is enough for formatting purposes. In FormatTestVerilog,
1612   // there is a test that there is no space in between. And even if a new line
1613   // is inserted between the '~' and '|', the semantic meaning is the same as
1614   // the joined operator, so the CanBreakBefore property doesn't need to be
1615   // false for the second operator.
1616   Tokens = Annotate("x = ~&x;");
1617   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1618   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1619   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
1620   Tokens = Annotate("x = ~|x;");
1621   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1622   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1623   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
1624   // Test for block label colons.
1625   Tokens = Annotate("begin : x\n"
1626                     "end : x");
1627   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1628   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
1629   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
1630   // Test that the dimension colon is annotated correctly.
1631   Tokens = Annotate("var [1 : 0] x;");
1632   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1633   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
1634   Tokens = Annotate("extern function [1 : 0] x;");
1635   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1636   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
1637   Tokens = Annotate("module test\n"
1638                     "    (input wire [7 : 0] a[7 : 0]);\n"
1639                     "endmodule");
1640   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1641   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_VerilogDimensionedTypeName);
1642   EXPECT_TOKEN(Tokens[7], tok::colon, TT_BitFieldColon);
1643   EXPECT_TOKEN(Tokens[13], tok::colon, TT_BitFieldColon);
1644   // Test case labels and ternary operators.
1645   Tokens = Annotate("case (x)\n"
1646                     "  x:\n"
1647                     "    x;\n"
1648                     "endcase\n");
1649   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1650   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CaseLabelColon);
1651   Tokens = Annotate("case (x)\n"
1652                     "  x ? x : x:\n"
1653                     "    x;\n"
1654                     "endcase\n");
1655   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1656   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
1657   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
1658   EXPECT_TOKEN(Tokens[9], tok::colon, TT_CaseLabelColon);
1659   // Non-blocking assignments.
1660   Tokens = Annotate("a <= b;");
1661   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1662   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1663   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1664   Tokens = Annotate("if (a <= b) break;");
1665   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1666   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1667   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1668   Tokens = Annotate("a <= b <= a;");
1669   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1670   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1671   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1672   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1673   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1674 
1675   // Port lists in module instantiation.
1676   Tokens = Annotate("module_x instance_1(port_1), instance_2(port_2);");
1677   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1678   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
1679   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_VerilogInstancePortLParen);
1680   Tokens = Annotate("module_x #(parameter) instance_1(port_1), "
1681                     "instance_2(port_2);");
1682   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1683   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
1684   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_VerilogInstancePortLParen);
1685   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_VerilogInstancePortLParen);
1686 
1687   // Condition parentheses.
1688   Tokens = Annotate("assert (x);");
1689   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1690   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1691   Tokens = Annotate("assert #0 (x);");
1692   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1693   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_ConditionLParen);
1694   Tokens = Annotate("assert final (x);");
1695   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1696   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
1697   Tokens = Annotate("foreach (x[x]) continue;");
1698   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1699   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1700   Tokens = Annotate("repeat (x[x]) continue;");
1701   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1702   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1703   Tokens = Annotate("case (x) endcase;");
1704   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1705   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1706 
1707   // Sensitivity list. The TT_Unknown type is clearly not binding for the
1708   // future, please adapt if those tokens get annotated.  This test is only here
1709   // to prevent the comma from being annotated as TT_VerilogInstancePortComma.
1710   Tokens = Annotate("always @(posedge x, posedge y);");
1711   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1712   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_Unknown);
1713   EXPECT_TOKEN(Tokens[5], tok::comma, TT_Unknown);
1714   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1715 }
1716 
1717 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
1718   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
1719 
1720   // The TT_Unknown is clearly not binding for the future, please adapt if those
1721   // tokens get annotated.
1722   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1723   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1724   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1725   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
1726   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1727   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1728   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1729   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
1730   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
1731   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1732 
1733   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
1734   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1735   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1736   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1737   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
1738   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
1739   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1740   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1741   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
1742   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
1743   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1744 }
1745 
1746 TEST_F(TokenAnnotatorTest, UnderstandsConditionParens) {
1747   auto Tokens = annotate("if (x) {}");
1748   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1749   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1750   Tokens = annotate("if constexpr (x) {}");
1751   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1752   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
1753   Tokens = annotate("if CONSTEXPR (x) {}");
1754   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1755   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
1756   Tokens = annotate("if (x) {} else if (x) {}");
1757   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1758   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1759   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_ConditionLParen);
1760 }
1761 
1762 TEST_F(TokenAnnotatorTest, CSharpNullableTypes) {
1763   FormatStyle Style = getGoogleStyle(FormatStyle::LK_CSharp);
1764 
1765   auto Tokens = annotate("int? a;", Style);
1766   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
1767   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1768 
1769   Tokens = annotate("int? a = 1;", Style);
1770   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
1771   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1772 
1773   Tokens = annotate("int?)", Style);
1774   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
1775   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1776 
1777   Tokens = annotate("int?>", Style);
1778   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
1779   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1780 
1781   Tokens = annotate("cond? id : id2", Style);
1782   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
1783   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
1784 
1785   Tokens = annotate("cond ? cond2 ? : id1 : id2", Style);
1786   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
1787   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
1788 }
1789 
1790 TEST_F(TokenAnnotatorTest, UnderstandsLabels) {
1791   auto Tokens = annotate("{ x: break; }");
1792   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1793   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
1794   Tokens = annotate("{ case x: break; }");
1795   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1796   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
1797   Tokens = annotate("{ x: { break; } }");
1798   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1799   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
1800   Tokens = annotate("{ case x: { break; } }");
1801   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1802   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
1803 }
1804 
1805 TEST_F(TokenAnnotatorTest, UnderstandsNestedBlocks) {
1806   // The closing braces are not annotated. It doesn't seem to cause a problem.
1807   // So we only test for the opening braces.
1808   auto Tokens = annotate("{\n"
1809                          "  {\n"
1810                          "    { int a = 0; }\n"
1811                          "  }\n"
1812                          "  {}\n"
1813                          "}");
1814   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1815   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
1816   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
1817   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
1818   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
1819 }
1820 
1821 } // namespace
1822 } // namespace format
1823 } // namespace clang
1824