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