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