xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision 35f2ac1763adcbd5ee9b49a98de24c0c420c323e)
1 //===- unittest/Format/TokenAnnotatorTest.cpp - Formatting unit tests -----===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "clang/Format/Format.h"
10 
11 #include "FormatTestUtils.h"
12 #include "TestLexer.h"
13 #include "gtest/gtest.h"
14 
15 namespace clang {
16 namespace format {
17 
18 // Not really the equality, but everything we need.
19 static bool operator==(const FormatToken &LHS,
20                        const FormatToken &RHS) noexcept {
21   return LHS.Tok.getKind() == RHS.Tok.getKind() &&
22          LHS.getType() == RHS.getType();
23 }
24 
25 namespace {
26 
27 class TokenAnnotatorTest : public ::testing::Test {
28 protected:
29   TokenList annotate(llvm::StringRef Code,
30                      const FormatStyle &Style = getLLVMStyle()) {
31     return TestLexer(Allocator, Buffers, Style).annotate(Code);
32   }
33   llvm::SpecificBumpPtrAllocator<FormatToken> Allocator;
34   std::vector<std::unique_ptr<llvm::MemoryBuffer>> Buffers;
35 };
36 
37 #define EXPECT_TOKEN_KIND(FormatTok, Kind)                                     \
38   EXPECT_EQ((FormatTok)->Tok.getKind(), Kind) << *(FormatTok)
39 #define EXPECT_TOKEN_TYPE(FormatTok, Type)                                     \
40   EXPECT_EQ((FormatTok)->getType(), Type) << *(FormatTok)
41 #define EXPECT_TOKEN_PRECEDENCE(FormatTok, Prec)                               \
42   EXPECT_EQ((FormatTok)->getPrecedence(), Prec) << *(FormatTok)
43 #define EXPECT_TOKEN(FormatTok, Kind, Type)                                    \
44   do {                                                                         \
45     EXPECT_TOKEN_KIND(FormatTok, Kind);                                        \
46     EXPECT_TOKEN_TYPE(FormatTok, Type);                                        \
47   } while (false)
48 
49 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfStarAndAmp) {
50   auto Tokens = annotate("auto x = [](const decltype(x) &ptr) {};");
51   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
52   EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown);
53   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen);
54   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown);
55   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
56   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
57 
58   Tokens = annotate("auto x = [](const decltype(x) *ptr) {};");
59   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
60   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
61   EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference);
62 
63   Tokens = annotate("#define lambda [](const decltype(x) &ptr) {}");
64   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
65   EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown);
66   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen);
67   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown);
68   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
69   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
70 
71   Tokens = annotate("#define lambda [](const decltype(x) *ptr) {}");
72   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
73   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
74   EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference);
75 
76   Tokens = annotate("void f() {\n"
77                     "  while (p < a && *p == 'a')\n"
78                     "    p++;\n"
79                     "}");
80   EXPECT_EQ(Tokens.size(), 21u) << Tokens;
81   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
82   EXPECT_TOKEN(Tokens[11], tok::star, TT_UnaryOperator);
83 
84   Tokens = annotate("case *x:");
85   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
86   EXPECT_TOKEN(Tokens[1], tok::star, TT_UnaryOperator);
87   Tokens = annotate("case &x:");
88   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
89   EXPECT_TOKEN(Tokens[1], tok::amp, TT_UnaryOperator);
90 
91   Tokens = annotate("bool b = 3 == int{3} && true;\n");
92   EXPECT_EQ(Tokens.size(), 13u) << Tokens;
93   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
94 
95   Tokens = annotate("struct {\n"
96                     "} *ptr;");
97   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
98   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
99   Tokens = annotate("union {\n"
100                     "} *ptr;");
101   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
102   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
103   Tokens = annotate("class {\n"
104                     "} *ptr;");
105   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
106   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
107 
108   Tokens = annotate("struct {\n"
109                     "} &&ptr = {};");
110   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
111   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
112   Tokens = annotate("union {\n"
113                     "} &&ptr = {};");
114   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
115   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
116   Tokens = annotate("class {\n"
117                     "} &&ptr = {};");
118   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
119   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
120   Tokens = annotate("int i = int{42} * 2;");
121   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
122   EXPECT_TOKEN(Tokens[7], tok::star, TT_BinaryOperator);
123 
124   Tokens = annotate("delete[] *ptr;");
125   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
126   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
127   Tokens = annotate("delete[] **ptr;");
128   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
129   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
130   EXPECT_TOKEN(Tokens[4], tok::star, TT_UnaryOperator);
131   Tokens = annotate("delete[] *(ptr);");
132   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
133   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
134 
135   Tokens = annotate("void f() { void (*fnptr)(char* foo); }");
136   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
137   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_FunctionTypeLParen);
138   // FIXME: The star of a function pointer probably makes more sense as
139   // TT_PointerOrReference.
140   EXPECT_TOKEN(Tokens[7], tok::star, TT_UnaryOperator);
141   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
142 
143   Tokens = annotate("void f() { void (*fnptr)(t* foo); }");
144   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
145   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_FunctionTypeLParen);
146   EXPECT_TOKEN(Tokens[7], tok::star, TT_UnaryOperator);
147   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
148 
149   Tokens = annotate("if (Foo * Bar / Test)");
150   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
151   EXPECT_TOKEN(Tokens[3], tok::star, TT_BinaryOperator);
152 
153   Tokens = annotate("if (Class* obj {getObj()})");
154   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
155   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
156 
157   Tokens = annotate("if (Foo* Bar = getObj())");
158   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
159   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
160 
161   Tokens = annotate("int f3() { return sizeof(Foo&); }");
162   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
163   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
164 
165   Tokens = annotate("int f4() { return sizeof(Foo&&); }");
166   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
167   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_PointerOrReference);
168 
169   Tokens = annotate("void f5() { int f6(Foo&, Bar&); }");
170   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
171   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
172   EXPECT_TOKEN(Tokens[12], tok::amp, TT_PointerOrReference);
173 
174   Tokens = annotate("void f7() { int f8(Foo&&, Bar&&); }");
175   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
176   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_PointerOrReference);
177   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_PointerOrReference);
178 
179   Tokens = annotate("Type1 &val1 = val2;");
180   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
181   EXPECT_TOKEN(Tokens[1], tok::amp, TT_PointerOrReference);
182 
183   Tokens = annotate("Type1 *val1 = &val2;");
184   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
185   EXPECT_TOKEN(Tokens[1], tok::star, TT_PointerOrReference);
186   EXPECT_TOKEN(Tokens[4], tok::amp, TT_UnaryOperator);
187 
188   Tokens = annotate("val1 & val2;");
189   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
190   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
191 
192   Tokens = annotate("val1 & val2.member;");
193   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
194   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
195 
196   Tokens = annotate("val1 & val2.*member;");
197   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
198   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
199 
200   Tokens = annotate("val1.*member & val2;");
201   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
202   EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator);
203 
204   Tokens = annotate("val1 & val2->*member;");
205   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
206   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
207 
208   Tokens = annotate("val1->member & val2;");
209   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
210   EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator);
211 
212   Tokens = annotate("val1 & val2 & val3;");
213   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
214   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
215   EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator);
216 
217   Tokens = annotate("val1 & val2 // comment\n"
218                     "     & val3;");
219   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
220   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
221   EXPECT_TOKEN(Tokens[4], tok::amp, TT_BinaryOperator);
222 
223   Tokens =
224       annotate("val1 & val2.member & val3.member() & val4 & val5->member;");
225   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
226   EXPECT_TOKEN(Tokens[1], tok::amp, TT_BinaryOperator);
227   EXPECT_TOKEN(Tokens[5], tok::amp, TT_BinaryOperator);
228   EXPECT_TOKEN(Tokens[11], tok::amp, TT_BinaryOperator);
229   EXPECT_TOKEN(Tokens[13], tok::amp, TT_BinaryOperator);
230 
231   Tokens = annotate("class c {\n"
232                     "  void func(type &a) { a & member; }\n"
233                     "  anotherType &member;\n"
234                     "}");
235   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
236   EXPECT_TOKEN(Tokens[7], tok::amp, TT_PointerOrReference);
237   EXPECT_TOKEN(Tokens[12], tok::amp, TT_BinaryOperator);
238   EXPECT_TOKEN(Tokens[17], tok::amp, TT_PointerOrReference);
239 
240   Tokens = annotate("struct S {\n"
241                     "  auto Mem = C & D;\n"
242                     "}");
243   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
244   EXPECT_TOKEN(Tokens[7], tok::amp, TT_BinaryOperator);
245 }
246 
247 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) {
248   auto Tokens = annotate("x - 0");
249   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
250   EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator);
251   Tokens = annotate("0 + 0");
252   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
253   EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator);
254   Tokens = annotate("x + +0");
255   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
256   EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator);
257   Tokens = annotate("x ? -0 : +0");
258   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
259   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
260   EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator);
261   Tokens = annotate("(-0)");
262   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
263   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
264   Tokens = annotate("0, -0");
265   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
266   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
267   Tokens = annotate("for (; -1;) {\n}");
268   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
269   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
270   Tokens = annotate("x = -1;");
271   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
272   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
273   Tokens = annotate("x[-1]");
274   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
275   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
276   Tokens = annotate("x = {-1};");
277   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
278   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
279   Tokens = annotate("case -x:");
280   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
281   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
282   Tokens = annotate("co_await -x;");
283   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
284   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
285   Tokens = annotate("co_return -x;");
286   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
287   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
288   Tokens = annotate("co_yield -x;");
289   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
290   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
291   Tokens = annotate("delete -x;");
292   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
293   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
294   Tokens = annotate("return -x;");
295   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
296   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
297   Tokens = annotate("throw -x;");
298   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
299   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
300   Tokens = annotate("sizeof -x");
301   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
302   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
303   Tokens = annotate("co_await +x;");
304   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
305   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
306   Tokens = annotate("co_return +x;");
307   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
308   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
309   Tokens = annotate("co_yield +x;");
310   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
311   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
312   Tokens = annotate("delete +x;");
313   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
314   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
315   Tokens = annotate("return +x;");
316   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
317   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
318   Tokens = annotate("throw +x;");
319   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
320   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
321   Tokens = annotate("sizeof +x");
322   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
323   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
324   Tokens = annotate("(int)-x");
325   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
326   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
327   Tokens = annotate("(-x)");
328   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
329   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
330   Tokens = annotate("!+x");
331   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
332   EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator);
333   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
334 }
335 
336 TEST_F(TokenAnnotatorTest, UnderstandsClasses) {
337   auto Tokens = annotate("class C {};");
338   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
339   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
340 
341   Tokens = annotate("const class C {} c;");
342   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
343   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace);
344 
345   Tokens = annotate("const class {} c;");
346   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
347   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
348 }
349 
350 TEST_F(TokenAnnotatorTest, UnderstandsStructs) {
351   auto Tokens = annotate("struct S {};");
352   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
353   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace);
354 }
355 
356 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
357   auto Tokens = annotate("union U {};");
358   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
359   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
360 
361   Tokens = annotate("union U { void f() { return; } };");
362   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
363   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
364   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
365 }
366 
367 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
368   auto Tokens = annotate("enum E {};");
369   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
370   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
371 }
372 
373 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
374   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
375   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
376   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
377 
378   Tokens = annotate("template <typename T> void F(T) && = delete;");
379   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
380   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
381 }
382 
383 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
384   auto Tokens =
385       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
386   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
387   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
388 }
389 
390 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
391   auto Tokens =
392       annotate("template <typename T> "
393                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
394   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
395   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
396 }
397 
398 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) {
399   auto Tokens =
400       annotate("#define FOO(typeName) \\\n"
401                "  { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }");
402   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
403   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
404   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
405   EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener);
406   EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser);
407 }
408 
409 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) {
410   auto Tokens = annotate("if (std::tuple_size_v<T> > 0)");
411   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
412   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
413   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
414   EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator);
415 }
416 
417 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
418   FormatStyle Style = getLLVMStyle();
419   Style.WhitespaceSensitiveMacros.push_back("FOO");
420 
421   auto Tokens = annotate("FOO(1+2 )\n", Style);
422   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
423   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
424 
425   Tokens = annotate("FOO(a:b:c)\n", Style);
426   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
427   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
428 }
429 
430 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
431   auto Tokens = annotate("delete (void *)p;");
432   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
433   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
434 
435   Tokens = annotate("delete[] (void *)p;");
436   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
437   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
438 
439   Tokens = annotate("delete[] /*comment*/ (void *)p;");
440   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
441   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
442 
443   Tokens = annotate("delete[/*comment*/] (void *)p;");
444   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
445   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
446 
447   Tokens = annotate("delete/*comment*/[] (void *)p;");
448   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
449   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
450 }
451 
452 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
453   auto Tokens = annotate("(void)p;");
454   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
455   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
456 
457   Tokens = annotate("auto x = (Foo)p;");
458   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
459   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
460 
461   Tokens = annotate("(std::vector<int>)p;");
462   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
463   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
464 
465   Tokens = annotate("return (Foo)p;");
466   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
467   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
468 
469   Tokens = annotate("throw (Foo)p;");
470   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
471   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
472 }
473 
474 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
475   auto Tokens = annotate("void f() throw(int);");
476   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
477   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
478 }
479 
480 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
481   auto Tokens = annotate("void f() &;");
482   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
483   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
484 
485   Tokens = annotate("void operator=(T) &&;");
486   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
487   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
488 
489   Tokens = annotate("template <typename T> void f() &;");
490   EXPECT_EQ(Tokens.size(), 12u) << Tokens;
491   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
492 
493   Tokens = annotate("template <typename T> void operator=(T) &;");
494   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
495   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
496 }
497 
498 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
499   auto Tokens = annotate("x.operator+()");
500   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
501   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
502   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
503   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
504   Tokens = annotate("x.operator=()");
505   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
506   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
507   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
508   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
509   Tokens = annotate("x.operator+=()");
510   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
511   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
512   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
513   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
514   Tokens = annotate("x.operator,()");
515   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
516   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
517   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
518   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
519   Tokens = annotate("x.operator()()");
520   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
521   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
522   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
523   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
524   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
525   Tokens = annotate("x.operator[]()");
526   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
527   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
528   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
529   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
530   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
531   Tokens = annotate("x.operator\"\"_a()");
532   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
533   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
534   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
535   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
536   Tokens = annotate("x.operator\"\" _a()");
537   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
538   // FIXME
539   // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
540   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
541   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
542   Tokens = annotate("x.operator\"\"if()");
543   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
544   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
545   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
546   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
547   Tokens = annotate("x.operator\"\"s()");
548   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
549   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
550   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
551   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
552   Tokens = annotate("x.operator\"\" s()");
553   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
554   // FIXME
555   // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
556   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
557   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
558 
559   Tokens = annotate("int operator+(int);");
560   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
561   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
562   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
563   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
564   Tokens = annotate("auto operator=(T&) {}");
565   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
566   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
567   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
568   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
569   Tokens = annotate("auto operator()() {}");
570   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
571   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
572   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
573   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
574   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
575 }
576 
577 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
578   auto Tokens = annotate("template <typename T>\n"
579                          "concept C = (Foo && Bar) && (Bar && Baz);");
580 
581   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
582   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
583   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
584   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
585 
586   Tokens = annotate("template <typename T>\n"
587                     "concept C = Foo && !Bar;");
588 
589   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
590   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
591   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
592 
593   Tokens = annotate("template <typename T>\n"
594                     "concept C = requires(T t) {\n"
595                     "  { t.foo() };\n"
596                     "} && Bar<T> && Baz<T>;");
597   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
598   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
599   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
600   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
601   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
602   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
603 
604   Tokens = annotate("template<typename T>\n"
605                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
606                     "struct Foo;");
607   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
608   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
609   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
610   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
611   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
612   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
613   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
614   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
615   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
616   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
617   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
618 
619   Tokens =
620       annotate("template<typename T>\n"
621                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
622                "struct Foo;");
623   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
624   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
625   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
626   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
627   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
628   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
629   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
630   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
631   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
632   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
633   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
634   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
635 
636   Tokens = annotate("template <typename T>\n"
637                     "void foo(T) noexcept requires Bar<T>;");
638   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
639   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
640 
641   Tokens = annotate("template <typename T>\n"
642                     "requires Bar<T> || Baz<T>\n"
643                     "auto foo(T) -> int;");
644   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
645   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
646   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
647   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
648   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
649 
650   Tokens = annotate("template <typename T>\n"
651                     "requires Bar<T>\n"
652                     "bool foo(T) { return false; }");
653   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
654   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
655   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
656   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
657 
658   Tokens = annotate("template <typename T>\n"
659                     "requires Bar<T>\n"
660                     "decltype(auto) foo(T) { return false; }");
661   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
662   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
663   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
664   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
665 
666   Tokens = annotate("template <typename T>\n"
667                     "struct S {\n"
668                     "  void foo() const requires Bar<T>;\n"
669                     "  void bar() const & requires Baz<T>;\n"
670                     "  void bar() && requires Baz2<T>;\n"
671                     "  void baz() const & noexcept requires Baz<T>;\n"
672                     "  void baz() && noexcept requires Baz2<T>;\n"
673                     "};\n"
674                     "\n"
675                     "void S::bar() const & requires Baz<T> { }");
676   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
677   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
678   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
679   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
680   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
681   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
682   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
683 
684   Tokens = annotate("void Class::member() && requires(Constant) {}");
685   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
686   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
687 
688   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
689   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
690   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
691 
692   Tokens =
693       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
694   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
695   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
696 
697   Tokens = annotate("void Class::member() && requires(typename "
698                     "Namespace::Outer<T>::Inner::Constant) {}");
699   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
700   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
701 
702   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
703                     "  template<class T>\n"
704                     "    requires requires { number_zero_v<T>; }\n"
705                     "  [[nodiscard]] constexpr operator T() const { "
706                     "return number_zero_v<T>; }\n"
707                     "};");
708   ASSERT_EQ(Tokens.size(), 44u);
709   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
710   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
711   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
712   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
713   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
714   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
715 
716   Tokens =
717       annotate("template <class A, class B> concept C ="
718                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
719   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
720   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
721   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
722   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
723   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
724   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
725   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
726   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
727 
728   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
729   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
730   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
731 
732   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
733   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
734   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
735 
736   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
737   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
738   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
739 
740   Tokens =
741       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
742   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
743   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
744 
745   Tokens =
746       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
747   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
748   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
749 
750   Tokens =
751       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
752   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
753   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
754 }
755 
756 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
757   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
758   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
759   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
760   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
761   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
762 
763   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
764   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
765   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
766   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
767   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
768 
769   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
770   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
771   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
772   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
773   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
774 
775   Tokens = annotate("foo(requires(const T t) {});");
776   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
777   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
778   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
779   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
780 
781   Tokens = annotate("foo(requires(const int t) {});");
782   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
783   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
784   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
785   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
786 
787   Tokens = annotate("foo(requires(const T t) {});");
788   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
789   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
790   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
791   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
792 
793   Tokens = annotate("foo(requires(int const* volatile t) {});");
794   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
795   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
796   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
797   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
798   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
799 
800   Tokens = annotate("foo(requires(T const* volatile t) {});");
801   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
802   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
803   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
804   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
805   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
806 
807   Tokens = annotate("foo(requires(T& t) {});");
808   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
809   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
810   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
811   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
812   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
813 
814   Tokens = annotate("foo(requires(T&& t) {});");
815   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
816   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
817   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
818   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
819   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
820 
821   Tokens = annotate("bool foo = requires(T& t) {};");
822   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
823   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
824   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
825   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
826   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
827 
828   Tokens = annotate("bool foo = requires(T&& t) {};");
829   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
830   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
831   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
832   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
833   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
834 
835   Tokens =
836       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
837   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
838   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
839   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
840   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
841   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
842 
843   Tokens = annotate("template <typename T>\n"
844                     "concept C = requires(T T) {\n"
845                     "  requires Bar<T> && Foo<T>;\n"
846                     "};");
847   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
848   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
849   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
850   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
851   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
852                TT_RequiresClauseInARequiresExpression);
853 
854   Tokens = annotate("template <typename T>\n"
855                     "concept C = requires(T T) {\n"
856                     "  { t.func() } -> std::same_as<int>;"
857                     "  requires Bar<T> && Foo<T>;\n"
858                     "};");
859   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
860   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
861   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
862   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
863   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
864                TT_RequiresClauseInARequiresExpression);
865 
866   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
867   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
868                     "requires true; };");
869   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
870   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
871   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
872   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
873 }
874 
875 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
876   // Everything after #pragma region should be ImplicitStringLiteral
877   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
878   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
879   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
880   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
881   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
882 
883   // Make sure it's annotated correctly inside a function as well
884   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
885   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
886   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
887   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
888   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
889 }
890 
891 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
892   const char *BaseCode = nullptr;
893   const char *ConstrainedCode = nullptr;
894   auto BaseTokenCount = 0u;
895   auto RequiresTokenCount = 0u;
896   auto PrefixTokenCount = 0u;
897 
898   auto TestRequires = [&](int Line) {
899     const auto BaseTokens = annotate(BaseCode);
900     const auto ConstrainedTokens = annotate(ConstrainedCode);
901 
902 #define LINE " (Line " << Line << ')'
903 
904     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
905     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
906         << LINE;
907 
908     for (auto I = 0u; I < BaseTokenCount; ++I) {
909       EXPECT_EQ(
910           *BaseTokens[I],
911           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
912           << I << LINE;
913     }
914 
915 #undef LINE
916   };
917 
918   BaseCode = "template<typename T>\n"
919              "T Pi = 3.14;";
920   ConstrainedCode = "template<typename T>\n"
921                     "  requires Foo<T>\n"
922                     "T Pi = 3.14;";
923   BaseTokenCount = 11;
924   RequiresTokenCount = 5;
925   PrefixTokenCount = 5;
926   TestRequires(__LINE__);
927 
928   BaseCode = "template<typename T>\n"
929              "struct Bar;";
930   ConstrainedCode = "template<typename T>\n"
931                     "  requires Foo<T>\n"
932                     "struct Bar;";
933   BaseTokenCount = 9;
934   TestRequires(__LINE__);
935 
936   BaseCode = "template<typename T>\n"
937              "struct Bar {\n"
938              "  T foo();\n"
939              "  T bar();\n"
940              "};";
941   ConstrainedCode = "template<typename T>\n"
942                     "  requires Foo<T>\n"
943                     "struct Bar {\n"
944                     "  T foo();\n"
945                     "  T bar();\n"
946                     "};";
947   BaseTokenCount = 21;
948   TestRequires(__LINE__);
949 
950   BaseCode = "template<typename T>\n"
951              "Bar(T) -> Bar<T>;";
952   ConstrainedCode = "template<typename T>\n"
953                     "  requires Foo<T>\n"
954                     "Bar(T) -> Bar<T>;";
955   BaseTokenCount = 16;
956   TestRequires(__LINE__);
957 
958   BaseCode = "template<typename T>\n"
959              "T foo();";
960   ConstrainedCode = "template<typename T>\n"
961                     "  requires Foo<T>\n"
962                     "T foo();";
963   BaseTokenCount = 11;
964   TestRequires(__LINE__);
965 
966   BaseCode = "template<typename T>\n"
967              "T foo() {\n"
968              "  auto bar = baz();\n"
969              "  return bar + T{};\n"
970              "}";
971   ConstrainedCode = "template<typename T>\n"
972                     "  requires Foo<T>\n"
973                     "T foo() {\n"
974                     "  auto bar = baz();\n"
975                     "  return bar + T{};\n"
976                     "}";
977   BaseTokenCount = 26;
978   TestRequires(__LINE__);
979 
980   BaseCode = "template<typename T>\n"
981              "T foo();";
982   ConstrainedCode = "template<typename T>\n"
983                     "T foo() requires Foo<T>;";
984   BaseTokenCount = 11;
985   PrefixTokenCount = 9;
986   TestRequires(__LINE__);
987 
988   BaseCode = "template<typename T>\n"
989              "T foo() {\n"
990              "  auto bar = baz();\n"
991              "  return bar + T{};\n"
992              "}";
993   ConstrainedCode = "template<typename T>\n"
994                     "T foo() requires Foo<T> {\n"
995                     "  auto bar = baz();\n"
996                     "  return bar + T{};\n"
997                     "}";
998   BaseTokenCount = 26;
999   TestRequires(__LINE__);
1000 
1001   BaseCode = "template<typename T>\n"
1002              "T foo();";
1003   ConstrainedCode = "template<typename T>\n"
1004                     "  requires(Foo<T>)\n"
1005                     "T foo();";
1006   BaseTokenCount = 11;
1007   RequiresTokenCount = 7;
1008   PrefixTokenCount = 5;
1009   TestRequires(__LINE__);
1010 
1011   BaseCode = "template<typename T>\n"
1012              "Bar(T) -> Bar<typename T::I>;";
1013   ConstrainedCode = "template<typename T>\n"
1014                     "  requires requires(T &&t) {\n"
1015                     "             typename T::I;\n"
1016                     "           }\n"
1017                     "Bar(T) -> Bar<typename T::I>;";
1018   BaseTokenCount = 19;
1019   RequiresTokenCount = 14;
1020   PrefixTokenCount = 5;
1021   TestRequires(__LINE__);
1022 
1023   BaseCode = "struct [[nodiscard]] zero_t {\n"
1024              "  template<class T>\n"
1025              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1026              "};";
1027   ConstrainedCode =
1028       "struct [[nodiscard]] zero_t {\n"
1029       "  template<class T>\n"
1030       "    requires requires { v<T>; }\n"
1031       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1032       "};";
1033   BaseTokenCount = 35;
1034   RequiresTokenCount = 9;
1035   PrefixTokenCount = 13;
1036   TestRequires(__LINE__);
1037 
1038   BaseCode = "constexpr Foo(Foo const &other)\n"
1039              "    : value{other.value} {\n"
1040              "  do_magic();\n"
1041              "  do_more_magic();\n"
1042              "}";
1043   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1044                     "  requires std::is_copy_constructible<T>\n"
1045                     "    : value{other.value} {\n"
1046                     "  do_magic();\n"
1047                     "  do_more_magic();\n"
1048                     "}";
1049   BaseTokenCount = 26;
1050   RequiresTokenCount = 7;
1051   PrefixTokenCount = 8;
1052   TestRequires(__LINE__);
1053 
1054   BaseCode = "constexpr Foo(Foo const &other)\n"
1055              "    : value{other.value} {\n"
1056              "  do_magic();\n"
1057              "  do_more_magic();\n"
1058              "}";
1059   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1060                     "  requires (std::is_copy_constructible<T>)\n"
1061                     "    : value{other.value} {\n"
1062                     "  do_magic();\n"
1063                     "  do_more_magic();\n"
1064                     "}";
1065   RequiresTokenCount = 9;
1066   TestRequires(__LINE__);
1067 }
1068 
1069 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1070   auto Tokens = annotate("__asm{\n"
1071                          "a:\n"
1072                          "};");
1073   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1074   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1075   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1076   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
1077 }
1078 
1079 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1080   auto Tokens = annotate("int (^)() = ^ ()\n"
1081                          "  external_source_symbol() { //\n"
1082                          "  return 1;\n"
1083                          "};");
1084   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1085   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1086   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1087 
1088   Tokens = annotate("int *p = ^int*(){ //\n"
1089                     "  return nullptr;\n"
1090                     "}();");
1091   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1092   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1093 }
1094 
1095 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1096   auto Tokens = annotate("[]() constexpr {}");
1097   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1098   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1099   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1100 
1101   Tokens = annotate("[]() consteval {}");
1102   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1103   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1104   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1105 
1106   Tokens = annotate("[]() mutable {}");
1107   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1108   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1109   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1110 
1111   Tokens = annotate("[]() static {}");
1112   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1113   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1114   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1115 
1116   Tokens = annotate("[]() -> auto {}");
1117   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1118   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1119   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1120   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1121 
1122   Tokens = annotate("[]() -> auto & {}");
1123   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1124   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1125   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1126   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1127 
1128   Tokens = annotate("[]() -> auto * {}");
1129   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1130   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1131   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1132   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1133 
1134   Tokens = annotate("[] {}");
1135   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1136   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1137   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1138 
1139   Tokens = annotate("[] noexcept {}");
1140   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1141   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1142   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1143 
1144   Tokens = annotate("[] -> auto {}");
1145   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1146   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1147   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_LambdaArrow);
1148   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1149 
1150   Tokens = annotate("[] <typename T> () {}");
1151   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1152   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1153   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1154   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1155 
1156   Tokens = annotate("[] <typename T> {}");
1157   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1158   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1159   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1160   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1161 
1162   Tokens = annotate("[] <typename... T> () {}");
1163   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1164   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1165   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1166   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1167 
1168   Tokens = annotate("[] <typename... T> {}");
1169   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1170   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1171   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1172   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1173 
1174   Tokens = annotate("[] <int... T> () {}");
1175   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1176   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1177   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1178   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1179 
1180   Tokens = annotate("[] <int... T> {}");
1181   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1182   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1183   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1184   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1185 
1186   Tokens = annotate("[] <Foo... T> () {}");
1187   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1188   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1189   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1190   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1191 
1192   Tokens = annotate("[] <Foo... T> {}");
1193   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1194   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1195   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1196   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1197 }
1198 
1199 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1200   auto Tokens = annotate("template <typename T>\n"
1201                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1202                          "string OldFunction(const string &parameter) {}");
1203   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1204   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1205 
1206   Tokens = annotate("template <typename T>\n"
1207                     "A(T) noexcept;");
1208   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1209   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1210 }
1211 
1212 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1213   auto Tokens = annotate("void f [[noreturn]] ();");
1214   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1215   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1216 
1217   Tokens = annotate("void f [[noreturn]] () {}");
1218   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1219   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1220 }
1221 
1222 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1223   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1224   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1225   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1226   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1227   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1228 }
1229 
1230 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
1231   auto Annotate = [this](llvm::StringRef Code) {
1232     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
1233   };
1234   // Test that unary operators get labeled as such and that operators like '++'
1235   // don't get split.
1236   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
1237                             tok::tilde, tok::amp,      tok::pipe,
1238                             tok::caret, tok::plusplus, tok::minusminus};
1239   for (auto Kind : Unary) {
1240     auto Tokens =
1241         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
1242     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1243     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
1244   }
1245   // Operators formed by joining two operators like '^~'. For some of these
1246   // joined operators, we don't have a separate type, so we only test for their
1247   // precedence.
1248   std::pair<prec::Level, std::string> JoinedBinary[] = {
1249       {prec::Comma, "<->"},       {prec::Assignment, "+="},
1250       {prec::Assignment, "-="},   {prec::Assignment, "*="},
1251       {prec::Assignment, "/="},   {prec::Assignment, "%="},
1252       {prec::Assignment, "&="},   {prec::Assignment, "^="},
1253       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
1254       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
1255       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
1256       {prec::Equality, "=="},     {prec::Equality, "!="},
1257       {prec::Equality, "==="},    {prec::Equality, "!=="},
1258       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
1259       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
1260   };
1261   for (auto Operator : JoinedBinary) {
1262     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
1263     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1264     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
1265     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
1266   }
1267   // '~^' and '^~' can be unary as well as binary operators.
1268   auto Tokens = Annotate("x = ~^x;");
1269   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1270   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1271   Tokens = Annotate("x = ^~x;");
1272   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1273   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1274   // The unary operators '~&' and '~|' can only be unary operators. The current
1275   // implementation treats each of them as separate unary '~' and '&' or '|'
1276   // operators, which is enough for formatting purposes. In FormatTestVerilog,
1277   // there is a test that there is no space in between. And even if a new line
1278   // is inserted between the '~' and '|', the semantic meaning is the same as
1279   // the joined operator, so the CanBreakBefore property doesn't need to be
1280   // false for the second operator.
1281   Tokens = Annotate("x = ~&x;");
1282   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1283   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1284   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
1285   Tokens = Annotate("x = ~|x;");
1286   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1287   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1288   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
1289   // Test for block label colons.
1290   Tokens = Annotate("begin : x\n"
1291                     "end : x");
1292   ASSERT_EQ(Tokens.size(), 7u);
1293   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
1294   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
1295   // Test that the dimension colon is annotated correctly.
1296   Tokens = Annotate("var [1 : 0] x;");
1297   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1298   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
1299   Tokens = Annotate("extern function [1 : 0] x;");
1300   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1301   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
1302   // Test case labels and ternary operators.
1303   Tokens = Annotate("case (x)\n"
1304                     "  x:\n"
1305                     "    x;\n"
1306                     "endcase\n");
1307   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1308   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GotoLabelColon);
1309   Tokens = Annotate("case (x)\n"
1310                     "  x ? x : x:\n"
1311                     "    x;\n"
1312                     "endcase\n");
1313   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1314   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
1315   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
1316   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GotoLabelColon);
1317 }
1318 
1319 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
1320   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
1321 
1322   // The TT_Unknown is clearly not binding for the future, please adapt if those
1323   // tokens get annotated.
1324   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1325   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1326   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1327   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
1328   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1329   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1330   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1331   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
1332   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
1333   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1334 
1335   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
1336   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1337   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1338   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1339   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
1340   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
1341   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1342   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1343   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
1344   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
1345   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1346 }
1347 
1348 } // namespace
1349 } // namespace format
1350 } // namespace clang
1351