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