xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision cef9f40cd4feb395e1993f086619abd9ed016a17)
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 
758 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
759   struct {
760     const char *Text;
761     tok::TokenKind Kind;
762   } Operators[] = {{"+", tok::plus},
763                    {"-", tok::minus},
764                    // FIXME:
765                    // {"*", tok::star},
766                    {"/", tok::slash},
767                    {"%", tok::percent},
768                    {"^", tok::caret},
769                    // FIXME:
770                    // {"&", tok::amp},
771                    {"|", tok::pipe},
772                    {"~", tok::tilde},
773                    {"!", tok::exclaim},
774                    {"=", tok::equal},
775                    // FIXME:
776                    // {"<", tok::less},
777                    {">", tok::greater},
778                    {"+=", tok::plusequal},
779                    {"-=", tok::minusequal},
780                    {"*=", tok::starequal},
781                    {"/=", tok::slashequal},
782                    {"%=", tok::percentequal},
783                    {"^=", tok::caretequal},
784                    {"&=", tok::ampequal},
785                    {"|=", tok::pipeequal},
786                    {"<<", tok::lessless},
787                    {">>", tok::greatergreater},
788                    {">>=", tok::greatergreaterequal},
789                    {"<<=", tok::lesslessequal},
790                    {"==", tok::equalequal},
791                    {"!=", tok::exclaimequal},
792                    {"<=", tok::lessequal},
793                    {">=", tok::greaterequal},
794                    {"<=>", tok::spaceship},
795                    {"&&", tok::ampamp},
796                    {"||", tok::pipepipe},
797                    {"++", tok::plusplus},
798                    {"--", tok::minusminus},
799                    {",", tok::comma},
800                    {"->*", tok::arrowstar},
801                    {"->", tok::arrow}};
802 
803   for (const auto &Operator : Operators) {
804     std::string Input("C<&operator");
805     Input += Operator.Text;
806     Input += " > a;";
807     auto Tokens = annotate(std::string(Input));
808     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
809     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
810     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
811     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
812   }
813 
814   auto Tokens = annotate("C<&operator< <X>> lt;");
815   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
816   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
817   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
818   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
819   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
820   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
821 }
822 
823 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
824   auto Tokens = annotate("template <typename T>\n"
825                          "concept C = (Foo && Bar) && (Bar && Baz);");
826 
827   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
828   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
829   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
830   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
831 
832   Tokens = annotate("template <typename T>\n"
833                     "concept C = Foo && !Bar;");
834 
835   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
836   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
837   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
838 
839   Tokens = annotate("template <typename T>\n"
840                     "concept C = requires(T t) {\n"
841                     "  { t.foo() };\n"
842                     "} && Bar<T> && Baz<T>;");
843   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
844   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
845   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
846   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
847   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
848   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
849 
850   Tokens = annotate("template<typename T>\n"
851                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
852                     "struct Foo;");
853   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
854   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
855   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
856   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
857   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
858   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
859   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
860   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
861   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
862   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
863   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
864 
865   Tokens =
866       annotate("template<typename T>\n"
867                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
868                "struct Foo;");
869   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
870   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
871   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
872   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
873   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
874   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
875   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
876   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
877   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
878   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
879   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
880   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
881 
882   Tokens = annotate("template <typename T>\n"
883                     "void foo(T) noexcept requires Bar<T>;");
884   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
885   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
886 
887   Tokens = annotate("template <typename T>\n"
888                     "requires Bar<T> || Baz<T>\n"
889                     "auto foo(T) -> int;");
890   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
891   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
892   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
893   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
894   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
895 
896   Tokens = annotate("template <typename T>\n"
897                     "requires Bar<T>\n"
898                     "bool foo(T) { return false; }");
899   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
900   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
901   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
902   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
903 
904   Tokens = annotate("template <typename T>\n"
905                     "requires Bar<T>\n"
906                     "decltype(auto) foo(T) { return false; }");
907   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
908   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
909   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
910   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
911 
912   Tokens = annotate("template <typename T>\n"
913                     "struct S {\n"
914                     "  void foo() const requires Bar<T>;\n"
915                     "  void bar() const & requires Baz<T>;\n"
916                     "  void bar() && requires Baz2<T>;\n"
917                     "  void baz() const & noexcept requires Baz<T>;\n"
918                     "  void baz() && noexcept requires Baz2<T>;\n"
919                     "};\n"
920                     "\n"
921                     "void S::bar() const & requires Baz<T> { }");
922   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
923   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
924   EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference);
925   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
926   EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference);
927   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
928   EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference);
929   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
930   EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference);
931   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
932   EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference);
933   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
934 
935   Tokens = annotate("void Class::member() && requires(Constant) {}");
936   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
937   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
938 
939   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
940   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
941   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
942 
943   Tokens =
944       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
945   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
946   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
947 
948   Tokens = annotate("void Class::member() && requires(typename "
949                     "Namespace::Outer<T>::Inner::Constant) {}");
950   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
951   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
952 
953   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
954                     "  template<class T>\n"
955                     "    requires requires { number_zero_v<T>; }\n"
956                     "  [[nodiscard]] constexpr operator T() const { "
957                     "return number_zero_v<T>; }\n"
958                     "};");
959   ASSERT_EQ(Tokens.size(), 44u) << Tokens;
960   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
961   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
962   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
963   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
964   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
965   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
966 
967   Tokens =
968       annotate("template <class A, class B> concept C ="
969                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
970   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
971   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
972   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
973   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
974   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
975   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
976   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
977   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
978 
979   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
980   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
981   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
982 
983   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
984   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
985   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
986 
987   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
988   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
989   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
990 
991   Tokens =
992       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
993   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
994   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
995 
996   Tokens =
997       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
998   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
999   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1000 
1001   Tokens =
1002       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
1003   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1004   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
1005 
1006   Tokens = annotate("void foo() requires((A<T>) && C) {}");
1007   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1008   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1009   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_BinaryOperator);
1010 
1011   Tokens = annotate("void foo() requires(((A<T>) && C)) {}");
1012   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1013   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1014   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
1015 
1016   Tokens = annotate("void foo() requires([](T&&){}(t)) {}");
1017   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1018   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1019   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1020 
1021   Tokens = annotate("void foo() requires([](T&& u){}(t)) {}");
1022   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
1023   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1024   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1025 }
1026 
1027 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
1028   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
1029   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1030   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1031   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1032   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1033 
1034   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
1035   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1036   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1037   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1038   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
1039 
1040   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
1041   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1042   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
1043   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
1044   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
1045 
1046   Tokens = annotate("foo(requires(const T t) {});");
1047   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1048   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1049   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1050   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1051 
1052   Tokens = annotate("foo(requires(const int t) {});");
1053   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1054   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1055   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1056   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1057 
1058   Tokens = annotate("foo(requires(const T t) {});");
1059   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1060   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1061   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1062   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1063 
1064   Tokens = annotate("foo(requires(int const* volatile t) {});");
1065   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1066   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1067   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1068   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1069   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1070 
1071   Tokens = annotate("foo(requires(T const* volatile t) {});");
1072   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1073   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1074   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1075   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1076   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1077 
1078   Tokens = annotate("foo(requires(T& t) {});");
1079   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1080   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1081   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1082   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
1083   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1084 
1085   Tokens = annotate("foo(requires(T&& t) {});");
1086   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1087   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1088   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1089   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
1090   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1091 
1092   Tokens = annotate("bool foo = requires(T& t) {};");
1093   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1094   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1095   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1096   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1097   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1098 
1099   Tokens = annotate("bool foo = requires(T&& t) {};");
1100   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1101   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1102   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1103   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
1104   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1105 
1106   Tokens =
1107       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
1108   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1109   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1110   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1111   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
1112   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
1113 
1114   Tokens = annotate("template <typename T>\n"
1115                     "concept C = requires(T T) {\n"
1116                     "  requires Bar<T> && Foo<T>;\n"
1117                     "};");
1118   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
1119   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1120   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1121   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1122   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
1123                TT_RequiresClauseInARequiresExpression);
1124 
1125   Tokens = annotate("template <typename T>\n"
1126                     "concept C = requires(T T) {\n"
1127                     "  { t.func() } -> std::same_as<int>;"
1128                     "  requires Bar<T> && Foo<T>;\n"
1129                     "};");
1130   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
1131   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1132   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1133   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1134   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
1135                TT_RequiresClauseInARequiresExpression);
1136 
1137   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
1138   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
1139                     "requires true; };");
1140   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1141   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1142   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1143   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
1144 }
1145 
1146 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
1147   // Everything after #pragma region should be ImplicitStringLiteral
1148   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
1149   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1150   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
1151   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
1152   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
1153 
1154   // Make sure it's annotated correctly inside a function as well
1155   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
1156   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1157   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
1158   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
1159   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
1160 }
1161 
1162 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
1163   const char *BaseCode = nullptr;
1164   const char *ConstrainedCode = nullptr;
1165   auto BaseTokenCount = 0u;
1166   auto RequiresTokenCount = 0u;
1167   auto PrefixTokenCount = 0u;
1168 
1169   auto TestRequires = [&](int Line) {
1170     const auto BaseTokens = annotate(BaseCode);
1171     const auto ConstrainedTokens = annotate(ConstrainedCode);
1172 
1173 #define LINE " (Line " << Line << ')'
1174 
1175     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
1176     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
1177         << LINE;
1178 
1179     for (auto I = 0u; I < BaseTokenCount; ++I) {
1180       EXPECT_EQ(
1181           *BaseTokens[I],
1182           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
1183           << I << LINE;
1184     }
1185 
1186 #undef LINE
1187   };
1188 
1189   BaseCode = "template<typename T>\n"
1190              "T Pi = 3.14;";
1191   ConstrainedCode = "template<typename T>\n"
1192                     "  requires Foo<T>\n"
1193                     "T Pi = 3.14;";
1194   BaseTokenCount = 11;
1195   RequiresTokenCount = 5;
1196   PrefixTokenCount = 5;
1197   TestRequires(__LINE__);
1198 
1199   BaseCode = "template<typename T>\n"
1200              "struct Bar;";
1201   ConstrainedCode = "template<typename T>\n"
1202                     "  requires Foo<T>\n"
1203                     "struct Bar;";
1204   BaseTokenCount = 9;
1205   TestRequires(__LINE__);
1206 
1207   BaseCode = "template<typename T>\n"
1208              "struct Bar {\n"
1209              "  T foo();\n"
1210              "  T bar();\n"
1211              "};";
1212   ConstrainedCode = "template<typename T>\n"
1213                     "  requires Foo<T>\n"
1214                     "struct Bar {\n"
1215                     "  T foo();\n"
1216                     "  T bar();\n"
1217                     "};";
1218   BaseTokenCount = 21;
1219   TestRequires(__LINE__);
1220 
1221   BaseCode = "template<typename T>\n"
1222              "Bar(T) -> Bar<T>;";
1223   ConstrainedCode = "template<typename T>\n"
1224                     "  requires Foo<T>\n"
1225                     "Bar(T) -> Bar<T>;";
1226   BaseTokenCount = 16;
1227   TestRequires(__LINE__);
1228 
1229   BaseCode = "template<typename T>\n"
1230              "T foo();";
1231   ConstrainedCode = "template<typename T>\n"
1232                     "  requires Foo<T>\n"
1233                     "T foo();";
1234   BaseTokenCount = 11;
1235   TestRequires(__LINE__);
1236 
1237   BaseCode = "template<typename T>\n"
1238              "T foo() {\n"
1239              "  auto bar = baz();\n"
1240              "  return bar + T{};\n"
1241              "}";
1242   ConstrainedCode = "template<typename T>\n"
1243                     "  requires Foo<T>\n"
1244                     "T foo() {\n"
1245                     "  auto bar = baz();\n"
1246                     "  return bar + T{};\n"
1247                     "}";
1248   BaseTokenCount = 26;
1249   TestRequires(__LINE__);
1250 
1251   BaseCode = "template<typename T>\n"
1252              "T foo();";
1253   ConstrainedCode = "template<typename T>\n"
1254                     "T foo() requires Foo<T>;";
1255   BaseTokenCount = 11;
1256   PrefixTokenCount = 9;
1257   TestRequires(__LINE__);
1258 
1259   BaseCode = "template<typename T>\n"
1260              "T foo() {\n"
1261              "  auto bar = baz();\n"
1262              "  return bar + T{};\n"
1263              "}";
1264   ConstrainedCode = "template<typename T>\n"
1265                     "T foo() requires Foo<T> {\n"
1266                     "  auto bar = baz();\n"
1267                     "  return bar + T{};\n"
1268                     "}";
1269   BaseTokenCount = 26;
1270   TestRequires(__LINE__);
1271 
1272   BaseCode = "template<typename T>\n"
1273              "T foo();";
1274   ConstrainedCode = "template<typename T>\n"
1275                     "  requires(Foo<T>)\n"
1276                     "T foo();";
1277   BaseTokenCount = 11;
1278   RequiresTokenCount = 7;
1279   PrefixTokenCount = 5;
1280   TestRequires(__LINE__);
1281 
1282   BaseCode = "template<typename T>\n"
1283              "Bar(T) -> Bar<typename T::I>;";
1284   ConstrainedCode = "template<typename T>\n"
1285                     "  requires requires(T &&t) {\n"
1286                     "             typename T::I;\n"
1287                     "           }\n"
1288                     "Bar(T) -> Bar<typename T::I>;";
1289   BaseTokenCount = 19;
1290   RequiresTokenCount = 14;
1291   PrefixTokenCount = 5;
1292   TestRequires(__LINE__);
1293 
1294   BaseCode = "struct [[nodiscard]] zero_t {\n"
1295              "  template<class T>\n"
1296              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1297              "};";
1298   ConstrainedCode =
1299       "struct [[nodiscard]] zero_t {\n"
1300       "  template<class T>\n"
1301       "    requires requires { v<T>; }\n"
1302       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1303       "};";
1304   BaseTokenCount = 35;
1305   RequiresTokenCount = 9;
1306   PrefixTokenCount = 13;
1307   TestRequires(__LINE__);
1308 
1309   BaseCode = "constexpr Foo(Foo const &other)\n"
1310              "    : value{other.value} {\n"
1311              "  do_magic();\n"
1312              "  do_more_magic();\n"
1313              "}";
1314   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1315                     "  requires std::is_copy_constructible<T>\n"
1316                     "    : value{other.value} {\n"
1317                     "  do_magic();\n"
1318                     "  do_more_magic();\n"
1319                     "}";
1320   BaseTokenCount = 26;
1321   RequiresTokenCount = 7;
1322   PrefixTokenCount = 8;
1323   TestRequires(__LINE__);
1324 
1325   BaseCode = "constexpr Foo(Foo const &other)\n"
1326              "    : value{other.value} {\n"
1327              "  do_magic();\n"
1328              "  do_more_magic();\n"
1329              "}";
1330   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1331                     "  requires (std::is_copy_constructible<T>)\n"
1332                     "    : value{other.value} {\n"
1333                     "  do_magic();\n"
1334                     "  do_more_magic();\n"
1335                     "}";
1336   RequiresTokenCount = 9;
1337   TestRequires(__LINE__);
1338 }
1339 
1340 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1341   auto Tokens = annotate("__asm{\n"
1342                          "a:\n"
1343                          "};");
1344   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1345   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1346   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1347   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
1348 }
1349 
1350 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1351   auto Tokens = annotate("int (^)() = ^ ()\n"
1352                          "  external_source_symbol() { //\n"
1353                          "  return 1;\n"
1354                          "};");
1355   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1356   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1357   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1358 
1359   Tokens = annotate("int *p = ^int*(){ //\n"
1360                     "  return nullptr;\n"
1361                     "}();");
1362   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1363   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1364 }
1365 
1366 TEST_F(TokenAnnotatorTest, UnderstandsObjCMethodExpr) {
1367   auto Tokens = annotate("void f() {\n"
1368                          "  //\n"
1369                          "  BOOL a = [b.c n] > 1;\n"
1370                          "}");
1371   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
1372   EXPECT_TOKEN(Tokens[9], tok::l_square, TT_ObjCMethodExpr);
1373   EXPECT_TOKEN(Tokens[15], tok::greater, TT_BinaryOperator);
1374 }
1375 
1376 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1377   auto Tokens = annotate("[]() constexpr {}");
1378   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1379   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1380   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1381 
1382   Tokens = annotate("[]() consteval {}");
1383   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1384   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1385   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1386 
1387   Tokens = annotate("[]() mutable {}");
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("[]() static {}");
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("[]() -> auto {}");
1398   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1399   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1400   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1401   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1402 
1403   Tokens = annotate("[]() -> auto & {}");
1404   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1405   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1406   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1407   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1408 
1409   Tokens = annotate("[]() -> auto * {}");
1410   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1411   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1412   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1413   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1414 
1415   Tokens = annotate("[] {}");
1416   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1417   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1418   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1419 
1420   Tokens = annotate("[] noexcept {}");
1421   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1422   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1423   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1424 
1425   Tokens = annotate("[] -> auto {}");
1426   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1427   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1428   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_LambdaArrow);
1429   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1430 
1431   Tokens = annotate("[] <typename T> () {}");
1432   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1433   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1434   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1435   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1436 
1437   Tokens = annotate("[] <typename T> {}");
1438   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1439   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1440   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1441   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1442 
1443   Tokens = annotate("[] <typename... T> () {}");
1444   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1445   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1446   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1447   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1448 
1449   Tokens = annotate("[] <typename... T> {}");
1450   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1451   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1452   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1453   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1454 
1455   Tokens = annotate("[] <int... T> () {}");
1456   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1457   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1458   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1459   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1460 
1461   Tokens = annotate("[] <int... T> {}");
1462   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1463   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1464   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1465   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1466 
1467   Tokens = annotate("[] <Foo... T> () {}");
1468   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1469   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1470   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1471   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1472 
1473   Tokens = annotate("[] <Foo... T> {}");
1474   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1475   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1476   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1477   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1478 
1479   // Lambdas with a requires-clause
1480   Tokens = annotate("[] <typename T> (T t) requires Bar<T> {}");
1481   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1482   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1483   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1484   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1485   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1486   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1487 
1488   Tokens = annotate("[] <typename T> (T &&t) requires Bar<T> {}");
1489   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1490   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1491   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1492   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_PointerOrReference);
1493   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1494   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1495   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1496 
1497   Tokens = annotate("[] <typename T> (T t) requires Foo<T> || Bar<T> {}");
1498   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1499   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1500   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1501   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1502   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1503   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1504 
1505   Tokens = annotate("[] <typename T> (T t) -> T requires Bar<T> {}");
1506   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1507   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1508   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1509   EXPECT_TOKEN(Tokens[10], tok::arrow, TT_LambdaArrow);
1510   EXPECT_TOKEN(Tokens[12], tok::kw_requires, TT_RequiresClause);
1511   EXPECT_TRUE(Tokens[16]->ClosesRequiresClause);
1512   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1513 
1514   Tokens = annotate("[] <typename T> requires Bar<T> (T t) {}");
1515   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1516   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1517   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1518   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1519   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1520   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1521 
1522   Tokens = annotate("[] <typename T> requires Bar<T> (T &&t) {}");
1523   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1524   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1525   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1526   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1527   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1528   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_PointerOrReference);
1529   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1530 
1531   Tokens = annotate("[] <typename T> requires Foo<T> || Bar<T> (T t) {}");
1532   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1533   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1534   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1535   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1536   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1537   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1538 
1539   Tokens = annotate("[] <typename T> requires true (T&& t) {}");
1540   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1541   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1542   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1543   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1544   EXPECT_TRUE(Tokens[7]->ClosesRequiresClause);
1545   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1546   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1547 
1548   Tokens = annotate("[] <typename T> requires Bar<T> {}");
1549   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1550   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1551   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1552   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1553   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1554   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_LambdaLBrace);
1555 
1556   Tokens = annotate("[] <typename T> requires Bar<T> noexcept {}");
1557   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1558   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1559   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1560   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1561   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1562   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1563 
1564   Tokens = annotate("[] <typename T> requires Bar<T> -> T {}");
1565   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1566   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1567   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1568   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1569   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1570   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_LambdaArrow);
1571   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1572 
1573   Tokens = annotate("[] <typename T> requires Foo<T> (T t) requires Bar<T> {}");
1574   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1575   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1576   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1577   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1578   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1579   EXPECT_TOKEN(Tokens[15], tok::kw_requires, TT_RequiresClause);
1580   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1581   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1582 }
1583 
1584 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1585   auto Tokens = annotate("template <typename T>\n"
1586                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1587                          "string OldFunction(const string &parameter) {}");
1588   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1589   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1590 
1591   Tokens = annotate("template <typename T>\n"
1592                     "A(T) noexcept;");
1593   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1594   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1595 }
1596 
1597 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1598   auto Tokens = annotate("void f [[noreturn]] ();");
1599   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1600   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1601 
1602   Tokens = annotate("void f [[noreturn]] () {}");
1603   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1604   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1605 
1606   Tokens = annotate("class Foo { public: Foo(); };");
1607   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1608   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_FunctionDeclarationName);
1609 
1610   Tokens = annotate("class Foo { public: ~Foo(); };");
1611   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1612   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_FunctionDeclarationName);
1613 
1614   Tokens = annotate("struct Foo { [[deprecated]] Foo() {} };");
1615   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1616   EXPECT_TOKEN(Tokens[8], tok::identifier, TT_FunctionDeclarationName);
1617   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1618 
1619   Tokens = annotate("struct Foo { [[deprecated]] ~Foo() {} };");
1620   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1621   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_FunctionDeclarationName);
1622   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1623 
1624   Tokens = annotate("struct Foo { Foo() [[deprecated]] {} };");
1625   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1626   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_FunctionDeclarationName);
1627   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1628 
1629   Tokens = annotate("struct Foo { ~Foo() [[deprecated]] {} };");
1630   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1631   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_FunctionDeclarationName);
1632   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1633 
1634   Tokens = annotate("struct Foo { [[deprecated]] explicit Foo() {} };");
1635   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1636   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_FunctionDeclarationName);
1637   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1638 
1639   Tokens = annotate("struct Foo { virtual [[deprecated]] ~Foo() {} };");
1640   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1641   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_FunctionDeclarationName);
1642   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1643 
1644   Tokens = annotate("Foo::Foo() {}");
1645   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1646   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_FunctionDeclarationName);
1647   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
1648 
1649   Tokens = annotate("Foo::~Foo() {}");
1650   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1651   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_FunctionDeclarationName);
1652   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
1653 
1654   Tokens = annotate("#define FOO Foo::\n"
1655                     "FOO Foo();");
1656   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1657   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_FunctionDeclarationName);
1658 
1659   Tokens = annotate("struct Foo {\n"
1660                     "  Bar (*func)();\n"
1661                     "};");
1662   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1663   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
1664   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_FunctionTypeLParen);
1665 }
1666 
1667 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1668   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1669   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1670   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1671   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1672   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1673 }
1674 
1675 TEST_F(TokenAnnotatorTest, UnderstandsTrailingReturnArrow) {
1676   auto Tokens = annotate("auto f() -> int;");
1677   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1678   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1679 
1680   Tokens = annotate("auto operator->() -> int;");
1681   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1682   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_OverloadedOperator);
1683   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1684 
1685   Tokens = annotate("auto operator++(int) -> int;");
1686   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1687   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1688 
1689   Tokens = annotate("auto operator=() -> int;");
1690   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1691   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1692 
1693   Tokens = annotate("auto operator=(int) -> int;");
1694   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1695   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1696 
1697   Tokens = annotate("auto foo() -> auto { return Val; }");
1698   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1699   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1700 
1701   Tokens = annotate("struct S { auto bar() const -> int; };");
1702   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1703   EXPECT_TOKEN(Tokens[8], tok::arrow, TT_TrailingReturnArrow);
1704 
1705   // Not trailing return arrows
1706   Tokens = annotate("auto a = b->c;");
1707   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1708   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1709 
1710   Tokens = annotate("auto a = (b)->c;");
1711   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1712   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1713 
1714   Tokens = annotate("auto a = b()->c;");
1715   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1716   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1717 
1718   Tokens = annotate("auto a = b->c();");
1719   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1720   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1721 
1722   Tokens = annotate("decltype(auto) a = b()->c;");
1723   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1724   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1725 
1726   Tokens = annotate("void f() { auto a = b->c(); }");
1727   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1728   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1729 
1730   Tokens = annotate("void f() { auto a = b()->c; }");
1731   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1732   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_Unknown);
1733 
1734   // Mixed
1735   Tokens = annotate("auto f() -> int { auto a = b()->c; }");
1736   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1737   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1738   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
1739 }
1740 
1741 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
1742   auto Annotate = [this](llvm::StringRef Code) {
1743     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
1744   };
1745   // Test that unary operators get labeled as such and that operators like '++'
1746   // don't get split.
1747   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
1748                             tok::tilde, tok::amp,      tok::pipe,
1749                             tok::caret, tok::plusplus, tok::minusminus};
1750   for (auto Kind : Unary) {
1751     auto Tokens =
1752         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
1753     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1754     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
1755   }
1756   // Operators formed by joining two operators like '^~'. For some of these
1757   // joined operators, we don't have a separate type, so we only test for their
1758   // precedence.
1759   std::pair<prec::Level, std::string> JoinedBinary[] = {
1760       {prec::Comma, "<->"},       {prec::Assignment, "+="},
1761       {prec::Assignment, "-="},   {prec::Assignment, "*="},
1762       {prec::Assignment, "/="},   {prec::Assignment, "%="},
1763       {prec::Assignment, "&="},   {prec::Assignment, "^="},
1764       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
1765       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
1766       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
1767       {prec::Equality, "=="},     {prec::Equality, "!="},
1768       {prec::Equality, "==="},    {prec::Equality, "!=="},
1769       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
1770       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
1771   };
1772   for (auto Operator : JoinedBinary) {
1773     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
1774     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1775     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
1776     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
1777   }
1778   // '~^' and '^~' can be unary as well as binary operators.
1779   auto Tokens = Annotate("x = ~^x;");
1780   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1781   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1782   Tokens = Annotate("x = ^~x;");
1783   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1784   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1785   // The unary operators '~&' and '~|' can only be unary operators. The current
1786   // implementation treats each of them as separate unary '~' and '&' or '|'
1787   // operators, which is enough for formatting purposes. In FormatTestVerilog,
1788   // there is a test that there is no space in between. And even if a new line
1789   // is inserted between the '~' and '|', the semantic meaning is the same as
1790   // the joined operator, so the CanBreakBefore property doesn't need to be
1791   // false for the second operator.
1792   Tokens = Annotate("x = ~&x;");
1793   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1794   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1795   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
1796   Tokens = Annotate("x = ~|x;");
1797   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1798   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1799   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
1800   // Test for block label colons.
1801   Tokens = Annotate("begin : x\n"
1802                     "end : x");
1803   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1804   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
1805   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
1806   // Test that the dimension colon is annotated correctly.
1807   Tokens = Annotate("var [1 : 0] x;");
1808   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1809   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
1810   Tokens = Annotate("extern function [1 : 0] x;");
1811   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1812   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
1813   Tokens = Annotate("module test\n"
1814                     "    (input wire [7 : 0] a[7 : 0]);\n"
1815                     "endmodule");
1816   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1817   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_VerilogDimensionedTypeName);
1818   EXPECT_TOKEN(Tokens[7], tok::colon, TT_BitFieldColon);
1819   EXPECT_TOKEN(Tokens[13], tok::colon, TT_BitFieldColon);
1820   // Test case labels and ternary operators.
1821   Tokens = Annotate("case (x)\n"
1822                     "  x:\n"
1823                     "    x;\n"
1824                     "endcase\n");
1825   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1826   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CaseLabelColon);
1827   Tokens = Annotate("case (x)\n"
1828                     "  x ? x : x:\n"
1829                     "    x;\n"
1830                     "endcase\n");
1831   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1832   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
1833   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
1834   EXPECT_TOKEN(Tokens[9], tok::colon, TT_CaseLabelColon);
1835   // Non-blocking assignments.
1836   Tokens = Annotate("a <= b;");
1837   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1838   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1839   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1840   Tokens = Annotate("if (a <= b) break;");
1841   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1842   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1843   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1844   Tokens = Annotate("a <= b <= a;");
1845   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1846   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1847   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1848   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1849   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1850 
1851   // Port lists in module instantiation.
1852   Tokens = Annotate("module_x instance_1(port_1), instance_2(port_2);");
1853   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1854   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
1855   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_VerilogInstancePortLParen);
1856   Tokens = Annotate("module_x #(parameter) instance_1(port_1), "
1857                     "instance_2(port_2);");
1858   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1859   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
1860   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_VerilogInstancePortLParen);
1861   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_VerilogInstancePortLParen);
1862 
1863   // Condition parentheses.
1864   Tokens = Annotate("assert (x);");
1865   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1866   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1867   Tokens = Annotate("assert #0 (x);");
1868   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1869   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_ConditionLParen);
1870   Tokens = Annotate("assert final (x);");
1871   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1872   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
1873   Tokens = Annotate("foreach (x[x]) continue;");
1874   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1875   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1876   Tokens = Annotate("repeat (x[x]) continue;");
1877   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1878   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1879   Tokens = Annotate("case (x) endcase;");
1880   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1881   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1882 
1883   // Sensitivity list. The TT_Unknown type is clearly not binding for the
1884   // future, please adapt if those tokens get annotated.  This test is only here
1885   // to prevent the comma from being annotated as TT_VerilogInstancePortComma.
1886   Tokens = Annotate("always @(posedge x, posedge y);");
1887   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1888   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_Unknown);
1889   EXPECT_TOKEN(Tokens[5], tok::comma, TT_Unknown);
1890   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1891 
1892   // String literals in concatenation.
1893   Tokens = Annotate("x = {\"\"};");
1894   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1895   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
1896   Tokens = Annotate("x = {\"\", \"\"};");
1897   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1898   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
1899   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
1900   Tokens = Annotate("x = '{{\"\"}};");
1901   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1902   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
1903   // Cases where the string should not be annotated that type.  Fix the
1904   // `TT_Unknown` if needed in the future.
1905   Tokens = Annotate("x = {\"\" == \"\"};");
1906   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1907   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_Unknown);
1908   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_Unknown);
1909   Tokens = Annotate("x = {(\"\")};");
1910   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1911   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
1912   Tokens = Annotate("x = '{\"\"};");
1913   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1914   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
1915 }
1916 
1917 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
1918   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
1919 
1920   // The TT_Unknown is clearly not binding for the future, please adapt if those
1921   // tokens get annotated.
1922   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1923   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1924   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1925   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
1926   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1927   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1928   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1929   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
1930   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
1931   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1932 
1933   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
1934   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1935   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1936   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1937   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
1938   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
1939   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1940   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1941   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
1942   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
1943   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1944 }
1945 
1946 TEST_F(TokenAnnotatorTest, UnderstandsConditionParens) {
1947   auto Tokens = annotate("if (x) {}");
1948   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1949   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1950   Tokens = annotate("if constexpr (x) {}");
1951   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1952   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
1953   Tokens = annotate("if CONSTEXPR (x) {}");
1954   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1955   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
1956   Tokens = annotate("if (x) {} else if (x) {}");
1957   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1958   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
1959   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_ConditionLParen);
1960 }
1961 
1962 TEST_F(TokenAnnotatorTest, CSharpNullableTypes) {
1963   FormatStyle Style = getGoogleStyle(FormatStyle::LK_CSharp);
1964 
1965   auto Tokens = annotate("int? a;", Style);
1966   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
1967   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1968 
1969   Tokens = annotate("int? a = 1;", Style);
1970   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
1971   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1972 
1973   Tokens = annotate("int?)", Style);
1974   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
1975   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1976 
1977   Tokens = annotate("int?>", Style);
1978   EXPECT_EQ(Tokens.size(), 4u) << Tokens;
1979   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
1980 
1981   Tokens = annotate("cond? id : id2", Style);
1982   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
1983   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
1984 
1985   Tokens = annotate("cond ? cond2 ? : id1 : id2", Style);
1986   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
1987   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
1988 }
1989 
1990 TEST_F(TokenAnnotatorTest, UnderstandsLabels) {
1991   auto Tokens = annotate("{ x: break; }");
1992   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1993   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
1994   Tokens = annotate("{ case x: break; }");
1995   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1996   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
1997   Tokens = annotate("{ x: { break; } }");
1998   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1999   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2000   Tokens = annotate("{ case x: { break; } }");
2001   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2002   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2003 }
2004 
2005 TEST_F(TokenAnnotatorTest, UnderstandsNestedBlocks) {
2006   // The closing braces are not annotated. It doesn't seem to cause a problem.
2007   // So we only test for the opening braces.
2008   auto Tokens = annotate("{\n"
2009                          "  {\n"
2010                          "    { int a = 0; }\n"
2011                          "  }\n"
2012                          "  {}\n"
2013                          "}");
2014   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2015   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2016   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
2017   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
2018   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2019 }
2020 
2021 TEST_F(TokenAnnotatorTest, UnderstandDesignatedInitializers) {
2022   auto Tokens = annotate("SomeStruct { .a = 1 };");
2023   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2024   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2025   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2026 
2027   Tokens = annotate("SomeStruct { .a = 1, .b = 2 };");
2028   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2029   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2030   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2031   EXPECT_TOKEN(Tokens[7], tok::period, TT_DesignatedInitializerPeriod);
2032 
2033   Tokens = annotate("SomeStruct {\n"
2034                     "#ifdef FOO\n"
2035                     "  .a = 1,\n"
2036                     "#endif\n"
2037                     "  .b = 2\n"
2038                     "};");
2039   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2040   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2041   EXPECT_TOKEN(Tokens[5], tok::period, TT_DesignatedInitializerPeriod);
2042   EXPECT_TOKEN(Tokens[12], tok::period, TT_DesignatedInitializerPeriod);
2043 
2044   Tokens = annotate("SomeStruct {\n"
2045                     "#if defined FOO\n"
2046                     "  .a = 1,\n"
2047                     "#endif\n"
2048                     "  .b = 2\n"
2049                     "};");
2050   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2051   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2052   EXPECT_TOKEN(Tokens[6], tok::period, TT_DesignatedInitializerPeriod);
2053   EXPECT_TOKEN(Tokens[13], tok::period, TT_DesignatedInitializerPeriod);
2054 }
2055 
2056 TEST_F(TokenAnnotatorTest, UnderstandsJavaScript) {
2057   auto Annotate = [this](llvm::StringRef Code) {
2058     return annotate(Code, getLLVMStyle(FormatStyle::LK_JavaScript));
2059   };
2060 
2061   // Dictionary.
2062   auto Tokens = Annotate("var x = {'x' : 1, 'y' : 2};");
2063   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2064   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_DictLiteral);
2065   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_SelectorName);
2066   EXPECT_TOKEN(Tokens[5], tok::colon, TT_DictLiteral);
2067   EXPECT_TOKEN(Tokens[8], tok::string_literal, TT_SelectorName);
2068   EXPECT_TOKEN(Tokens[9], tok::colon, TT_DictLiteral);
2069   // Change when we need to annotate these.
2070   EXPECT_BRACE_KIND(Tokens[3], BK_Unknown);
2071   EXPECT_BRACE_KIND(Tokens[11], BK_Unknown);
2072   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_Unknown);
2073 }
2074 
2075 TEST_F(TokenAnnotatorTest, UnderstandsAttributes) {
2076   auto Tokens = annotate("bool foo __attribute__((unused));");
2077   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2078   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2079   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_Unknown);
2080   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_Unknown);
2081   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_AttributeRParen);
2082 }
2083 
2084 } // namespace
2085 } // namespace format
2086 } // namespace clang
2087