xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision 50acd67018a53239f11a2889c28f77a1c7dc8c6b)
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   Tokens =
247       annotate("template <typename T> void swap() noexcept(Bar<T> && Foo<T>);");
248   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
249   EXPECT_TOKEN(Tokens[15], tok::ampamp, TT_BinaryOperator);
250 
251   Tokens = annotate("template <typename T> struct S {\n"
252                     "  explicit(Bar<T> && Foo<T>) S(const S &);\n"
253                     "};");
254   ASSERT_EQ(Tokens.size(), 30u) << Tokens;
255   EXPECT_TOKEN(Tokens[14], tok::ampamp, TT_BinaryOperator);
256 
257   Tokens = annotate("template <bool B = C && D> struct S {};");
258   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
259   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_BinaryOperator);
260 
261   Tokens = annotate("template <typename T, bool B = C && D> struct S {};");
262   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
263   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
264 
265   Tokens = annotate("template <typename T, typename U = T&&> struct S {};");
266   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
267   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_PointerOrReference);
268 
269   Tokens = annotate("template <typename T = int (*)(int)> struct S {};");
270   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
271   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_FunctionTypeLParen);
272   EXPECT_TOKEN(Tokens[7], tok::star, TT_PointerOrReference);
273 }
274 
275 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) {
276   auto Tokens = annotate("x - 0");
277   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
278   EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator);
279   Tokens = annotate("0 + 0");
280   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
281   EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator);
282   Tokens = annotate("x + +0");
283   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
284   EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator);
285   Tokens = annotate("x ? -0 : +0");
286   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
287   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
288   EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator);
289   Tokens = annotate("(-0)");
290   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
291   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
292   Tokens = annotate("0, -0");
293   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
294   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
295   Tokens = annotate("for (; -1;) {\n}");
296   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
297   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
298   Tokens = annotate("x = -1;");
299   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
300   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
301   Tokens = annotate("x[-1]");
302   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
303   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
304   Tokens = annotate("x = {-1};");
305   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
306   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
307   Tokens = annotate("case -x:");
308   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
309   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
310   Tokens = annotate("co_await -x;");
311   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
312   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
313   Tokens = annotate("co_return -x;");
314   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
315   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
316   Tokens = annotate("co_yield -x;");
317   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
318   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
319   Tokens = annotate("delete -x;");
320   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
321   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
322   Tokens = annotate("return -x;");
323   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
324   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
325   Tokens = annotate("throw -x;");
326   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
327   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
328   Tokens = annotate("sizeof -x");
329   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
330   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
331   Tokens = annotate("co_await +x;");
332   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
333   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
334   Tokens = annotate("co_return +x;");
335   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
336   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
337   Tokens = annotate("co_yield +x;");
338   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
339   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
340   Tokens = annotate("delete +x;");
341   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
342   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
343   Tokens = annotate("return +x;");
344   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
345   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
346   Tokens = annotate("throw +x;");
347   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
348   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
349   Tokens = annotate("sizeof +x");
350   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
351   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
352   Tokens = annotate("(int)-x");
353   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
354   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
355   Tokens = annotate("(-x)");
356   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
357   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
358   Tokens = annotate("!+x");
359   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
360   EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator);
361   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
362 }
363 
364 TEST_F(TokenAnnotatorTest, UnderstandsClasses) {
365   auto Tokens = annotate("class C {};");
366   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
367   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
368 
369   Tokens = annotate("const class C {} c;");
370   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
371   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace);
372 
373   Tokens = annotate("const class {} c;");
374   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
375   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
376 
377   Tokens = annotate("class [[deprecated(\"\")]] C { int i; };");
378   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
379   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_ClassLBrace);
380 }
381 
382 TEST_F(TokenAnnotatorTest, UnderstandsStructs) {
383   auto Tokens = annotate("struct S {};");
384   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
385   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace);
386 
387   Tokens = annotate("struct EXPORT_MACRO [[nodiscard]] C { int i; };");
388   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
389   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_StructLBrace);
390 
391   Tokens = annotate("struct [[deprecated]] [[nodiscard]] C { int i; };");
392   EXPECT_EQ(Tokens.size(), 19u) << Tokens;
393   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_StructLBrace);
394 
395   Tokens = annotate("template <typename T> struct S<const T[N]> {};");
396   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
397   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
398   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
399   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
400   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
401 
402   Tokens = annotate("template <typename T> struct S<T const[N]> {};");
403   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
404   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
405   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
406   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
407   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
408 
409   Tokens = annotate("template <typename T, unsigned n> struct S<T const[n]> {\n"
410                     "  void f(T const (&a)[n]);\n"
411                     "};");
412   EXPECT_EQ(Tokens.size(), 35u) << Tokens;
413   EXPECT_TOKEN(Tokens[10], tok::less, TT_TemplateOpener);
414   EXPECT_TOKEN(Tokens[13], tok::l_square, TT_ArraySubscriptLSquare);
415   EXPECT_TOKEN(Tokens[16], tok::greater, TT_TemplateCloser);
416   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_StructLBrace);
417   EXPECT_TOKEN(Tokens[23], tok::l_paren, TT_FunctionTypeLParen);
418   EXPECT_TOKEN(Tokens[24], tok::amp, TT_UnaryOperator);
419   EXPECT_TOKEN(Tokens[27], tok::l_square, TT_ArraySubscriptLSquare);
420 }
421 
422 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
423   auto Tokens = annotate("union U {};");
424   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
425   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
426 
427   Tokens = annotate("union U { void f() { return; } };");
428   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
429   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
430   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
431 }
432 
433 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
434   auto Tokens = annotate("enum E {};");
435   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
436   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
437 }
438 
439 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
440   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
441   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
442   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
443 
444   Tokens = annotate("template <typename T> void F(T) && = delete;");
445   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
446   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
447 }
448 
449 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
450   auto Tokens =
451       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
452   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
453   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
454 }
455 
456 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
457   auto Tokens =
458       annotate("template <typename T> "
459                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
460   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
461   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
462 }
463 
464 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) {
465   auto Tokens =
466       annotate("#define FOO(typeName) \\\n"
467                "  { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }");
468   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
469   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
470   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
471   EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener);
472   EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser);
473 }
474 
475 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) {
476   auto Tokens = annotate("if (std::tuple_size_v<T> > 0)");
477   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
478   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
479   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
480   EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator);
481 }
482 
483 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
484   FormatStyle Style = getLLVMStyle();
485   Style.WhitespaceSensitiveMacros.push_back("FOO");
486 
487   auto Tokens = annotate("FOO(1+2 )\n", Style);
488   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
489   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
490 
491   Tokens = annotate("FOO(a:b:c)\n", Style);
492   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
493   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
494 }
495 
496 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
497   auto Tokens = annotate("delete (void *)p;");
498   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
499   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
500 
501   Tokens = annotate("delete[] (void *)p;");
502   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
503   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
504 
505   Tokens = annotate("delete[] /*comment*/ (void *)p;");
506   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
507   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
508 
509   Tokens = annotate("delete[/*comment*/] (void *)p;");
510   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
511   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
512 
513   Tokens = annotate("delete/*comment*/[] (void *)p;");
514   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
515   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
516 }
517 
518 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
519   auto Tokens = annotate("(void)p;");
520   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
521   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
522 
523   Tokens = annotate("auto x = (Foo)p;");
524   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
525   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
526 
527   Tokens = annotate("(std::vector<int>)p;");
528   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
529   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
530 
531   Tokens = annotate("return (Foo)p;");
532   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
533   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
534 
535   Tokens = annotate("throw (Foo)p;");
536   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
537   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
538 }
539 
540 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
541   auto Tokens = annotate("void f() throw(int);");
542   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
543   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
544 }
545 
546 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
547   auto Tokens = annotate("void f() &;");
548   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
549   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
550 
551   Tokens = annotate("void operator=(T) &&;");
552   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
553   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
554 
555   Tokens = annotate("template <typename T> void f() &;");
556   EXPECT_EQ(Tokens.size(), 12u) << Tokens;
557   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
558 
559   Tokens = annotate("template <typename T> void operator=(T) &;");
560   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
561   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
562 }
563 
564 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
565   auto Tokens = annotate("x.operator+()");
566   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
567   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
568   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
569   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
570   Tokens = annotate("x.operator=()");
571   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
572   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
573   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
574   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
575   Tokens = annotate("x.operator+=()");
576   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
577   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
578   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
579   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
580   Tokens = annotate("x.operator,()");
581   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
582   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
583   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
584   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
585   Tokens = annotate("x.operator()()");
586   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
587   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
588   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
589   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
590   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
591   Tokens = annotate("x.operator[]()");
592   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
593   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
594   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
595   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
596   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
597   Tokens = annotate("x.operator\"\"_a()");
598   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
599   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
600   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
601   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
602   Tokens = annotate("x.operator\"\" _a()");
603   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
604   // FIXME
605   // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
606   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
607   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
608   Tokens = annotate("x.operator\"\"if()");
609   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
610   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
611   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
612   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
613   Tokens = annotate("x.operator\"\"s()");
614   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
615   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
616   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
617   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
618   Tokens = annotate("x.operator\"\" s()");
619   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
620   // FIXME
621   // EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_FunctionDeclarationName);
622   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
623   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
624 
625   Tokens = annotate("int operator+(int);");
626   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
627   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
628   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
629   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
630   Tokens = annotate("auto operator=(T&) {}");
631   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
632   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
633   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
634   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
635   Tokens = annotate("auto operator()() {}");
636   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
637   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
638   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
639   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
640   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
641 }
642 
643 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
644   struct {
645     const char *Text;
646     tok::TokenKind Kind;
647   } Operators[] = {{"+", tok::plus},
648                    {"-", tok::minus},
649                    // FIXME:
650                    // {"*", tok::star},
651                    {"/", tok::slash},
652                    {"%", tok::percent},
653                    {"^", tok::caret},
654                    // FIXME:
655                    // {"&", tok::amp},
656                    {"|", tok::pipe},
657                    {"~", tok::tilde},
658                    {"!", tok::exclaim},
659                    {"=", tok::equal},
660                    // FIXME:
661                    // {"<", tok::less},
662                    {">", tok::greater},
663                    {"+=", tok::plusequal},
664                    {"-=", tok::minusequal},
665                    {"*=", tok::starequal},
666                    {"/=", tok::slashequal},
667                    {"%=", tok::percentequal},
668                    {"^=", tok::caretequal},
669                    {"&=", tok::ampequal},
670                    {"|=", tok::pipeequal},
671                    {"<<", tok::lessless},
672                    {">>", tok::greatergreater},
673                    {">>=", tok::greatergreaterequal},
674                    {"<<=", tok::lesslessequal},
675                    {"==", tok::equalequal},
676                    {"!=", tok::exclaimequal},
677                    {"<=", tok::lessequal},
678                    {">=", tok::greaterequal},
679                    {"<=>", tok::spaceship},
680                    {"&&", tok::ampamp},
681                    {"||", tok::pipepipe},
682                    {"++", tok::plusplus},
683                    {"--", tok::minusminus},
684                    {",", tok::comma},
685                    {"->*", tok::arrowstar},
686                    {"->", tok::arrow}};
687 
688   for (const auto &Operator : Operators) {
689     std::string Input("C<&operator");
690     Input += Operator.Text;
691     Input += " > a;";
692     auto Tokens = annotate(std::string(Input));
693     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
694     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
695     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
696     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
697   }
698 
699   auto Tokens = annotate("C<&operator< <X>> lt;");
700   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
701   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
702   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
703   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
704   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
705   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
706 }
707 
708 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
709   auto Tokens = annotate("template <typename T>\n"
710                          "concept C = (Foo && Bar) && (Bar && Baz);");
711 
712   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
713   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
714   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
715   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
716 
717   Tokens = annotate("template <typename T>\n"
718                     "concept C = Foo && !Bar;");
719 
720   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
721   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
722   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
723 
724   Tokens = annotate("template <typename T>\n"
725                     "concept C = requires(T t) {\n"
726                     "  { t.foo() };\n"
727                     "} && Bar<T> && Baz<T>;");
728   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
729   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
730   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
731   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
732   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
733   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
734 
735   Tokens = annotate("template<typename T>\n"
736                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
737                     "struct Foo;");
738   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
739   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
740   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
741   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
742   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
743   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
744   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
745   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
746   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
747   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
748   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
749 
750   Tokens =
751       annotate("template<typename T>\n"
752                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
753                "struct Foo;");
754   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
755   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
756   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
757   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
758   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
759   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
760   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
761   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
762   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
763   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
764   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
765   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
766 
767   Tokens = annotate("template <typename T>\n"
768                     "void foo(T) noexcept requires Bar<T>;");
769   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
770   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
771 
772   Tokens = annotate("template <typename T>\n"
773                     "requires Bar<T> || Baz<T>\n"
774                     "auto foo(T) -> int;");
775   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
776   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
777   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
778   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
779   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
780 
781   Tokens = annotate("template <typename T>\n"
782                     "requires Bar<T>\n"
783                     "bool foo(T) { return false; }");
784   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
785   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
786   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
787   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
788 
789   Tokens = annotate("template <typename T>\n"
790                     "requires Bar<T>\n"
791                     "decltype(auto) foo(T) { return false; }");
792   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
793   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
794   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
795   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
796 
797   Tokens = annotate("template <typename T>\n"
798                     "struct S {\n"
799                     "  void foo() const requires Bar<T>;\n"
800                     "  void bar() const & requires Baz<T>;\n"
801                     "  void bar() && requires Baz2<T>;\n"
802                     "  void baz() const & noexcept requires Baz<T>;\n"
803                     "  void baz() && noexcept requires Baz2<T>;\n"
804                     "};\n"
805                     "\n"
806                     "void S::bar() const & requires Baz<T> { }");
807   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
808   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
809   EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference);
810   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
811   EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference);
812   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
813   EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference);
814   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
815   EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference);
816   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
817   EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference);
818   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
819 
820   Tokens = annotate("void Class::member() && requires(Constant) {}");
821   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
822   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
823 
824   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
825   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
826   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
827 
828   Tokens =
829       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
830   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
831   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
832 
833   Tokens = annotate("void Class::member() && requires(typename "
834                     "Namespace::Outer<T>::Inner::Constant) {}");
835   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
836   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
837 
838   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
839                     "  template<class T>\n"
840                     "    requires requires { number_zero_v<T>; }\n"
841                     "  [[nodiscard]] constexpr operator T() const { "
842                     "return number_zero_v<T>; }\n"
843                     "};");
844   ASSERT_EQ(Tokens.size(), 44u);
845   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
846   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
847   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
848   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
849   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
850   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
851 
852   Tokens =
853       annotate("template <class A, class B> concept C ="
854                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
855   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
856   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
857   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
858   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
859   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
860   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
861   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
862   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
863 
864   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
865   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
866   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
867 
868   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
869   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
870   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
871 
872   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
873   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
874   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
875 
876   Tokens =
877       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
878   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
879   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
880 
881   Tokens =
882       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
883   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
884   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
885 
886   Tokens =
887       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
888   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
889   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
890 }
891 
892 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
893   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
894   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
895   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
896   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
897   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
898 
899   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
900   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
901   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
902   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
903   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
904 
905   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
906   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
907   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
908   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
909   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
910 
911   Tokens = annotate("foo(requires(const T t) {});");
912   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
913   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
914   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
915   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
916 
917   Tokens = annotate("foo(requires(const int t) {});");
918   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
919   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
920   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
921   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
922 
923   Tokens = annotate("foo(requires(const T t) {});");
924   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
925   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
926   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
927   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
928 
929   Tokens = annotate("foo(requires(int const* volatile t) {});");
930   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
931   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
932   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
933   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
934   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
935 
936   Tokens = annotate("foo(requires(T const* volatile t) {});");
937   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
938   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
939   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
940   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
941   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
942 
943   Tokens = annotate("foo(requires(T& t) {});");
944   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
945   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
946   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
947   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
948   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
949 
950   Tokens = annotate("foo(requires(T&& t) {});");
951   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
952   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
953   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
954   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
955   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
956 
957   Tokens = annotate("bool foo = requires(T& t) {};");
958   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
959   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
960   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
961   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
962   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
963 
964   Tokens = annotate("bool foo = requires(T&& t) {};");
965   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
966   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
967   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
968   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
969   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
970 
971   Tokens =
972       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
973   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
974   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
975   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
976   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
977   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
978 
979   Tokens = annotate("template <typename T>\n"
980                     "concept C = requires(T T) {\n"
981                     "  requires Bar<T> && Foo<T>;\n"
982                     "};");
983   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
984   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
985   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
986   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
987   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
988                TT_RequiresClauseInARequiresExpression);
989 
990   Tokens = annotate("template <typename T>\n"
991                     "concept C = requires(T T) {\n"
992                     "  { t.func() } -> std::same_as<int>;"
993                     "  requires Bar<T> && Foo<T>;\n"
994                     "};");
995   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
996   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
997   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
998   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
999   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
1000                TT_RequiresClauseInARequiresExpression);
1001 
1002   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
1003   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
1004                     "requires true; };");
1005   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1006   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1007   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1008   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
1009 }
1010 
1011 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
1012   // Everything after #pragma region should be ImplicitStringLiteral
1013   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
1014   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1015   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
1016   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
1017   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
1018 
1019   // Make sure it's annotated correctly inside a function as well
1020   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
1021   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1022   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
1023   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
1024   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
1025 }
1026 
1027 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
1028   const char *BaseCode = nullptr;
1029   const char *ConstrainedCode = nullptr;
1030   auto BaseTokenCount = 0u;
1031   auto RequiresTokenCount = 0u;
1032   auto PrefixTokenCount = 0u;
1033 
1034   auto TestRequires = [&](int Line) {
1035     const auto BaseTokens = annotate(BaseCode);
1036     const auto ConstrainedTokens = annotate(ConstrainedCode);
1037 
1038 #define LINE " (Line " << Line << ')'
1039 
1040     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
1041     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
1042         << LINE;
1043 
1044     for (auto I = 0u; I < BaseTokenCount; ++I) {
1045       EXPECT_EQ(
1046           *BaseTokens[I],
1047           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
1048           << I << LINE;
1049     }
1050 
1051 #undef LINE
1052   };
1053 
1054   BaseCode = "template<typename T>\n"
1055              "T Pi = 3.14;";
1056   ConstrainedCode = "template<typename T>\n"
1057                     "  requires Foo<T>\n"
1058                     "T Pi = 3.14;";
1059   BaseTokenCount = 11;
1060   RequiresTokenCount = 5;
1061   PrefixTokenCount = 5;
1062   TestRequires(__LINE__);
1063 
1064   BaseCode = "template<typename T>\n"
1065              "struct Bar;";
1066   ConstrainedCode = "template<typename T>\n"
1067                     "  requires Foo<T>\n"
1068                     "struct Bar;";
1069   BaseTokenCount = 9;
1070   TestRequires(__LINE__);
1071 
1072   BaseCode = "template<typename T>\n"
1073              "struct Bar {\n"
1074              "  T foo();\n"
1075              "  T bar();\n"
1076              "};";
1077   ConstrainedCode = "template<typename T>\n"
1078                     "  requires Foo<T>\n"
1079                     "struct Bar {\n"
1080                     "  T foo();\n"
1081                     "  T bar();\n"
1082                     "};";
1083   BaseTokenCount = 21;
1084   TestRequires(__LINE__);
1085 
1086   BaseCode = "template<typename T>\n"
1087              "Bar(T) -> Bar<T>;";
1088   ConstrainedCode = "template<typename T>\n"
1089                     "  requires Foo<T>\n"
1090                     "Bar(T) -> Bar<T>;";
1091   BaseTokenCount = 16;
1092   TestRequires(__LINE__);
1093 
1094   BaseCode = "template<typename T>\n"
1095              "T foo();";
1096   ConstrainedCode = "template<typename T>\n"
1097                     "  requires Foo<T>\n"
1098                     "T foo();";
1099   BaseTokenCount = 11;
1100   TestRequires(__LINE__);
1101 
1102   BaseCode = "template<typename T>\n"
1103              "T foo() {\n"
1104              "  auto bar = baz();\n"
1105              "  return bar + T{};\n"
1106              "}";
1107   ConstrainedCode = "template<typename T>\n"
1108                     "  requires Foo<T>\n"
1109                     "T foo() {\n"
1110                     "  auto bar = baz();\n"
1111                     "  return bar + T{};\n"
1112                     "}";
1113   BaseTokenCount = 26;
1114   TestRequires(__LINE__);
1115 
1116   BaseCode = "template<typename T>\n"
1117              "T foo();";
1118   ConstrainedCode = "template<typename T>\n"
1119                     "T foo() requires Foo<T>;";
1120   BaseTokenCount = 11;
1121   PrefixTokenCount = 9;
1122   TestRequires(__LINE__);
1123 
1124   BaseCode = "template<typename T>\n"
1125              "T foo() {\n"
1126              "  auto bar = baz();\n"
1127              "  return bar + T{};\n"
1128              "}";
1129   ConstrainedCode = "template<typename T>\n"
1130                     "T foo() requires Foo<T> {\n"
1131                     "  auto bar = baz();\n"
1132                     "  return bar + T{};\n"
1133                     "}";
1134   BaseTokenCount = 26;
1135   TestRequires(__LINE__);
1136 
1137   BaseCode = "template<typename T>\n"
1138              "T foo();";
1139   ConstrainedCode = "template<typename T>\n"
1140                     "  requires(Foo<T>)\n"
1141                     "T foo();";
1142   BaseTokenCount = 11;
1143   RequiresTokenCount = 7;
1144   PrefixTokenCount = 5;
1145   TestRequires(__LINE__);
1146 
1147   BaseCode = "template<typename T>\n"
1148              "Bar(T) -> Bar<typename T::I>;";
1149   ConstrainedCode = "template<typename T>\n"
1150                     "  requires requires(T &&t) {\n"
1151                     "             typename T::I;\n"
1152                     "           }\n"
1153                     "Bar(T) -> Bar<typename T::I>;";
1154   BaseTokenCount = 19;
1155   RequiresTokenCount = 14;
1156   PrefixTokenCount = 5;
1157   TestRequires(__LINE__);
1158 
1159   BaseCode = "struct [[nodiscard]] zero_t {\n"
1160              "  template<class T>\n"
1161              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1162              "};";
1163   ConstrainedCode =
1164       "struct [[nodiscard]] zero_t {\n"
1165       "  template<class T>\n"
1166       "    requires requires { v<T>; }\n"
1167       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1168       "};";
1169   BaseTokenCount = 35;
1170   RequiresTokenCount = 9;
1171   PrefixTokenCount = 13;
1172   TestRequires(__LINE__);
1173 
1174   BaseCode = "constexpr Foo(Foo const &other)\n"
1175              "    : value{other.value} {\n"
1176              "  do_magic();\n"
1177              "  do_more_magic();\n"
1178              "}";
1179   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1180                     "  requires std::is_copy_constructible<T>\n"
1181                     "    : value{other.value} {\n"
1182                     "  do_magic();\n"
1183                     "  do_more_magic();\n"
1184                     "}";
1185   BaseTokenCount = 26;
1186   RequiresTokenCount = 7;
1187   PrefixTokenCount = 8;
1188   TestRequires(__LINE__);
1189 
1190   BaseCode = "constexpr Foo(Foo const &other)\n"
1191              "    : value{other.value} {\n"
1192              "  do_magic();\n"
1193              "  do_more_magic();\n"
1194              "}";
1195   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1196                     "  requires (std::is_copy_constructible<T>)\n"
1197                     "    : value{other.value} {\n"
1198                     "  do_magic();\n"
1199                     "  do_more_magic();\n"
1200                     "}";
1201   RequiresTokenCount = 9;
1202   TestRequires(__LINE__);
1203 }
1204 
1205 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1206   auto Tokens = annotate("__asm{\n"
1207                          "a:\n"
1208                          "};");
1209   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1210   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1211   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1212   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
1213 }
1214 
1215 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1216   auto Tokens = annotate("int (^)() = ^ ()\n"
1217                          "  external_source_symbol() { //\n"
1218                          "  return 1;\n"
1219                          "};");
1220   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1221   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1222   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1223 
1224   Tokens = annotate("int *p = ^int*(){ //\n"
1225                     "  return nullptr;\n"
1226                     "}();");
1227   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1228   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1229 }
1230 
1231 TEST_F(TokenAnnotatorTest, UnderstandsObjCMethodExpr) {
1232   auto Tokens = annotate("void f() {\n"
1233                          "  //\n"
1234                          "  BOOL a = [b.c n] > 1;\n"
1235                          "}");
1236   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
1237   EXPECT_TOKEN(Tokens[9], tok::l_square, TT_ObjCMethodExpr);
1238   EXPECT_TOKEN(Tokens[15], tok::greater, TT_BinaryOperator);
1239 }
1240 
1241 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1242   auto Tokens = annotate("[]() constexpr {}");
1243   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1244   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1245   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1246 
1247   Tokens = annotate("[]() consteval {}");
1248   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1249   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1250   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1251 
1252   Tokens = annotate("[]() mutable {}");
1253   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1254   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1255   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1256 
1257   Tokens = annotate("[]() static {}");
1258   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1259   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1260   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1261 
1262   Tokens = annotate("[]() -> auto {}");
1263   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1264   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1265   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1266   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1267 
1268   Tokens = annotate("[]() -> auto & {}");
1269   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1270   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1271   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1272   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1273 
1274   Tokens = annotate("[]() -> auto * {}");
1275   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1276   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1277   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
1278   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1279 
1280   Tokens = annotate("[] {}");
1281   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1282   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1283   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1284 
1285   Tokens = annotate("[] noexcept {}");
1286   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1287   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1288   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1289 
1290   Tokens = annotate("[] -> auto {}");
1291   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1292   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1293   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_LambdaArrow);
1294   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1295 
1296   Tokens = annotate("[] <typename T> () {}");
1297   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1298   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1299   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1300   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1301 
1302   Tokens = annotate("[] <typename T> {}");
1303   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1304   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1305   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1306   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1307 
1308   Tokens = annotate("[] <typename... T> () {}");
1309   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1310   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1311   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1312   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1313 
1314   Tokens = annotate("[] <typename... T> {}");
1315   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1316   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1317   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1318   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1319 
1320   Tokens = annotate("[] <int... T> () {}");
1321   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1322   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1323   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1324   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1325 
1326   Tokens = annotate("[] <int... T> {}");
1327   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1328   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1329   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1330   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1331 
1332   Tokens = annotate("[] <Foo... T> () {}");
1333   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1334   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1335   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1336   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1337 
1338   Tokens = annotate("[] <Foo... T> {}");
1339   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1340   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1341   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1342   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1343 
1344   // Lambdas with a requires-clause
1345   Tokens = annotate("[] <typename T> (T t) requires Bar<T> {}");
1346   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1347   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1348   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1349   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1350   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1351   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1352 
1353   Tokens = annotate("[] <typename T> (T &&t) requires Bar<T> {}");
1354   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1355   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1356   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1357   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_PointerOrReference);
1358   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1359   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1360   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1361 
1362   Tokens = annotate("[] <typename T> (T t) requires Foo<T> || Bar<T> {}");
1363   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1364   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1365   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1366   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1367   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1368   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1369 
1370   Tokens = annotate("[] <typename T> (T t) -> T requires Bar<T> {}");
1371   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1372   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1373   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1374   EXPECT_TOKEN(Tokens[10], tok::arrow, TT_LambdaArrow);
1375   EXPECT_TOKEN(Tokens[12], tok::kw_requires, TT_RequiresClause);
1376   EXPECT_TRUE(Tokens[16]->ClosesRequiresClause);
1377   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1378 
1379   Tokens = annotate("[] <typename T> requires Bar<T> (T t) {}");
1380   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1381   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1382   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1383   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1384   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1385   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1386 
1387   Tokens = annotate("[] <typename T> requires Bar<T> (T &&t) {}");
1388   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1389   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1390   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1391   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1392   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1393   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_PointerOrReference);
1394   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1395 
1396   Tokens = annotate("[] <typename T> requires Foo<T> || Bar<T> (T t) {}");
1397   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1398   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1399   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1400   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1401   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1402   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1403 
1404   Tokens = annotate("[] <typename T> requires true (T&& t) {}");
1405   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1406   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1407   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1408   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1409   EXPECT_TRUE(Tokens[7]->ClosesRequiresClause);
1410   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1411   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1412 
1413   Tokens = annotate("[] <typename T> requires Bar<T> {}");
1414   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1415   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1416   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1417   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1418   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1419   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_LambdaLBrace);
1420 
1421   Tokens = annotate("[] <typename T> requires Bar<T> noexcept {}");
1422   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1423   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1424   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1425   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1426   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1427   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1428 
1429   Tokens = annotate("[] <typename T> requires Bar<T> -> T {}");
1430   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1431   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1432   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1433   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1434   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1435   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_LambdaArrow);
1436   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1437 
1438   Tokens = annotate("[] <typename T> requires Foo<T> (T t) requires Bar<T> {}");
1439   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1440   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1441   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1442   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1443   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1444   EXPECT_TOKEN(Tokens[15], tok::kw_requires, TT_RequiresClause);
1445   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1446   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1447 }
1448 
1449 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1450   auto Tokens = annotate("template <typename T>\n"
1451                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1452                          "string OldFunction(const string &parameter) {}");
1453   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1454   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1455 
1456   Tokens = annotate("template <typename T>\n"
1457                     "A(T) noexcept;");
1458   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1459   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1460 }
1461 
1462 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1463   auto Tokens = annotate("void f [[noreturn]] ();");
1464   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1465   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1466 
1467   Tokens = annotate("void f [[noreturn]] () {}");
1468   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1469   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1470 }
1471 
1472 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1473   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1474   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1475   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1476   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1477   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1478 }
1479 
1480 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
1481   auto Annotate = [this](llvm::StringRef Code) {
1482     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
1483   };
1484   // Test that unary operators get labeled as such and that operators like '++'
1485   // don't get split.
1486   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
1487                             tok::tilde, tok::amp,      tok::pipe,
1488                             tok::caret, tok::plusplus, tok::minusminus};
1489   for (auto Kind : Unary) {
1490     auto Tokens =
1491         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
1492     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1493     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
1494   }
1495   // Operators formed by joining two operators like '^~'. For some of these
1496   // joined operators, we don't have a separate type, so we only test for their
1497   // precedence.
1498   std::pair<prec::Level, std::string> JoinedBinary[] = {
1499       {prec::Comma, "<->"},       {prec::Assignment, "+="},
1500       {prec::Assignment, "-="},   {prec::Assignment, "*="},
1501       {prec::Assignment, "/="},   {prec::Assignment, "%="},
1502       {prec::Assignment, "&="},   {prec::Assignment, "^="},
1503       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
1504       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
1505       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
1506       {prec::Equality, "=="},     {prec::Equality, "!="},
1507       {prec::Equality, "==="},    {prec::Equality, "!=="},
1508       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
1509       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
1510   };
1511   for (auto Operator : JoinedBinary) {
1512     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
1513     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1514     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
1515     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
1516   }
1517   // '~^' and '^~' can be unary as well as binary operators.
1518   auto Tokens = Annotate("x = ~^x;");
1519   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1520   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1521   Tokens = Annotate("x = ^~x;");
1522   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1523   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
1524   // The unary operators '~&' and '~|' can only be unary operators. The current
1525   // implementation treats each of them as separate unary '~' and '&' or '|'
1526   // operators, which is enough for formatting purposes. In FormatTestVerilog,
1527   // there is a test that there is no space in between. And even if a new line
1528   // is inserted between the '~' and '|', the semantic meaning is the same as
1529   // the joined operator, so the CanBreakBefore property doesn't need to be
1530   // false for the second operator.
1531   Tokens = Annotate("x = ~&x;");
1532   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1533   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1534   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
1535   Tokens = Annotate("x = ~|x;");
1536   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1537   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
1538   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
1539   // Test for block label colons.
1540   Tokens = Annotate("begin : x\n"
1541                     "end : x");
1542   ASSERT_EQ(Tokens.size(), 7u);
1543   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
1544   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
1545   // Test that the dimension colon is annotated correctly.
1546   Tokens = Annotate("var [1 : 0] x;");
1547   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1548   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
1549   Tokens = Annotate("extern function [1 : 0] x;");
1550   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1551   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
1552   // Test case labels and ternary operators.
1553   Tokens = Annotate("case (x)\n"
1554                     "  x:\n"
1555                     "    x;\n"
1556                     "endcase\n");
1557   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1558   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GotoLabelColon);
1559   Tokens = Annotate("case (x)\n"
1560                     "  x ? x : x:\n"
1561                     "    x;\n"
1562                     "endcase\n");
1563   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1564   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
1565   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
1566   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GotoLabelColon);
1567   // Non-blocking assignments.
1568   Tokens = Annotate("a <= b;");
1569   ASSERT_EQ(Tokens.size(), 5u);
1570   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1571   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1572   Tokens = Annotate("if (a <= b) break;");
1573   ASSERT_EQ(Tokens.size(), 9u);
1574   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1575   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1576   Tokens = Annotate("a <= b <= a;");
1577   ASSERT_EQ(Tokens.size(), 7u);
1578   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
1579   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
1580   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
1581   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
1582 }
1583 
1584 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
1585   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
1586 
1587   // The TT_Unknown is clearly not binding for the future, please adapt if those
1588   // tokens get annotated.
1589   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1590   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1591   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1592   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
1593   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1594   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1595   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1596   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
1597   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
1598   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1599 
1600   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
1601   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1602   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
1603   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
1604   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
1605   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
1606   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
1607   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
1608   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
1609   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
1610   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1611 }
1612 
1613 } // namespace
1614 } // namespace format
1615 } // namespace clang
1616