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