xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision 4a7bf42a9b83144db8a11ac06cce4da21166e6a2)
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(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   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
88   EXPECT_TOKEN(Tokens[1], tok::star, TT_UnaryOperator);
89   Tokens = annotate("case &x:");
90   ASSERT_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   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
95   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
96 
97   Tokens = annotate("struct {\n"
98                     "} *ptr;");
99   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
100   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
101   Tokens = annotate("union {\n"
102                     "} *ptr;");
103   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
104   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
105   Tokens = annotate("class {\n"
106                     "} *ptr;");
107   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
108   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
109 
110   Tokens = annotate("struct {\n"
111                     "} &&ptr = {};");
112   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
113   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
114   Tokens = annotate("union {\n"
115                     "} &&ptr = {};");
116   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
117   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
118   Tokens = annotate("class {\n"
119                     "} &&ptr = {};");
120   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
121   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
122   Tokens = annotate("int i = int{42} * 2;");
123   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
124   EXPECT_TOKEN(Tokens[7], tok::star, TT_BinaryOperator);
125 
126   Tokens = annotate("delete[] *ptr;");
127   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
128   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
129   Tokens = annotate("delete[] **ptr;");
130   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_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   ASSERT_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   Tokens = annotate("if (new && num) {\n"
314                     "  new = 1;\n"
315                     "}\n"
316                     "if (!delete && num) {\n"
317                     "  delete = 1;\n"
318                     "}");
319   ASSERT_EQ(Tokens.size(), 26u) << Tokens;
320   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_BinaryOperator);
321   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
322 }
323 
324 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) {
325   auto Tokens = annotate("x - 0");
326   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
327   EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator);
328   Tokens = annotate("0 + 0");
329   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
330   EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator);
331   Tokens = annotate("x + +0");
332   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
333   EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator);
334   Tokens = annotate("x ? -0 : +0");
335   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
336   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
337   EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator);
338   Tokens = annotate("(-0)");
339   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
340   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
341   Tokens = annotate("0, -0");
342   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
343   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
344   Tokens = annotate("for (; -1;) {\n}");
345   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
346   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
347   Tokens = annotate("x = -1;");
348   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
349   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
350   Tokens = annotate("x[-1]");
351   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
352   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
353   Tokens = annotate("x = {-1};");
354   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
355   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
356   Tokens = annotate("case -x:");
357   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
358   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
359   Tokens = annotate("co_await -x;");
360   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
361   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
362   Tokens = annotate("co_return -x;");
363   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
364   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
365   Tokens = annotate("co_yield -x;");
366   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
367   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
368   Tokens = annotate("delete -x;");
369   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
370   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
371   Tokens = annotate("return -x;");
372   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
373   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
374   Tokens = annotate("throw -x;");
375   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
376   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
377   Tokens = annotate("sizeof -x");
378   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
379   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
380   Tokens = annotate("co_await +x;");
381   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
382   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
383   Tokens = annotate("co_return +x;");
384   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
385   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
386   Tokens = annotate("co_yield +x;");
387   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
388   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
389   Tokens = annotate("delete +x;");
390   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
391   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
392   Tokens = annotate("return +x;");
393   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
394   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
395   Tokens = annotate("throw +x;");
396   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
397   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
398   Tokens = annotate("sizeof +x");
399   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
400   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
401   Tokens = annotate("(int)-x");
402   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
403   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
404   Tokens = annotate("(-x)");
405   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
406   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
407   Tokens = annotate("!+x");
408   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
409   EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator);
410   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
411 }
412 
413 TEST_F(TokenAnnotatorTest, UnderstandsClasses) {
414   auto Tokens = annotate("class C {};");
415   ASSERT_EQ(Tokens.size(), 6u) << 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("const class C {} c;");
420   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
421   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace);
422   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_ClassRBrace);
423 
424   Tokens = annotate("const class {} c;");
425   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
426   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
427   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_ClassRBrace);
428 
429   Tokens = annotate("class [[deprecated(\"\")]] C { int i; };");
430   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
431   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_ClassLBrace);
432   EXPECT_TOKEN(Tokens[14], tok::r_brace, TT_ClassRBrace);
433 }
434 
435 TEST_F(TokenAnnotatorTest, UnderstandsStructs) {
436   auto Tokens = annotate("struct S {};");
437   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
438   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace);
439   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_StructRBrace);
440 
441   Tokens = annotate("struct macro(a) S {};");
442   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
443   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_StructLBrace);
444   EXPECT_TOKEN(Tokens[7], tok::r_brace, TT_StructRBrace);
445 
446   Tokens = annotate("struct EXPORT_MACRO [[nodiscard]] C { int i; };");
447   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
448   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_StructLBrace);
449   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_StructRBrace);
450 
451   Tokens = annotate("struct [[deprecated]] [[nodiscard]] C { int i; };");
452   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
453   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_StructLBrace);
454   EXPECT_TOKEN(Tokens[16], tok::r_brace, TT_StructRBrace);
455 
456   Tokens = annotate("struct macro(a) S {\n"
457                     "  void f(T &t);\n"
458                     "};");
459   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
460   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_StructLBrace);
461   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
462   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_StructRBrace);
463 
464   Tokens = annotate("template <typename T> struct S<const T[N]> {};");
465   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
466   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
467   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
468   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
469   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
470   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_StructRBrace);
471 
472   Tokens = annotate("template <typename T> struct S<T const[N]> {};");
473   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
474   EXPECT_TOKEN(Tokens[7], tok::less, TT_TemplateOpener);
475   EXPECT_TOKEN(Tokens[10], tok::l_square, TT_ArraySubscriptLSquare);
476   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
477   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_StructLBrace);
478   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_StructRBrace);
479 
480   Tokens = annotate("template <typename T, unsigned n> struct S<T const[n]> {\n"
481                     "  void f(T const (&a)[n]);\n"
482                     "};");
483   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
484   EXPECT_TOKEN(Tokens[10], tok::less, TT_TemplateOpener);
485   EXPECT_TOKEN(Tokens[13], tok::l_square, TT_ArraySubscriptLSquare);
486   EXPECT_TOKEN(Tokens[16], tok::greater, TT_TemplateCloser);
487   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_StructLBrace);
488   EXPECT_TOKEN(Tokens[23], tok::l_paren, TT_FunctionTypeLParen);
489   EXPECT_TOKEN(Tokens[24], tok::amp, TT_UnaryOperator);
490   EXPECT_TOKEN(Tokens[27], tok::l_square, TT_ArraySubscriptLSquare);
491   EXPECT_TOKEN(Tokens[32], tok::r_brace, TT_StructRBrace);
492 
493   Tokens = annotate("template <typename T, enum E e> struct S {};");
494   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
495   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_StructLBrace);
496 
497   auto Style = getLLVMStyle();
498   Style.AttributeMacros.push_back("EXPORT");
499   Tokens = annotate("struct EXPORT StructName {};", Style);
500   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
501   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_AttributeMacro);
502   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_StructLBrace);
503   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_StructRBrace);
504 }
505 
506 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
507   auto Tokens = annotate("union U {};");
508   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
509   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
510   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_UnionRBrace);
511 
512   Tokens = annotate("union U { void f() { return; } };");
513   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
514   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
515   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
516   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_UnionRBrace);
517 }
518 
519 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
520   auto Tokens = annotate("enum E {};");
521   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
522   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
523   EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_EnumRBrace);
524 }
525 
526 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
527   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
528   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
529   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
530 
531   Tokens = annotate("template <typename T> void F(T) && = delete;");
532   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
533   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
534 }
535 
536 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
537   auto Tokens =
538       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
539   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
540   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
541 }
542 
543 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
544   auto Tokens =
545       annotate("template <typename T> "
546                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
547   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
548   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
549 }
550 
551 TEST_F(TokenAnnotatorTest, UnderstandsTemplatesInMacros) {
552   auto Tokens =
553       annotate("#define FOO(typeName) \\\n"
554                "  { #typeName, foo<FooType>(new foo<realClass>(#typeName)) }");
555   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
556   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
557   EXPECT_TOKEN(Tokens[13], tok::greater, TT_TemplateCloser);
558   EXPECT_TOKEN(Tokens[17], tok::less, TT_TemplateOpener);
559   EXPECT_TOKEN(Tokens[19], tok::greater, TT_TemplateCloser);
560 }
561 
562 TEST_F(TokenAnnotatorTest, UnderstandsGreaterAfterTemplateCloser) {
563   auto Tokens = annotate("if (std::tuple_size_v<T> > 0)");
564   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
565   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
566   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
567   EXPECT_TOKEN(Tokens[8], tok::greater, TT_BinaryOperator);
568 }
569 
570 TEST_F(TokenAnnotatorTest, UnderstandsNonTemplateAngleBrackets) {
571   auto Tokens = annotate("return a < b && c > d;");
572   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
573   EXPECT_TOKEN(Tokens[2], tok::less, TT_BinaryOperator);
574   EXPECT_TOKEN(Tokens[6], tok::greater, TT_BinaryOperator);
575 
576   Tokens = annotate("a < 0 ? b : a > 0 ? c : d;");
577   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
578   EXPECT_TOKEN(Tokens[1], tok::less, TT_BinaryOperator);
579   EXPECT_TOKEN(Tokens[7], tok::greater, TT_BinaryOperator);
580 
581   Tokens = annotate("ratio{-1, 2} < ratio{-1, 3} == -1 / 3 > -1 / 2;");
582   ASSERT_EQ(Tokens.size(), 27u) << Tokens;
583   EXPECT_TOKEN(Tokens[7], tok::less, TT_BinaryOperator);
584   EXPECT_TOKEN(Tokens[20], tok::greater, TT_BinaryOperator);
585 }
586 
587 TEST_F(TokenAnnotatorTest, UnderstandsTemplateTemplateParameters) {
588   auto Tokens = annotate("template <template <typename...> typename X,\n"
589                          "          template <typename...> class Y,\n"
590                          "          typename... T>\n"
591                          "class A {};");
592   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
593   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
594   EXPECT_TOKEN(Tokens[3], tok::less, TT_TemplateOpener);
595   EXPECT_TOKEN(Tokens[6], tok::greater, TT_TemplateCloser);
596   EXPECT_FALSE(Tokens[6]->ClosesTemplateDeclaration);
597   EXPECT_TOKEN(Tokens[11], tok::less, TT_TemplateOpener);
598   EXPECT_TOKEN(Tokens[14], tok::greater, TT_TemplateCloser);
599   EXPECT_FALSE(Tokens[14]->ClosesTemplateDeclaration);
600   EXPECT_TOKEN(Tokens[21], tok::greater, TT_TemplateCloser);
601   EXPECT_TRUE(Tokens[21]->ClosesTemplateDeclaration);
602 }
603 
604 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
605   FormatStyle Style = getLLVMStyle();
606   Style.WhitespaceSensitiveMacros.push_back("FOO");
607 
608   auto Tokens = annotate("FOO(1+2 )", Style);
609   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
610   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
611 
612   Tokens = annotate("FOO(a:b:c)", Style);
613   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
614   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
615 }
616 
617 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
618   auto Tokens = annotate("delete (void *)p;");
619   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
620   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
621 
622   Tokens = annotate("delete[] (void *)p;");
623   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
624   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
625 
626   Tokens = annotate("delete[] /*comment*/ (void *)p;");
627   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
628   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
629 
630   Tokens = annotate("delete[/*comment*/] (void *)p;");
631   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
632   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
633 
634   Tokens = annotate("delete/*comment*/[] (void *)p;");
635   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
636   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
637 }
638 
639 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
640   auto Tokens = annotate("(void)p;");
641   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
642   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
643 
644   Tokens = annotate("(uint32_t)&&label;");
645   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
646   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
647   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_UnaryOperator);
648   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
649 
650   Tokens = annotate("auto x = (Foo)p;");
651   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
652   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
653 
654   Tokens = annotate("(std::vector<int>)p;");
655   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
656   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
657 
658   Tokens = annotate("return (Foo)p;");
659   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
660   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
661 
662   Tokens = annotate("throw (Foo)p;");
663   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
664   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
665 
666   Tokens = annotate("#define FOO(x) (((uint64_t)(x) * BAR) / 100)");
667   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
668   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
669   EXPECT_TOKEN(Tokens[13], tok::r_paren, TT_Unknown);
670   EXPECT_TOKEN(Tokens[14], tok::star, TT_BinaryOperator);
671 
672   Tokens = annotate("#define foo(i) ((i) - bar)");
673   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
674   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_Unknown);
675   EXPECT_TOKEN(Tokens[10], tok::minus, TT_BinaryOperator);
676 
677   Tokens = annotate("return (Foo) & 10;");
678   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
679   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_Unknown);
680   EXPECT_TOKEN(Tokens[4], tok::amp, TT_BinaryOperator);
681 
682   Tokens = annotate("return (struct foo){};");
683   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
684   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
685 
686   Tokens = annotate("#define FOO(bar) foo((uint64_t)&bar)");
687   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
688   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
689   EXPECT_TOKEN(Tokens[11], tok::amp, TT_UnaryOperator);
690 
691   Tokens = annotate("#define FOO(bar) foo((Foo) & bar)");
692   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
693   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_Unknown);
694   EXPECT_TOKEN(Tokens[11], tok::amp, TT_BinaryOperator);
695 
696   auto Style = getLLVMStyle();
697   Style.TypeNames.push_back("Foo");
698   Tokens = annotate("#define FOO(bar) foo((Foo)&bar)", Style);
699   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
700   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_TypeName);
701   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_CastRParen);
702   EXPECT_TOKEN(Tokens[11], tok::amp, TT_UnaryOperator);
703 }
704 
705 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
706   auto Tokens = annotate("void f() throw(int);");
707   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
708   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
709 }
710 
711 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
712   auto Tokens = annotate("void f() &;");
713   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
714   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
715 
716   Tokens = annotate("void operator=(T) &&;");
717   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
718   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
719 
720   Tokens = annotate("template <typename T> void f() &;");
721   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
722   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
723 
724   Tokens = annotate("template <typename T> void operator=(T) &;");
725   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
726   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
727 }
728 
729 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
730   auto Tokens = annotate("x.operator+()");
731   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
732   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
733   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
734   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
735   Tokens = annotate("x.operator=()");
736   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
737   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
738   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
739   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
740   Tokens = annotate("x.operator+=()");
741   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
742   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
743   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
744   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
745   Tokens = annotate("x.operator,()");
746   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
747   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
748   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
749   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
750   Tokens = annotate("x.operator()()");
751   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
752   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
753   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
754   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
755   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
756   Tokens = annotate("x.operator[]()");
757   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
758   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
759   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
760   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
761   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
762   Tokens = annotate("x.operator\"\"_a()");
763   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
764   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
765   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
766   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
767   Tokens = annotate("x.operator\"\" _a()");
768   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
769   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
770   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
771   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
772   Tokens = annotate("x.operator\"\"if()");
773   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
774   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
775   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
776   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
777   Tokens = annotate("x.operator\"\"s()");
778   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
779   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
780   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
781   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
782   Tokens = annotate("x.operator\"\" s()");
783   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
784   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
785   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
786   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
787 
788   Tokens = annotate("int operator+(int);");
789   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
790   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
791   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
792   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
793   Tokens = annotate("auto operator=(T&) {}");
794   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
795   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
796   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
797   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
798   Tokens = annotate("auto operator()() {}");
799   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
800   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
801   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
802   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
803   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
804 
805   Tokens = annotate("class Foo {\n"
806                     "  int operator+(a* b);\n"
807                     "}");
808   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
809   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
810   EXPECT_TOKEN(Tokens[5], tok::plus, TT_OverloadedOperator);
811   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_OverloadedOperatorLParen);
812   EXPECT_TOKEN(Tokens[8], tok::star, TT_PointerOrReference);
813 
814   Tokens = annotate("class Foo {\n"
815                     "  int c = operator+(a * b);\n"
816                     "}");
817   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
818   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_Unknown);
819   EXPECT_TOKEN(Tokens[7], tok::plus, TT_OverloadedOperator);
820   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_OverloadedOperatorLParen);
821   EXPECT_TOKEN(Tokens[10], tok::star, TT_BinaryOperator);
822 
823   Tokens = annotate("void foo() {\n"
824                     "  operator+(a * b);\n"
825                     "}");
826   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
827   EXPECT_TOKEN(Tokens[5], tok::kw_operator, TT_Unknown);
828   EXPECT_TOKEN(Tokens[6], tok::plus, TT_OverloadedOperator);
829   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
830   EXPECT_TOKEN(Tokens[9], tok::star, TT_BinaryOperator);
831 
832   Tokens = annotate("return operator+(a * b, c & d) + operator+(a && b && c);");
833   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
834   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_Unknown);
835   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
836   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
837   EXPECT_TOKEN(Tokens[5], tok::star, TT_BinaryOperator);
838   EXPECT_TOKEN(Tokens[9], tok::amp, TT_BinaryOperator);
839   EXPECT_TOKEN(Tokens[13], tok::kw_operator, TT_Unknown);
840   EXPECT_TOKEN(Tokens[14], tok::plus, TT_OverloadedOperator);
841   EXPECT_TOKEN(Tokens[15], tok::l_paren, TT_OverloadedOperatorLParen);
842   EXPECT_TOKEN(Tokens[17], tok::ampamp, TT_BinaryOperator);
843   EXPECT_TOKEN(Tokens[19], tok::ampamp, TT_BinaryOperator);
844 
845   Tokens = annotate("class Foo {\n"
846                     "  void foo() {\n"
847                     "    operator+(a * b);\n"
848                     "  }\n"
849                     "}");
850   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
851   EXPECT_TOKEN(Tokens[8], tok::kw_operator, TT_Unknown);
852   EXPECT_TOKEN(Tokens[9], tok::plus, TT_OverloadedOperator);
853   EXPECT_TOKEN(Tokens[10], tok::l_paren, TT_OverloadedOperatorLParen);
854   EXPECT_TOKEN(Tokens[12], tok::star, TT_BinaryOperator);
855 
856   Tokens = annotate("std::vector<Foo> operator()(Foo &foo);");
857   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
858   EXPECT_TOKEN(Tokens[3], tok::less, TT_TemplateOpener);
859   EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
860   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_FunctionDeclarationName);
861   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperator);
862   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_OverloadedOperator);
863   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_OverloadedOperatorLParen);
864   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
865 
866   Tokens = annotate("decltype(auto) operator()(T &x);");
867   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
868   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_TypeDeclarationParen);
869   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_TypeDeclarationParen);
870   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
871   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperator);
872   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_OverloadedOperator);
873   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
874   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
875 }
876 
877 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
878   struct {
879     const char *Text;
880     tok::TokenKind Kind;
881   } Operators[] = {{"+", tok::plus},
882                    {"-", tok::minus},
883                    // FIXME:
884                    // {"*", tok::star},
885                    {"/", tok::slash},
886                    {"%", tok::percent},
887                    {"^", tok::caret},
888                    // FIXME:
889                    // {"&", tok::amp},
890                    {"|", tok::pipe},
891                    {"~", tok::tilde},
892                    {"!", tok::exclaim},
893                    {"=", tok::equal},
894                    // FIXME:
895                    // {"<", tok::less},
896                    {">", tok::greater},
897                    {"+=", tok::plusequal},
898                    {"-=", tok::minusequal},
899                    {"*=", tok::starequal},
900                    {"/=", tok::slashequal},
901                    {"%=", tok::percentequal},
902                    {"^=", tok::caretequal},
903                    {"&=", tok::ampequal},
904                    {"|=", tok::pipeequal},
905                    {"<<", tok::lessless},
906                    {">>", tok::greatergreater},
907                    {">>=", tok::greatergreaterequal},
908                    {"<<=", tok::lesslessequal},
909                    {"==", tok::equalequal},
910                    {"!=", tok::exclaimequal},
911                    {"<=", tok::lessequal},
912                    {">=", tok::greaterequal},
913                    {"<=>", tok::spaceship},
914                    {"&&", tok::ampamp},
915                    {"||", tok::pipepipe},
916                    {"++", tok::plusplus},
917                    {"--", tok::minusminus},
918                    {",", tok::comma},
919                    {"->*", tok::arrowstar},
920                    {"->", tok::arrow}};
921 
922   for (const auto &Operator : Operators) {
923     std::string Input("C<&operator");
924     Input += Operator.Text;
925     Input += " > a;";
926     auto Tokens = annotate(std::string(Input));
927     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
928     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
929     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
930     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
931   }
932 
933   auto Tokens = annotate("C<&operator< <X>> lt;");
934   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
935   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
936   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
937   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
938   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
939   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
940 }
941 
942 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
943   auto Tokens = annotate("template <typename T>\n"
944                          "concept C = (Foo && Bar) && (Bar && Baz);");
945 
946   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
947   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
948   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
949   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
950 
951   Tokens = annotate("template <typename T>\n"
952                     "concept C = Foo && !Bar;");
953 
954   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
955   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
956   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
957 
958   Tokens = annotate("template <typename T>\n"
959                     "concept C = requires(T t) {\n"
960                     "  { t.foo() };\n"
961                     "} && Bar<T> && Baz<T>;");
962   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
963   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
964   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
965   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
966   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
967   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
968 
969   Tokens = annotate("template<typename T>\n"
970                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
971                     "struct Foo;");
972   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
973   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
974   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
975   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
976   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
977   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
978   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
979   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
980   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
981   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
982   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
983 
984   Tokens =
985       annotate("template<typename T>\n"
986                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
987                "struct Foo;");
988   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
989   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
990   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
991   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
992   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
993   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
994   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
995   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
996   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
997   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
998   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
999   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
1000 
1001   Tokens = annotate("template <typename T>\n"
1002                     "void foo(T) noexcept requires Bar<T>;");
1003   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1004   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1005 
1006   Tokens = annotate("template <typename T>\n"
1007                     "requires Bar<T> || Baz<T>\n"
1008                     "auto foo(T) -> int;");
1009   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
1010   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1011   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
1012   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1013   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
1014 
1015   Tokens = annotate("template <typename T>\n"
1016                     "requires Bar<T>\n"
1017                     "bool foo(T) { return false; }");
1018   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1019   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1020   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
1021   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
1022 
1023   Tokens = annotate("template <typename T>\n"
1024                     "requires Bar<T>\n"
1025                     "decltype(auto) foo(T) { return false; }");
1026   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
1027   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1028   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
1029   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
1030 
1031   Tokens = annotate("template <typename T>\n"
1032                     "struct S {\n"
1033                     "  void foo() const requires Bar<T>;\n"
1034                     "  void bar() const & requires Baz<T>;\n"
1035                     "  void bar() && requires Baz2<T>;\n"
1036                     "  void baz() const & noexcept requires Baz<T>;\n"
1037                     "  void baz() && noexcept requires Baz2<T>;\n"
1038                     "};\n"
1039                     "\n"
1040                     "void S::bar() const & requires Baz<T> { }");
1041   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
1042   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
1043   EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference);
1044   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
1045   EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference);
1046   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
1047   EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference);
1048   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
1049   EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference);
1050   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
1051   EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference);
1052   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
1053 
1054   Tokens = annotate("void Class::member() && requires(Constant) {}");
1055   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1056   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1057 
1058   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
1059   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1060   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1061 
1062   Tokens =
1063       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
1064   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1065   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1066 
1067   Tokens = annotate("void Class::member() && requires(typename "
1068                     "Namespace::Outer<T>::Inner::Constant) {}");
1069   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
1070   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1071 
1072   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
1073                     "  template<class T>\n"
1074                     "    requires requires { number_zero_v<T>; }\n"
1075                     "  [[nodiscard]] constexpr operator T() const { "
1076                     "return number_zero_v<T>; }\n"
1077                     "};");
1078   ASSERT_EQ(Tokens.size(), 44u) << Tokens;
1079   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
1080   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
1081   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
1082   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
1083   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
1084   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
1085 
1086   Tokens =
1087       annotate("template <class A, class B> concept C ="
1088                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
1089   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
1090   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
1091   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
1092   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
1093   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
1094   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
1095   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
1096   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
1097 
1098   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
1099   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1100   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1101 
1102   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
1103   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1104   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1105 
1106   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
1107   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1108   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1109 
1110   Tokens =
1111       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
1112   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1113   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1114 
1115   Tokens =
1116       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
1117   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1118   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1119 
1120   Tokens =
1121       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
1122   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1123   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
1124 
1125   Tokens = annotate("void foo() requires((A<T>) && C) {}");
1126   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1127   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1128   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_BinaryOperator);
1129 
1130   Tokens = annotate("void foo() requires(((A<T>) && C)) {}");
1131   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1132   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1133   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
1134 
1135   Tokens = annotate("void foo() requires([](T&&){}(t)) {}");
1136   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1137   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1138   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1139 
1140   Tokens = annotate("void foo() requires([](T&& u){}(t)) {}");
1141   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
1142   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1143   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1144 
1145   Tokens = annotate("void f() & requires(true) {}");
1146   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1147   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1148   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1149 
1150   Tokens = annotate("void f() & requires(C<true, true>) {}");
1151   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1152   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1153   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1154 
1155   Tokens = annotate("template <typename T>\n"
1156                     "concept C = (!Foo<T>) && Bar;");
1157   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1158   EXPECT_TOKEN(Tokens[15], tok::ampamp, TT_BinaryOperator);
1159 
1160   Tokens = annotate("void f() & requires(C<decltype(x)>) {}");
1161   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1162   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1163   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1164 
1165   Tokens = annotate("auto f() -> int& requires(C<decltype(x)>) {}");
1166   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1167   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1168   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
1169 
1170   Tokens = annotate("bool x = t && requires(decltype(t) x) { x.foo(); };");
1171   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1172   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresExpression);
1173 
1174   Tokens = annotate("bool x = t && requires(Foo<decltype(t)> x) { x.foo(); };");
1175   ASSERT_EQ(Tokens.size(), 26u) << Tokens;
1176   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresExpression);
1177 
1178   Tokens = annotate("bool x = t && requires(Foo<C1 || C2> x) { x.foo(); };");
1179   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1180   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresExpression);
1181 }
1182 
1183 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
1184   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
1185   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1186   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1187   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1188   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1189 
1190   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
1191   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1192   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1193   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1194   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
1195 
1196   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
1197   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1198   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
1199   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
1200   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
1201 
1202   Tokens = annotate("foo(requires(const T t) {});");
1203   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1204   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1205   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1206   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1207 
1208   Tokens = annotate("foo(requires(const int t) {});");
1209   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1210   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1211   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1212   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1213 
1214   Tokens = annotate("foo(requires(const T t) {});");
1215   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1216   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1217   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1218   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1219 
1220   Tokens = annotate("foo(requires(int const* volatile t) {});");
1221   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1222   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1223   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1224   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1225   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1226 
1227   Tokens = annotate("foo(requires(T const* volatile t) {});");
1228   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1229   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1230   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1231   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1232   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1233 
1234   Tokens = annotate("foo(requires(T& t) {});");
1235   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1236   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1237   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1238   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
1239   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1240 
1241   Tokens = annotate("foo(requires(T&& t) {});");
1242   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1243   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1244   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1245   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
1246   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1247 
1248   Tokens = annotate("bool foo = requires(T& t) {};");
1249   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1250   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1251   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1252   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1253   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1254 
1255   Tokens = annotate("bool foo = requires(T&& t) {};");
1256   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1257   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1258   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1259   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
1260   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1261 
1262   Tokens =
1263       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
1264   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1265   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1266   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1267   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
1268   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
1269 
1270   Tokens = annotate("template <typename T>\n"
1271                     "concept C = requires(T T) {\n"
1272                     "  requires Bar<T> && Foo<T>;\n"
1273                     "};");
1274   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
1275   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1276   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1277   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1278   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
1279                TT_RequiresClauseInARequiresExpression);
1280 
1281   Tokens = annotate("template <typename T>\n"
1282                     "concept C = requires(T T) {\n"
1283                     "  { t.func() } -> std::same_as<int>;"
1284                     "  requires Bar<T> && Foo<T>;\n"
1285                     "};");
1286   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
1287   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1288   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1289   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1290   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
1291                TT_RequiresClauseInARequiresExpression);
1292 
1293   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
1294   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
1295                     "requires true; };");
1296   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1297   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1298   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1299   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
1300 
1301   Tokens = annotate("bool foo = requires(C<true, true> c) {\n"
1302                     "  { c.foo(); }\n"
1303                     "};");
1304   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1305   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1306   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1307   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1308 }
1309 
1310 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
1311   // Everything after #pragma region should be ImplicitStringLiteral
1312   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
1313   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1314   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
1315   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
1316   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
1317 
1318   // Make sure it's annotated correctly inside a function as well
1319   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
1320   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1321   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
1322   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
1323   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
1324 }
1325 
1326 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
1327   const char *BaseCode = nullptr;
1328   const char *ConstrainedCode = nullptr;
1329   auto BaseTokenCount = 0u;
1330   auto RequiresTokenCount = 0u;
1331   auto PrefixTokenCount = 0u;
1332 
1333   auto TestRequires = [&](int Line) {
1334     const auto BaseTokens = annotate(BaseCode);
1335     const auto ConstrainedTokens = annotate(ConstrainedCode);
1336 
1337 #define LINE " (Line " << Line << ')'
1338 
1339     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
1340     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
1341         << LINE;
1342 
1343     for (auto I = 0u; I < BaseTokenCount; ++I) {
1344       EXPECT_EQ(
1345           *BaseTokens[I],
1346           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
1347           << I << LINE;
1348     }
1349 
1350 #undef LINE
1351   };
1352 
1353   BaseCode = "template<typename T>\n"
1354              "T Pi = 3.14;";
1355   ConstrainedCode = "template<typename T>\n"
1356                     "  requires Foo<T>\n"
1357                     "T Pi = 3.14;";
1358   BaseTokenCount = 11;
1359   RequiresTokenCount = 5;
1360   PrefixTokenCount = 5;
1361   TestRequires(__LINE__);
1362 
1363   BaseCode = "template<typename T>\n"
1364              "struct Bar;";
1365   ConstrainedCode = "template<typename T>\n"
1366                     "  requires Foo<T>\n"
1367                     "struct Bar;";
1368   BaseTokenCount = 9;
1369   TestRequires(__LINE__);
1370 
1371   BaseCode = "template<typename T>\n"
1372              "struct Bar {\n"
1373              "  T foo();\n"
1374              "  T bar();\n"
1375              "};";
1376   ConstrainedCode = "template<typename T>\n"
1377                     "  requires Foo<T>\n"
1378                     "struct Bar {\n"
1379                     "  T foo();\n"
1380                     "  T bar();\n"
1381                     "};";
1382   BaseTokenCount = 21;
1383   TestRequires(__LINE__);
1384 
1385   BaseCode = "template<typename T>\n"
1386              "Bar(T) -> Bar<T>;";
1387   ConstrainedCode = "template<typename T>\n"
1388                     "  requires Foo<T>\n"
1389                     "Bar(T) -> Bar<T>;";
1390   BaseTokenCount = 16;
1391   TestRequires(__LINE__);
1392 
1393   BaseCode = "template<typename T>\n"
1394              "T foo();";
1395   ConstrainedCode = "template<typename T>\n"
1396                     "  requires Foo<T>\n"
1397                     "T foo();";
1398   BaseTokenCount = 11;
1399   TestRequires(__LINE__);
1400 
1401   BaseCode = "template<typename T>\n"
1402              "T foo() {\n"
1403              "  auto bar = baz();\n"
1404              "  return bar + T{};\n"
1405              "}";
1406   ConstrainedCode = "template<typename T>\n"
1407                     "  requires Foo<T>\n"
1408                     "T foo() {\n"
1409                     "  auto bar = baz();\n"
1410                     "  return bar + T{};\n"
1411                     "}";
1412   BaseTokenCount = 26;
1413   TestRequires(__LINE__);
1414 
1415   BaseCode = "template<typename T>\n"
1416              "T foo();";
1417   ConstrainedCode = "template<typename T>\n"
1418                     "T foo() requires Foo<T>;";
1419   BaseTokenCount = 11;
1420   PrefixTokenCount = 9;
1421   TestRequires(__LINE__);
1422 
1423   BaseCode = "template<typename T>\n"
1424              "T foo() {\n"
1425              "  auto bar = baz();\n"
1426              "  return bar + T{};\n"
1427              "}";
1428   ConstrainedCode = "template<typename T>\n"
1429                     "T foo() requires Foo<T> {\n"
1430                     "  auto bar = baz();\n"
1431                     "  return bar + T{};\n"
1432                     "}";
1433   BaseTokenCount = 26;
1434   TestRequires(__LINE__);
1435 
1436   BaseCode = "template<typename T>\n"
1437              "T foo();";
1438   ConstrainedCode = "template<typename T>\n"
1439                     "  requires(Foo<T>)\n"
1440                     "T foo();";
1441   BaseTokenCount = 11;
1442   RequiresTokenCount = 7;
1443   PrefixTokenCount = 5;
1444   TestRequires(__LINE__);
1445 
1446   BaseCode = "template<typename T>\n"
1447              "Bar(T) -> Bar<typename T::I>;";
1448   ConstrainedCode = "template<typename T>\n"
1449                     "  requires requires(T &&t) {\n"
1450                     "             typename T::I;\n"
1451                     "           }\n"
1452                     "Bar(T) -> Bar<typename T::I>;";
1453   BaseTokenCount = 19;
1454   RequiresTokenCount = 14;
1455   PrefixTokenCount = 5;
1456   TestRequires(__LINE__);
1457 
1458   BaseCode = "struct [[nodiscard]] zero_t {\n"
1459              "  template<class T>\n"
1460              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1461              "};";
1462   ConstrainedCode =
1463       "struct [[nodiscard]] zero_t {\n"
1464       "  template<class T>\n"
1465       "    requires requires { v<T>; }\n"
1466       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1467       "};";
1468   BaseTokenCount = 35;
1469   RequiresTokenCount = 9;
1470   PrefixTokenCount = 13;
1471   TestRequires(__LINE__);
1472 
1473   BaseCode = "constexpr Foo(Foo const &other)\n"
1474              "    : value{other.value} {\n"
1475              "  do_magic();\n"
1476              "  do_more_magic();\n"
1477              "}";
1478   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1479                     "  requires std::is_copy_constructible<T>\n"
1480                     "    : value{other.value} {\n"
1481                     "  do_magic();\n"
1482                     "  do_more_magic();\n"
1483                     "}";
1484   BaseTokenCount = 26;
1485   RequiresTokenCount = 7;
1486   PrefixTokenCount = 8;
1487   TestRequires(__LINE__);
1488 
1489   BaseCode = "constexpr Foo(Foo const &other)\n"
1490              "    : value{other.value} {\n"
1491              "  do_magic();\n"
1492              "  do_more_magic();\n"
1493              "}";
1494   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1495                     "  requires (std::is_copy_constructible<T>)\n"
1496                     "    : value{other.value} {\n"
1497                     "  do_magic();\n"
1498                     "  do_more_magic();\n"
1499                     "}";
1500   RequiresTokenCount = 9;
1501   TestRequires(__LINE__);
1502 
1503   BaseCode = "template<typename T>\n"
1504              "ANNOTATE(\"S\"\n"
1505              "         \"S\")\n"
1506              "void foo();";
1507   ConstrainedCode = "template<typename T>\n"
1508                     "  requires(true)\n"
1509                     "ANNOTATE(\"S\"\n"
1510                     "         \"S\")\n"
1511                     "void foo();";
1512   BaseTokenCount = 16;
1513   RequiresTokenCount = 4;
1514   PrefixTokenCount = 5;
1515   TestRequires(__LINE__);
1516 }
1517 
1518 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1519   auto Tokens = annotate("__asm{\n"
1520                          "\"a\":\n"
1521                          ": x\n"
1522                          ":};");
1523   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1524   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1525   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1526   EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
1527   EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
1528   EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
1529   EXPECT_TOKEN(Tokens[7], tok::r_brace, TT_InlineASMBrace);
1530 
1531   Tokens = annotate("__asm(\n"
1532                     "\"a\":\n"
1533                     ": x\n"
1534                     ":);");
1535   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1536   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1537   EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
1538   EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
1539   EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
1540 
1541   Tokens = annotate("asm volatile (\n"
1542                     "\"a_label:\"\n"
1543                     ":\n"
1544                     ": x\n"
1545                     ":);");
1546   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1547   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1548   EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
1549   EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
1550   EXPECT_TOKEN(Tokens[7], tok::colon, TT_InlineASMColon);
1551 
1552   Tokens = annotate("__asm__(\n"
1553                     "\"a_label:\"\n"
1554                     ": x\n"
1555                     ":\n"
1556                     ": y);");
1557   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1558   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1559   EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
1560   EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
1561   EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
1562 
1563   Tokens = annotate("__asm volatile (\n"
1564                     "\"a_label:\"\n"
1565                     "\"a b c(%%x)\"\n"
1566                     ":\n"
1567                     ": x\n"
1568                     ":);");
1569   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1570   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1571   EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
1572   EXPECT_TOKEN(Tokens[6], tok::colon, TT_InlineASMColon);
1573   EXPECT_TOKEN(Tokens[8], tok::colon, TT_InlineASMColon);
1574 
1575   Tokens = annotate("asm(\n"
1576                     "\"insn\"\n"
1577                     ": \"=r\" (var1), \"=&r\" (value)\n"
1578                     ":\n"
1579                     ": \"memory\");");
1580   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1581   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1582   EXPECT_TOKEN(Tokens[3], tok::colon, TT_InlineASMColon);
1583   EXPECT_TOKEN(Tokens[13], tok::colon, TT_InlineASMColon);
1584   EXPECT_TOKEN(Tokens[14], tok::colon, TT_InlineASMColon);
1585 
1586   Tokens = annotate("__asm__ volatile (\n"
1587                     "\"ldr r1, [r0, %%[sym]]\"\n"
1588                     ":\n"
1589                     ": [sym] \"J\" (aaaaa(aaaa, aaaa))\n"
1590                     ");");
1591   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1592   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1593   EXPECT_TOKEN(Tokens[4], tok::colon, TT_InlineASMColon);
1594   EXPECT_TOKEN(Tokens[5], tok::colon, TT_InlineASMColon);
1595   EXPECT_TOKEN(Tokens[6], tok::l_square, TT_InlineASMSymbolicNameLSquare);
1596 }
1597 
1598 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1599   auto Tokens = annotate("int (^)() = ^ ()\n"
1600                          "  external_source_symbol() { //\n"
1601                          "  return 1;\n"
1602                          "};");
1603   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1604   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1605   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1606 
1607   Tokens = annotate("int *p = ^int*(){ //\n"
1608                     "  return nullptr;\n"
1609                     "}();");
1610   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1611   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1612 }
1613 
1614 TEST_F(TokenAnnotatorTest, UnderstandsObjCMethodExpr) {
1615   auto Tokens = annotate("void f() {\n"
1616                          "  //\n"
1617                          "  BOOL a = [b.c n] > 1;\n"
1618                          "}");
1619   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1620   EXPECT_TOKEN(Tokens[9], tok::l_square, TT_ObjCMethodExpr);
1621   EXPECT_TOKEN(Tokens[15], tok::greater, TT_BinaryOperator);
1622 }
1623 
1624 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1625   auto Tokens = annotate("[]() constexpr {}");
1626   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1627   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1628   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1629 
1630   Tokens = annotate("[]() consteval {}");
1631   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1632   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1633   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1634 
1635   Tokens = annotate("[]() mutable {}");
1636   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1637   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1638   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1639 
1640   Tokens = annotate("[]() static {}");
1641   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1642   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1643   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1644 
1645   Tokens = annotate("[]() -> auto {}");
1646   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1647   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1648   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1649   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1650 
1651   Tokens = annotate("[]() -> auto & {}");
1652   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1653   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1654   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1655   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1656 
1657   Tokens = annotate("[]() -> auto * {}");
1658   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1659   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1660   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1661   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1662 
1663   Tokens = annotate("[] {}");
1664   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1665   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1666   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1667 
1668   Tokens = annotate("[] noexcept {}");
1669   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1670   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1671   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1672 
1673   Tokens = annotate("[] -> auto {}");
1674   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1675   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1676   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_TrailingReturnArrow);
1677   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1678 
1679   Tokens = annotate("[] -> struct S { return {}; }");
1680   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1681   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1682   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_TrailingReturnArrow);
1683   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1684 
1685   Tokens = annotate("foo([&](u32 bar) __attribute__((attr)) -> void {});");
1686   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
1687   EXPECT_TOKEN(Tokens[2], tok::l_square, TT_LambdaLSquare);
1688   EXPECT_TOKEN(Tokens[15], tok::arrow, TT_TrailingReturnArrow);
1689   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1690 
1691   Tokens = annotate("[] <typename T> () {}");
1692   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1693   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1694   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1695   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1696 
1697   Tokens = annotate("[] <typename T> {}");
1698   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1699   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1700   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1701   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1702 
1703   Tokens = annotate("[] <typename... T> () {}");
1704   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1705   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1706   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1707   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1708 
1709   Tokens = annotate("[] <typename... T> {}");
1710   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1711   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1712   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1713   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1714 
1715   Tokens = annotate("[] <int... T> () {}");
1716   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1717   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1718   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1719   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1720 
1721   Tokens = annotate("[] <int... T> {}");
1722   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1723   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1724   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1725   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1726 
1727   Tokens = annotate("[] <Foo... T> () {}");
1728   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1729   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1730   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1731   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1732 
1733   Tokens = annotate("[] <Foo... T> {}");
1734   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1735   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1736   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1737   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1738 
1739   // Lambdas with a requires-clause
1740   Tokens = annotate("[] <typename T> (T t) requires Bar<T> {}");
1741   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1742   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1743   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1744   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1745   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1746   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1747 
1748   Tokens = annotate("[] <typename T> (T &&t) requires Bar<T> {}");
1749   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1750   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1751   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1752   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_PointerOrReference);
1753   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1754   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1755   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1756 
1757   Tokens = annotate("[] <typename T> (T t) requires Foo<T> || Bar<T> {}");
1758   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1759   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1760   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1761   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1762   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1763   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1764 
1765   Tokens = annotate("[] <typename T> (T t) -> T requires Bar<T> {}");
1766   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1767   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1768   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1769   EXPECT_TOKEN(Tokens[10], tok::arrow, TT_TrailingReturnArrow);
1770   EXPECT_TOKEN(Tokens[12], tok::kw_requires, TT_RequiresClause);
1771   EXPECT_TRUE(Tokens[16]->ClosesRequiresClause);
1772   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1773 
1774   Tokens = annotate("[] <typename T> requires Bar<T> (T t) {}");
1775   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1776   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1777   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1778   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1779   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1780   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1781 
1782   Tokens = annotate("[] <typename T> requires Bar<T> (T &&t) {}");
1783   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1784   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1785   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1786   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1787   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1788   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_PointerOrReference);
1789   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1790 
1791   Tokens = annotate("[] <typename T> requires Foo<T> || Bar<T> (T t) {}");
1792   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1793   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1794   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1795   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1796   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1797   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1798 
1799   Tokens = annotate("[] <typename T> requires true (T&& t) {}");
1800   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1801   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1802   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1803   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1804   EXPECT_TRUE(Tokens[7]->ClosesRequiresClause);
1805   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1806   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1807 
1808   Tokens = annotate("[] <typename T> requires Bar<T> {}");
1809   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1810   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1811   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1812   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1813   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1814   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_LambdaLBrace);
1815 
1816   Tokens = annotate("[] <typename T> requires Bar<T> noexcept {}");
1817   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1818   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1819   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1820   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1821   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1822   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1823 
1824   Tokens = annotate("[] <typename T> requires Bar<T> -> T {}");
1825   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1826   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1827   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1828   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1829   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1830   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_TrailingReturnArrow);
1831   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1832 
1833   Tokens = annotate("[] <typename T> requires Foo<T> (T t) requires Bar<T> {}");
1834   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1835   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1836   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1837   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1838   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1839   EXPECT_TOKEN(Tokens[15], tok::kw_requires, TT_RequiresClause);
1840   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1841   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1842 
1843   Tokens = annotate("[] <typename T = int> (T t) {}");
1844   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1845   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1846   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1847   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1848   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1849 
1850   Tokens = annotate("[] <int I = 0> (T t) {}");
1851   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1852   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1853   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1854   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1855   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1856 
1857   Tokens = annotate("[] <bool b = false> (T t) {}");
1858   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1859   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1860   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1861   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1862   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1863 
1864   Tokens = annotate("[] <bool b = true && false> (T&& t) {}");
1865   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1866   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1867   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1868   EXPECT_TOKEN(Tokens[7], tok::ampamp, TT_BinaryOperator);
1869   EXPECT_TOKEN(Tokens[9], tok::greater, TT_TemplateCloser);
1870   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_PointerOrReference);
1871   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1872 
1873   Tokens = annotate("[] <typename T = int> requires Foo<T> (T t) {}");
1874   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1875   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1876   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1877   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1878   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1879   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1880 }
1881 
1882 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1883   auto Tokens = annotate("template <typename T>\n"
1884                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1885                          "string OldFunction(const string &parameter) {}");
1886   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1887   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1888 
1889   Tokens = annotate("template <typename T>\n"
1890                     "A(T) noexcept;");
1891   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1892   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1893 }
1894 
1895 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1896   auto Tokens = annotate("void f [[noreturn]] ();");
1897   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1898   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1899 
1900   Tokens = annotate("void f [[noreturn]] () {}");
1901   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1902   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1903 
1904   Tokens = annotate("#define FOO Foo::\n"
1905                     "FOO Foo();");
1906   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1907   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_FunctionDeclarationName);
1908 
1909   Tokens = annotate("struct Foo {\n"
1910                     "  Bar (*func)();\n"
1911                     "};");
1912   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1913   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
1914   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_FunctionTypeLParen);
1915 
1916   Tokens = annotate("void instanceof();");
1917   ASSERT_EQ(Tokens.size(), 6u);
1918   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1919 
1920   Tokens = annotate("int iso_time(time_t);");
1921   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1922   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1923 
1924   auto Style = getLLVMStyle();
1925   Style.TypeNames.push_back("MyType");
1926   Tokens = annotate("int iso_time(MyType);", Style);
1927   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1928   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1929   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_TypeName);
1930 }
1931 
1932 TEST_F(TokenAnnotatorTest, UnderstandsCtorAndDtorDeclNames) {
1933   auto Tokens = annotate("class Foo { public: Foo(); };");
1934   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1935   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_CtorDtorDeclName);
1936 
1937   Tokens = annotate("class Foo { public: ~Foo(); };");
1938   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1939   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_CtorDtorDeclName);
1940 
1941   Tokens = annotate("struct Foo { [[deprecated]] Foo() {} };");
1942   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1943   EXPECT_TOKEN(Tokens[8], tok::identifier, TT_CtorDtorDeclName);
1944   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1945 
1946   Tokens = annotate("struct Foo { [[deprecated]] ~Foo() {} };");
1947   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1948   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1949   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1950 
1951   Tokens = annotate("struct Foo { Foo() [[deprecated]] {} };");
1952   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1953   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1954   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1955 
1956   Tokens = annotate("struct Foo { ~Foo() [[deprecated]] {} };");
1957   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1958   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_CtorDtorDeclName);
1959   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1960 
1961   Tokens = annotate("struct Foo { [[deprecated]] explicit Foo() {} };");
1962   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1963   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1964   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1965 
1966   Tokens = annotate("struct Foo { virtual [[deprecated]] ~Foo() {} };");
1967   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1968   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_CtorDtorDeclName);
1969   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1970 
1971   Tokens = annotate("Foo::Foo() {}");
1972   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1973   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_CtorDtorDeclName);
1974   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
1975 
1976   Tokens = annotate("Foo::~Foo() {}");
1977   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1978   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1979   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
1980 
1981   Tokens = annotate("struct Test {\n"
1982                     "  Test()\n"
1983                     "      : l([] {\n"
1984                     "          Short::foo();\n"
1985                     "        }) {}\n"
1986                     "};");
1987   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1988   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1989   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_Unknown);
1990 }
1991 
1992 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1993   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1994   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1995   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1996   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1997   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1998 }
1999 
2000 TEST_F(TokenAnnotatorTest, UnderstandsTrailingReturnArrow) {
2001   auto Tokens = annotate("auto f() -> int;");
2002   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2003   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
2004 
2005   Tokens = annotate("auto operator->() -> int;");
2006   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2007   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_OverloadedOperator);
2008   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
2009 
2010   Tokens = annotate("auto operator++(int) -> int;");
2011   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2012   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
2013 
2014   Tokens = annotate("auto operator=() -> int;");
2015   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2016   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
2017 
2018   Tokens = annotate("auto operator=(int) -> int;");
2019   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2020   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
2021 
2022   Tokens = annotate("auto foo() -> auto { return Val; }");
2023   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2024   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
2025 
2026   Tokens = annotate("struct S { auto bar() const -> int; };");
2027   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2028   EXPECT_TOKEN(Tokens[8], tok::arrow, TT_TrailingReturnArrow);
2029 
2030   // Not trailing return arrows
2031   Tokens = annotate("auto a = b->c;");
2032   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2033   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
2034 
2035   Tokens = annotate("auto a = (b)->c;");
2036   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2037   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
2038 
2039   Tokens = annotate("auto a = b()->c;");
2040   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2041   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
2042 
2043   Tokens = annotate("auto a = b->c();");
2044   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2045   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
2046 
2047   Tokens = annotate("decltype(auto) a = b()->c;");
2048   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2049   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
2050 
2051   Tokens = annotate("void f() { auto a = b->c(); }");
2052   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2053   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
2054 
2055   Tokens = annotate("void f() { auto a = b()->c; }");
2056   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2057   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_Unknown);
2058 
2059   Tokens = annotate("#define P(ptr) auto p = (ptr)->p");
2060   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
2061   EXPECT_TOKEN(Tokens[12], tok::arrow, TT_Unknown);
2062 
2063   Tokens = annotate("void f() FOO(foo->bar);");
2064   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2065   EXPECT_TOKEN(Tokens[7], tok::arrow, TT_Unknown);
2066 
2067   Tokens = annotate("__attribute__((cold)) C() : Base(obj->func()) {}");
2068   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
2069   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
2070 
2071   // Mixed
2072   Tokens = annotate("auto f() -> int { auto a = b()->c; }");
2073   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
2074   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
2075   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
2076 }
2077 
2078 TEST_F(TokenAnnotatorTest, UnderstandHashInMacro) {
2079   auto Tokens = annotate("#define Foo(Bar) \\\n"
2080                          "  { \\\n"
2081                          "    #Bar \\\n"
2082                          "  }");
2083   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2084   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
2085   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
2086 
2087   Tokens = annotate("#define Foo(Bar) \\\n"
2088                     "  { #Bar }");
2089   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2090   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
2091   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
2092 
2093   Tokens = annotate("#define FOO(typeName, realClass) \\\n"
2094                     "  {#typeName, foo<Foo>(new foo<realClass>(#typeName))}");
2095   ASSERT_EQ(Tokens.size(), 29u) << Tokens;
2096   EXPECT_BRACE_KIND(Tokens[8], BK_BracedInit);
2097   EXPECT_BRACE_KIND(Tokens[27], BK_BracedInit);
2098 }
2099 
2100 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacros) {
2101   // '__attribute__' has special handling.
2102   auto Tokens = annotate("__attribute__((X)) void Foo(void);");
2103   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2104   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
2105   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2106   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2107 
2108   // Generic macro has no special handling in this location.
2109   Tokens = annotate("A(X) void Foo(void);");
2110   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2111   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2112   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_Unknown);
2113 
2114   // Add a custom AttributeMacro. Test that it has the same behavior.
2115   FormatStyle Style = getLLVMStyle();
2116   Style.AttributeMacros.push_back("A");
2117 
2118   // An "AttributeMacro" gets annotated like '__attribute__'.
2119   Tokens = annotate("A(X) void Foo(void);", Style);
2120   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2121   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
2122   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2123   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
2124 }
2125 
2126 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCDecl) {
2127   // '__attribute__' has special handling.
2128   auto Tokens = annotate("__attribute__((X)) @interface Foo");
2129   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2130   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
2131   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2132   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2133 
2134   // Generic macro has no special handling in this location.
2135   Tokens = annotate("A(X) @interface Foo");
2136   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2137   // Note: Don't check token-type as a random token in this position is hard to
2138   // reason about.
2139   EXPECT_TOKEN_KIND(Tokens[0], tok::identifier);
2140   EXPECT_TOKEN_KIND(Tokens[1], tok::l_paren);
2141 
2142   // Add a custom AttributeMacro. Test that it has the same behavior.
2143   FormatStyle Style = getLLVMStyle();
2144   Style.AttributeMacros.push_back("A");
2145 
2146   // An "AttributeMacro" gets annotated like '__attribute__'.
2147   Tokens = annotate("A(X) @interface Foo", Style);
2148   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2149   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
2150   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
2151   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
2152 }
2153 
2154 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCMethodDecl) {
2155   // '__attribute__' has special handling.
2156   auto Tokens = annotate("- (id)init __attribute__((X));");
2157   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2158   EXPECT_TOKEN(Tokens[5], tok::kw___attribute, TT_Unknown);
2159   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
2160   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
2161 
2162   // Generic macro has no special handling in this location.
2163   Tokens = annotate("- (id)init A(X);");
2164   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2165   // Note: Don't check token-type as a random token in this position is hard to
2166   // reason about.
2167   EXPECT_TOKEN_KIND(Tokens[5], tok::identifier);
2168   EXPECT_TOKEN_KIND(Tokens[6], tok::l_paren);
2169 
2170   // Add a custom AttributeMacro. Test that it has the same behavior.
2171   FormatStyle Style = getLLVMStyle();
2172   Style.AttributeMacros.push_back("A");
2173 
2174   // An "AttributeMacro" gets annotated like '__attribute__'.
2175   Tokens = annotate("- (id)init A(X);", Style);
2176   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2177   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_AttributeMacro);
2178   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
2179   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
2180 }
2181 
2182 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCProperty) {
2183   // '__attribute__' has special handling.
2184   auto Tokens = annotate("@property(weak) id delegate __attribute__((X));");
2185   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
2186   EXPECT_TOKEN(Tokens[7], tok::kw___attribute, TT_Unknown);
2187   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
2188   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_AttributeRParen);
2189 
2190   // Generic macro has no special handling in this location.
2191   Tokens = annotate("@property(weak) id delegate A(X);");
2192   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2193   // Note: Don't check token-type as a random token in this position is hard to
2194   // reason about.
2195   EXPECT_TOKEN_KIND(Tokens[7], tok::identifier);
2196   EXPECT_TOKEN_KIND(Tokens[8], tok::l_paren);
2197 
2198   // Add a custom AttributeMacro. Test that it has the same behavior.
2199   FormatStyle Style = getLLVMStyle();
2200   Style.AttributeMacros.push_back("A");
2201 
2202   // An "AttributeMacro" gets annotated like '__attribute__'.
2203   Tokens = annotate("@property(weak) id delegate A(X);", Style);
2204   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2205   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_AttributeMacro);
2206   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
2207   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
2208 }
2209 
2210 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
2211   auto Annotate = [this](StringRef Code) {
2212     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
2213   };
2214   // Test that unary operators get labeled as such and that operators like '++'
2215   // don't get split.
2216   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
2217                             tok::tilde, tok::amp,      tok::pipe,
2218                             tok::caret, tok::plusplus, tok::minusminus};
2219   for (auto Kind : Unary) {
2220     auto Tokens =
2221         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
2222     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2223     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
2224   }
2225   // Operators formed by joining two operators like '^~'. For some of these
2226   // joined operators, we don't have a separate type, so we only test for their
2227   // precedence.
2228   std::pair<prec::Level, std::string> JoinedBinary[] = {
2229       {prec::Comma, "->"},        {prec::Comma, "<->"},
2230       {prec::Assignment, "+="},   {prec::Assignment, "-="},
2231       {prec::Assignment, "*="},   {prec::Assignment, "/="},
2232       {prec::Assignment, "%="},   {prec::Assignment, "&="},
2233       {prec::Assignment, "^="},   {prec::Assignment, "<<="},
2234       {prec::Assignment, ">>="},  {prec::Assignment, "<<<="},
2235       {prec::Assignment, ">>>="}, {prec::LogicalOr, "||"},
2236       {prec::LogicalAnd, "&&"},   {prec::Equality, "=="},
2237       {prec::Equality, "!="},     {prec::Equality, "==="},
2238       {prec::Equality, "!=="},    {prec::Equality, "==?"},
2239       {prec::Equality, "!=?"},    {prec::ExclusiveOr, "~^"},
2240       {prec::ExclusiveOr, "^~"},
2241   };
2242   for (auto Operator : JoinedBinary) {
2243     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
2244     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2245     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
2246     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
2247   }
2248   // '~^' and '^~' can be unary as well as binary operators.
2249   auto Tokens = Annotate("x = ~^x;");
2250   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2251   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
2252   Tokens = Annotate("x = ^~x;");
2253   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2254   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
2255   // The unary operators '~&' and '~|' can only be unary operators. The current
2256   // implementation treats each of them as separate unary '~' and '&' or '|'
2257   // operators, which is enough for formatting purposes. In FormatTestVerilog,
2258   // there is a test that there is no space in between. And even if a new line
2259   // is inserted between the '~' and '|', the semantic meaning is the same as
2260   // the joined operator, so the CanBreakBefore property doesn't need to be
2261   // false for the second operator.
2262   Tokens = Annotate("x = ~&x;");
2263   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2264   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2265   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
2266   Tokens = Annotate("x = ~|x;");
2267   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2268   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2269   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
2270   // Test for block label colons.
2271   Tokens = Annotate("begin : x\n"
2272                     "end : x");
2273   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2274   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
2275   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
2276   // Test that the dimension colon is annotated correctly.
2277   Tokens = Annotate("var [1 : 0] x;");
2278   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2279   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
2280   Tokens = Annotate("extern function [1 : 0] x;");
2281   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2282   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
2283   Tokens = Annotate("module test\n"
2284                     "    (input wire [7 : 0] a[7 : 0]);\n"
2285                     "endmodule");
2286   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2287   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_VerilogDimensionedTypeName);
2288   EXPECT_TOKEN(Tokens[7], tok::colon, TT_BitFieldColon);
2289   EXPECT_TOKEN(Tokens[13], tok::colon, TT_BitFieldColon);
2290   // Test case labels and ternary operators.
2291   Tokens = Annotate("case (x)\n"
2292                     "  x:\n"
2293                     "    x;\n"
2294                     "endcase");
2295   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2296   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CaseLabelColon);
2297   Tokens = Annotate("case (x)\n"
2298                     "  x ? x : x:\n"
2299                     "    x;\n"
2300                     "endcase");
2301   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2302   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
2303   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
2304   EXPECT_TOKEN(Tokens[9], tok::colon, TT_CaseLabelColon);
2305   // Non-blocking assignments.
2306   Tokens = Annotate("a <= b;");
2307   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2308   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2309   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2310   Tokens = Annotate("if (a <= b) break;");
2311   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2312   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2313   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2314   Tokens = Annotate("a <= b <= a;");
2315   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2316   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2317   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2318   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2319   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2320 
2321   // Port lists in module instantiation.
2322   Tokens = Annotate("module_x instance_1(port_1), instance_2(port_2);");
2323   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2324   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2325   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_VerilogInstancePortLParen);
2326   Tokens = Annotate("module_x #(parameter) instance_1(port_1), "
2327                     "instance_2(port_2);");
2328   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2329   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2330   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_VerilogInstancePortLParen);
2331   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_VerilogInstancePortLParen);
2332 
2333   // Condition parentheses.
2334   Tokens = Annotate("assert (x);");
2335   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2336   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2337   Tokens = Annotate("assert #0 (x);");
2338   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2339   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_ConditionLParen);
2340   Tokens = Annotate("assert final (x);");
2341   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2342   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2343   Tokens = Annotate("foreach (x[x]) continue;");
2344   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2345   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2346   Tokens = Annotate("repeat (x[x]) continue;");
2347   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2348   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2349   Tokens = Annotate("case (x) endcase;");
2350   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2351   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2352 
2353   // Sensitivity list. The TT_Unknown type is clearly not binding for the
2354   // future, please adapt if those tokens get annotated.  This test is only here
2355   // to prevent the comma from being annotated as TT_VerilogInstancePortComma.
2356   Tokens = Annotate("always @(posedge x, posedge y);");
2357   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2358   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_Unknown);
2359   EXPECT_TOKEN(Tokens[5], tok::comma, TT_Unknown);
2360   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2361 
2362   // String literals in concatenation.
2363   Tokens = Annotate("x = {\"\"};");
2364   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2365   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2366   Tokens = Annotate("x = {\"\", \"\"};");
2367   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2368   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2369   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2370   Tokens = Annotate("x = '{{\"\"}};");
2371   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2372   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2373   // Cases where the string should not be annotated that type.  Fix the
2374   // `TT_Unknown` if needed in the future.
2375   Tokens = Annotate("x = {\"\" == \"\"};");
2376   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2377   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_Unknown);
2378   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_Unknown);
2379   Tokens = Annotate("x = {(\"\")};");
2380   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2381   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2382   Tokens = Annotate("x = '{\"\"};");
2383   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2384   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2385 }
2386 
2387 TEST_F(TokenAnnotatorTest, UnderstandTableGenTokens) {
2388   auto Style = getLLVMStyle(FormatStyle::LK_TableGen);
2389   ASSERT_TRUE(Style.isTableGen());
2390 
2391   TestLexer Lexer(Allocator, Buffers, Style);
2392   AdditionalKeywords Keywords(Lexer.IdentTable);
2393   auto Annotate = [&Lexer](StringRef Code) { return Lexer.annotate(Code); };
2394 
2395   // Additional keywords representation test.
2396   auto Tokens = Annotate("def foo : Bar<1>;");
2397   ASSERT_TRUE(Keywords.isTableGenKeyword(*Tokens[0]));
2398   ASSERT_TRUE(Keywords.isTableGenDefinition(*Tokens[0]));
2399   ASSERT_TRUE(Tokens[0]->is(Keywords.kw_def));
2400   ASSERT_TRUE(Tokens[1]->is(TT_StartOfName));
2401 
2402   // Code, the multiline string token.
2403   Tokens = Annotate("[{ code is multiline string }]");
2404   ASSERT_EQ(Tokens.size(), 2u) << Tokens;
2405   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2406   EXPECT_FALSE(Tokens[0]->IsMultiline);
2407   // Case with multiple lines.
2408   Tokens = Annotate("[{ It can break\n"
2409                     "   across lines and the line breaks\n"
2410                     "   are retained in \n"
2411                     "   the string. }]");
2412   ASSERT_EQ(Tokens.size(), 2u) << Tokens;
2413   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2414   EXPECT_EQ(Tokens[0]->ColumnWidth, sizeof("[{ It can break\n") - 1);
2415   EXPECT_TRUE(Tokens[0]->IsMultiline);
2416   EXPECT_EQ(Tokens[0]->LastLineColumnWidth, sizeof("   the string. }]") - 1);
2417 
2418   // Numeric literals.
2419   Tokens = Annotate("1234");
2420   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2421   Tokens = Annotate("-1");
2422   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2423   Tokens = Annotate("+1234");
2424   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2425   Tokens = Annotate("0b0110");
2426   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2427   Tokens = Annotate("0x1abC");
2428   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2429 
2430   // Identifier tokens. In TableGen, identifiers can begin with a number.
2431   // In ambiguous cases, the lexer tries to lex it as a number.
2432   // Even if the try fails, it does not fall back to identifier lexing and
2433   // regard as an error.
2434   // The ambiguity is not documented. The result of those tests are based on the
2435   // implementation of llvm::TGLexer::LexToken.
2436   // This is invalid syntax of number, but not an identifier.
2437   Tokens = Annotate("0x1234x");
2438   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2439   Tokens = Annotate("identifier");
2440   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2441   // Identifier beginning with a number.
2442   Tokens = Annotate("0x");
2443   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2444   Tokens = Annotate("2dVector");
2445   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2446   Tokens = Annotate("01234Vector");
2447   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2448 
2449   // Structured statements.
2450   Tokens = Annotate("class Foo {}");
2451   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_FunctionLBrace);
2452   Tokens = Annotate("def Def: Foo {}");
2453   EXPECT_TOKEN(Tokens[2], tok::colon, TT_InheritanceColon);
2454   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2455   Tokens = Annotate("if cond then {} else {}");
2456   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ControlStatementLBrace);
2457   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_ElseLBrace);
2458   Tokens = Annotate("defset Foo Def2 = {}");
2459   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2460 
2461   // Bang Operators.
2462   Tokens = Annotate("!foreach");
2463   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenBangOperator);
2464   Tokens = Annotate("!if");
2465   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenBangOperator);
2466   Tokens = Annotate("!cond");
2467   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenCondOperator);
2468 
2469   auto AnnotateValue = [this, &Style](StringRef Code) {
2470     // Values are annotated only in specific context.
2471     auto Result = annotate(("def X { let V = " + Code + "; }").str(), Style);
2472     return decltype(Result){Result.begin() + 6, Result.end() - 3};
2473   };
2474   // Both of bang/cond operators.
2475   Tokens = AnnotateValue("!cond(!eq(x, 0): 1, true: x)");
2476   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
2477   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TableGenCondOperator);
2478   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_TableGenBangOperator);
2479   EXPECT_TOKEN(Tokens[8], tok::colon, TT_TableGenCondOperatorColon);
2480   EXPECT_TOKEN(Tokens[10], tok::comma, TT_TableGenCondOperatorComma);
2481   EXPECT_TOKEN(Tokens[12], tok::colon, TT_TableGenCondOperatorColon);
2482   // DAGArg values with operator identifier
2483   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2484   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2485   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpener);
2486   EXPECT_TOKEN(Tokens[3], tok::colon, TT_TableGenDAGArgListColon);
2487   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown); // $src1
2488   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListComma);
2489   EXPECT_TOKEN(Tokens[7], tok::colon, TT_TableGenDAGArgListColon);
2490   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2491   // List literal
2492   Tokens = AnnotateValue("[1, 2, 3]");
2493   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2494   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_TableGenListOpener);
2495   EXPECT_TOKEN(Tokens[6], tok::r_square, TT_TableGenListCloser);
2496   // Suffixes of values
2497   Tokens = AnnotateValue("valid.field");
2498   ASSERT_EQ(Tokens.size(), 3u) << Tokens;
2499   EXPECT_TOKEN(Tokens[1], tok::period, TT_TableGenValueSuffix);
2500   // Code
2501   Tokens = AnnotateValue("[{ code is multiline string }]");
2502   ASSERT_EQ(Tokens.size(), 1u) << Tokens;
2503   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2504 
2505   // The definition
2506   Tokens = annotate("def Def : Parent<Child> {}", Style);
2507   ASSERT_EQ(Tokens.size(), 10u) << Tokens; // This contains eof.
2508   // We use inheritance colon and function brace. They are enough.
2509   EXPECT_TOKEN(Tokens[2], tok::colon, TT_InheritanceColon);
2510   EXPECT_TOKEN(Tokens[4], tok::less, TT_TemplateOpener);
2511   EXPECT_TOKEN(Tokens[6], tok::greater, TT_TemplateCloser);
2512   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
2513 
2514   // DAGArg breaking options. They use different token types depending on what
2515   // is specified.
2516   Style.TableGenBreakInsideDAGArg = FormatStyle::DAS_BreakElements;
2517 
2518   // When TableGenBreakInsideDAGArg is DAS_BreakElements and
2519   // TableGenBreakingDAGArgOperators is not specified, it makes all the DAGArg
2520   // elements to have line break.
2521   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2522   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2523   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2524   EXPECT_TOKEN(Tokens[1], tok::identifier,
2525                TT_TableGenDAGArgOperatorID); // ins
2526   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2527   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2528 
2529   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2530   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2531   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2532   EXPECT_TOKEN(Tokens[1], tok::identifier,
2533                TT_TableGenDAGArgOperatorID); // other
2534   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2535   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2536 
2537   // For non-identifier operators, breaks after the operator.
2538   Tokens = AnnotateValue("(!cast<Type>(\"Name\") type1:$src1, type2:$src2)");
2539   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2540   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2541   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_TableGenDAGArgOperatorToBreak);
2542   EXPECT_TOKEN(Tokens[11], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2543   EXPECT_TOKEN(Tokens[15], tok::r_paren, TT_TableGenDAGArgCloser);
2544 
2545   Style.TableGenBreakInsideDAGArg = FormatStyle::DAS_BreakAll;
2546 
2547   // When TableGenBreakInsideDAGArg is DAS_BreakAll and
2548   // TableGenBreakingDAGArgOperators is not specified, it makes all the DAGArg
2549   // to have line break inside it.
2550   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2551   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2552   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2553   EXPECT_TOKEN(Tokens[1], tok::identifier,
2554                TT_TableGenDAGArgOperatorToBreak); // ins
2555   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2556   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2557 
2558   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2559   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2560   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2561   EXPECT_TOKEN(Tokens[1], tok::identifier,
2562                TT_TableGenDAGArgOperatorToBreak); // other
2563   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2564   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2565 
2566   // If TableGenBreakingDAGArgOperators is specified, it is limited to the
2567   // specified operators.
2568   Style.TableGenBreakingDAGArgOperators = {"ins", "outs"};
2569   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2570   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2571   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpenerToBreak);
2572   EXPECT_TOKEN(Tokens[1], tok::identifier,
2573                TT_TableGenDAGArgOperatorToBreak); // ins
2574   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListCommaToBreak);
2575   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2576 
2577   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2578   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2579   EXPECT_TOKEN(Tokens[0], tok::l_paren, TT_TableGenDAGArgOpener);
2580   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_Unknown); // other
2581   EXPECT_TOKEN(Tokens[5], tok::comma, TT_TableGenDAGArgListComma);
2582   EXPECT_TOKEN(Tokens[9], tok::r_paren, TT_TableGenDAGArgCloser);
2583 
2584   // If TableGenBreakingDAGArgOperators is enabled, it uses
2585   // TT_TableGenDAGArgListColonToAlign to annotate the colon to align.
2586   Style.AlignConsecutiveTableGenBreakingDAGArgColons.Enabled = true;
2587   Tokens = AnnotateValue("(ins type1:$src1, type2:$src2)");
2588   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2589   EXPECT_TOKEN(Tokens[1], tok::identifier,
2590                TT_TableGenDAGArgOperatorToBreak); // ins
2591   EXPECT_TOKEN(Tokens[3], tok::colon, TT_TableGenDAGArgListColonToAlign);
2592   EXPECT_TOKEN(Tokens[7], tok::colon, TT_TableGenDAGArgListColonToAlign);
2593 
2594   Tokens = AnnotateValue("(other type1:$src1, type2:$src2)");
2595   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2596   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_Unknown); // other
2597   EXPECT_TOKEN(Tokens[3], tok::colon, TT_TableGenDAGArgListColon);
2598   EXPECT_TOKEN(Tokens[7], tok::colon, TT_TableGenDAGArgListColon);
2599 }
2600 
2601 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
2602   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
2603 
2604   // The TT_Unknown is clearly not binding for the future, please adapt if those
2605   // tokens get annotated.
2606   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2607   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2608   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2609   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
2610   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2611   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2612   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2613   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
2614   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
2615   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2616   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2617 
2618   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
2619   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2620   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2621   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2622   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
2623   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
2624   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2625   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2626   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
2627   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
2628   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2629   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2630 
2631   Tokens = annotate("class Class {\n"
2632                     "  Class() : BaseClass() {\n"
2633                     "#if 0\n"
2634                     "    // comment\n"
2635                     "#endif\n"
2636                     "  }\n"
2637                     "  Class f();\n"
2638                     "}");
2639   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
2640   EXPECT_TOKEN(Tokens[6], tok::colon, TT_CtorInitializerColon);
2641   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_FunctionLBrace);
2642   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2643 }
2644 
2645 TEST_F(TokenAnnotatorTest, UnderstandsConditionParens) {
2646   auto Tokens = annotate("if (x) {}");
2647   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2648   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2649   Tokens = annotate("if constexpr (x) {}");
2650   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2651   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2652   Tokens = annotate("if CONSTEXPR (x) {}");
2653   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2654   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2655   Tokens = annotate("if (x) {} else if (x) {}");
2656   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2657   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2658   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_ConditionLParen);
2659 }
2660 
2661 TEST_F(TokenAnnotatorTest, CSharpNullableTypes) {
2662   FormatStyle Style = getGoogleStyle(FormatStyle::LK_CSharp);
2663 
2664   auto Tokens = annotate("int? a;", Style);
2665   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2666   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2667 
2668   Tokens = annotate("int? a = 1;", Style);
2669   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2670   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2671 
2672   Tokens = annotate("int?)", Style);
2673   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
2674   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2675 
2676   Tokens = annotate("int?>", Style);
2677   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
2678   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2679 
2680   Tokens = annotate("cond? id : id2", Style);
2681   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2682   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2683 
2684   Tokens = annotate("cond ? cond2 ? : id1 : id2", Style);
2685   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2686   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2687 }
2688 
2689 TEST_F(TokenAnnotatorTest, UnderstandsLabels) {
2690   auto Tokens = annotate("{ x: break; }");
2691   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2692   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2693 
2694   Tokens = annotate("{ case x: break; }");
2695   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2696   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2697 
2698   Tokens = annotate("{ x: { break; } }");
2699   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2700   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2701 
2702   Tokens = annotate("{ case x: { break; } }");
2703   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2704   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2705 
2706   Tokens = annotate("#define FOO label:");
2707   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2708   EXPECT_TOKEN(Tokens[4], tok::colon, TT_GotoLabelColon);
2709 
2710   Tokens = annotate("#define FOO \\\n"
2711                     "label: \\\n"
2712                     "  break;");
2713   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2714   EXPECT_TOKEN(Tokens[4], tok::colon, TT_GotoLabelColon);
2715 }
2716 
2717 TEST_F(TokenAnnotatorTest, UnderstandsNestedBlocks) {
2718   // The closing braces are not annotated. It doesn't seem to cause a problem.
2719   // So we only test for the opening braces.
2720   auto Tokens = annotate("{\n"
2721                          "  {\n"
2722                          "    { int a = 0; }\n"
2723                          "  }\n"
2724                          "  {}\n"
2725                          "}");
2726   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2727   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2728   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
2729   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
2730   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2731 }
2732 
2733 TEST_F(TokenAnnotatorTest, UnderstandDesignatedInitializers) {
2734   auto Tokens = annotate("SomeStruct { .a = 1 };");
2735   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2736   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2737   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2738 
2739   Tokens = annotate("SomeStruct { .a = 1, .b = 2 };");
2740   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2741   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2742   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2743   EXPECT_TOKEN(Tokens[7], tok::period, TT_DesignatedInitializerPeriod);
2744 
2745   Tokens = annotate("SomeStruct {\n"
2746                     "#ifdef FOO\n"
2747                     "  .a = 1,\n"
2748                     "#endif\n"
2749                     "  .b = 2\n"
2750                     "};");
2751   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2752   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2753   EXPECT_TOKEN(Tokens[5], tok::period, TT_DesignatedInitializerPeriod);
2754   EXPECT_TOKEN(Tokens[12], tok::period, TT_DesignatedInitializerPeriod);
2755 
2756   Tokens = annotate("SomeStruct {\n"
2757                     "#if defined FOO\n"
2758                     "  .a = 1,\n"
2759                     "#endif\n"
2760                     "  .b = 2\n"
2761                     "};");
2762   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2763   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2764   EXPECT_TOKEN(Tokens[6], tok::period, TT_DesignatedInitializerPeriod);
2765   EXPECT_TOKEN(Tokens[13], tok::period, TT_DesignatedInitializerPeriod);
2766 
2767   Tokens = annotate("Foo foo[] = {[0]{}};");
2768   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2769   EXPECT_TOKEN(Tokens[6], tok::l_square, TT_DesignatedInitializerLSquare);
2770   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
2771 }
2772 
2773 TEST_F(TokenAnnotatorTest, UnderstandsJavaScript) {
2774   auto Annotate = [this](StringRef Code) {
2775     return annotate(Code, getLLVMStyle(FormatStyle::LK_JavaScript));
2776   };
2777 
2778   // Dictionary.
2779   auto Tokens = Annotate("var x = {'x' : 1, 'y' : 2};");
2780   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2781   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_DictLiteral);
2782   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_SelectorName);
2783   EXPECT_TOKEN(Tokens[5], tok::colon, TT_DictLiteral);
2784   EXPECT_TOKEN(Tokens[8], tok::string_literal, TT_SelectorName);
2785   EXPECT_TOKEN(Tokens[9], tok::colon, TT_DictLiteral);
2786   // Change when we need to annotate these.
2787   EXPECT_BRACE_KIND(Tokens[3], BK_Unknown);
2788   EXPECT_BRACE_KIND(Tokens[11], BK_Unknown);
2789   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_Unknown);
2790 }
2791 
2792 TEST_F(TokenAnnotatorTest, UnderstandsAttributes) {
2793   auto Tokens = annotate("bool foo __attribute__((unused));");
2794   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2795   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_StartOfName);
2796   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2797   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_Unknown);
2798   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_Unknown);
2799   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_AttributeRParen);
2800 
2801   Tokens = annotate("bool foo __declspec(dllimport);");
2802   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2803   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2804   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2805 
2806   Tokens = annotate("bool __attribute__((unused)) foo;");
2807   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2808   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_AttributeLParen);
2809   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_Unknown);
2810   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_Unknown);
2811   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_AttributeRParen);
2812   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_StartOfName);
2813 
2814   Tokens = annotate("void __attribute__((x)) Foo();");
2815   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2816   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_AttributeLParen);
2817   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_Unknown);
2818   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_Unknown);
2819   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_AttributeRParen);
2820   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_FunctionDeclarationName);
2821 
2822   FormatStyle Style = getLLVMStyle();
2823   Style.AttributeMacros.push_back("FOO");
2824   Tokens = annotate("bool foo FOO(unused);", Style);
2825   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2826   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
2827   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2828   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2829 }
2830 
2831 TEST_F(TokenAnnotatorTest, UnderstandsControlStatements) {
2832   auto Tokens = annotate("while (true) {}");
2833   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2834   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2835   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2836 
2837   Tokens = annotate("for (;;) {}");
2838   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2839   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_ControlStatementLBrace);
2840   EXPECT_TOKEN(Tokens[6], tok::r_brace, TT_ControlStatementRBrace);
2841 
2842   Tokens = annotate("do {} while (true);");
2843   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2844   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_ControlStatementLBrace);
2845   EXPECT_TOKEN(Tokens[2], tok::r_brace, TT_ControlStatementRBrace);
2846 
2847   Tokens = annotate("if (true) {} else if (false) {} else {}");
2848   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
2849   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2850   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2851   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_ControlStatementLBrace);
2852   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_ControlStatementRBrace);
2853   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_ElseLBrace);
2854   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_ElseRBrace);
2855 
2856   Tokens = annotate("switch (foo) {}");
2857   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2858   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2859   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2860 }
2861 
2862 TEST_F(TokenAnnotatorTest, UnderstandsDoWhile) {
2863   auto Tokens = annotate("do { ++i; } while ( i > 5 );");
2864   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2865   EXPECT_TOKEN(Tokens[6], tok::kw_while, TT_DoWhile);
2866 
2867   Tokens = annotate("do ++i; while ( i > 5 );");
2868   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2869   EXPECT_TOKEN(Tokens[4], tok::kw_while, TT_DoWhile);
2870 }
2871 
2872 TEST_F(TokenAnnotatorTest, StartOfName) {
2873   auto Tokens = annotate("#pragma clang diagnostic push");
2874   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2875   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2876   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2877   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
2878 
2879   Tokens = annotate("#pragma clang diagnostic ignored \"-Wzero-length-array\"");
2880   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2881   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2882   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2883   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
2884 
2885   Tokens = annotate("#define FOO Foo foo");
2886   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2887   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2888   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2889   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_StartOfName);
2890 
2891   Tokens = annotate("@interface NSCoder (TestCoder)");
2892   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2893   EXPECT_TOKEN(Tokens[0], tok::at, TT_ObjCDecl);
2894   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_StartOfName);
2895 }
2896 
2897 TEST_F(TokenAnnotatorTest, BraceKind) {
2898   auto Tokens = annotate("void f() {};");
2899   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2900   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2901   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2902   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2903   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2904 
2905   Tokens = annotate("class Foo<int> f() {}");
2906   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2907   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_FunctionDeclarationName);
2908   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_FunctionLBrace);
2909   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
2910   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
2911 
2912   Tokens = annotate("template <typename T> class Foo<T> f() {}");
2913   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2914   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_FunctionDeclarationName);
2915   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2916   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2917   EXPECT_BRACE_KIND(Tokens[14], BK_Block);
2918 
2919   Tokens = annotate("void f() override {};");
2920   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2921   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2922   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
2923   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2924   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2925 
2926   Tokens = annotate("void f() noexcept(false) {};");
2927   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2928   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2929   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_FunctionLBrace);
2930   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
2931   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
2932 
2933   Tokens = annotate("auto f() -> void {};");
2934   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2935   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2936   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
2937   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2938   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
2939 
2940   Tokens = annotate("void f() { /**/ };");
2941   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2942   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2943   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2944   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2945   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2946 
2947   Tokens = annotate("void f() { //\n"
2948                     "};");
2949   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2950   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2951   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2952   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2953   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2954 
2955   Tokens = annotate("void f() {\n"
2956                     "  //\n"
2957                     "};");
2958   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2959   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2960   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2961   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2962   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2963 
2964   Tokens = annotate("struct Foo {\n"
2965                     "  Foo() {};\n"
2966                     "  ~Foo() {};\n"
2967                     "};");
2968   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2969   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
2970   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
2971   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2972   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
2973   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_CtorDtorDeclName);
2974   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2975   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2976   EXPECT_BRACE_KIND(Tokens[14], BK_Block);
2977 
2978   Tokens = annotate("{\n"
2979                     "  char *a[] = {\n"
2980                     "      /* abc */ \"abc\",\n"
2981                     "#if FOO\n"
2982                     "      /* xyz */ \"xyz\",\n"
2983                     "#endif\n"
2984                     "      /* last */ \"last\"};\n"
2985                     "}");
2986   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
2987   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2988   EXPECT_BRACE_KIND(Tokens[7], BK_BracedInit);
2989   EXPECT_BRACE_KIND(Tokens[21], BK_BracedInit);
2990 
2991   Tokens =
2992       annotate("#define SCOP_STAT(NAME, DESC) \\\n"
2993                "  {\"polly\", #NAME, \"Number of rejected regions: \" DESC}");
2994   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
2995   EXPECT_BRACE_KIND(Tokens[8], BK_BracedInit);
2996   EXPECT_BRACE_KIND(Tokens[16], BK_BracedInit);
2997 
2998   Tokens = annotate("struct {};");
2999   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
3000   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
3001   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
3002 
3003   Tokens = annotate("struct : Base {};");
3004   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
3005   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
3006   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3007 
3008   Tokens = annotate("struct Foo {};");
3009   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
3010   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
3011   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
3012 
3013   Tokens = annotate("struct ::Foo {};");
3014   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
3015   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
3016   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3017 
3018   Tokens = annotate("struct NS::Foo {};");
3019   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
3020   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3021   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
3022 
3023   Tokens = annotate("struct Foo<int> {};");
3024   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
3025   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
3026   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
3027 
3028   Tokens = annotate("struct Foo<int>::Bar {};");
3029   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
3030   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
3031   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
3032 
3033   Tokens = annotate("struct Foo<int> : Base {};");
3034   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
3035   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
3036   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
3037 
3038   Tokens = annotate("struct Foo final {};");
3039   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
3040   EXPECT_BRACE_KIND(Tokens[3], BK_Block);
3041   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3042 
3043   Tokens = annotate("struct [[foo]] [[bar]] Foo final : Base1, Base2 {};");
3044   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
3045   EXPECT_BRACE_KIND(Tokens[17], BK_Block);
3046   EXPECT_BRACE_KIND(Tokens[18], BK_Block);
3047 
3048   Tokens = annotate("struct Foo x{};");
3049   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
3050   EXPECT_BRACE_KIND(Tokens[3], BK_BracedInit);
3051   EXPECT_BRACE_KIND(Tokens[4], BK_BracedInit);
3052 
3053   Tokens = annotate("struct ::Foo x{};");
3054   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
3055   EXPECT_BRACE_KIND(Tokens[4], BK_BracedInit);
3056   EXPECT_BRACE_KIND(Tokens[5], BK_BracedInit);
3057 
3058   Tokens = annotate("struct NS::Foo x{};");
3059   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
3060   EXPECT_BRACE_KIND(Tokens[5], BK_BracedInit);
3061   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
3062 
3063   Tokens = annotate("struct Foo<int> x{};");
3064   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
3065   EXPECT_BRACE_KIND(Tokens[6], BK_BracedInit);
3066   EXPECT_BRACE_KIND(Tokens[7], BK_BracedInit);
3067 
3068   Tokens = annotate("#ifdef DEBUG_ENABLED\n"
3069                     "#else\n"
3070                     "#endif\n"
3071                     "class RenderingServer : Object {\n"
3072                     "#ifndef DISABLE_DEPRECATED\n"
3073                     "  enum Features {\n"
3074                     "    FEATURE_SHADERS,\n"
3075                     "    FEATURE_MULTITHREADED,\n"
3076                     "  };\n"
3077                     "#endif\n"
3078                     "};");
3079   ASSERT_EQ(Tokens.size(), 29u) << Tokens;
3080   EXPECT_BRACE_KIND(Tokens[11], BK_Block);
3081   EXPECT_BRACE_KIND(Tokens[17], BK_Block);
3082   EXPECT_BRACE_KIND(Tokens[22], BK_Block);
3083   EXPECT_BRACE_KIND(Tokens[26], BK_Block);
3084 }
3085 
3086 TEST_F(TokenAnnotatorTest, UnderstandsElaboratedTypeSpecifier) {
3087   auto Tokens = annotate("auto foo() -> enum En {}");
3088   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
3089   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
3090 }
3091 
3092 TEST_F(TokenAnnotatorTest, BlockLBrace) {
3093   auto Tokens = annotate("{\n"
3094                          "  {\n"
3095                          "    foo();\n"
3096                          "  }\n"
3097                          "}");
3098   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
3099   EXPECT_TOKEN(Tokens[0], tok::l_brace, TT_BlockLBrace);
3100   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
3101   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_BlockLBrace);
3102   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
3103 
3104   Tokens = annotate("void bar() {\n"
3105                     "  {\n"
3106                     "    foo();\n"
3107                     "  }\n"
3108                     "}");
3109   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
3110   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
3111   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
3112   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_BlockLBrace);
3113   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
3114 }
3115 
3116 TEST_F(TokenAnnotatorTest, SwitchExpression) {
3117   auto Style = getLLVMStyle(FormatStyle::LK_Java);
3118   auto Tokens = annotate("i = switch (day) {\n"
3119                          "  case THURSDAY, SATURDAY -> 8;\n"
3120                          "  case WEDNESDAY -> 9;\n"
3121                          "  default -> 1;\n"
3122                          "};",
3123                          Style);
3124   ASSERT_EQ(Tokens.size(), 26u) << Tokens;
3125   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_SwitchExpressionLBrace);
3126   EXPECT_TOKEN(Tokens[7], tok::kw_case, TT_SwitchExpressionLabel);
3127   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_CaseLabelArrow);
3128   EXPECT_TOKEN(Tokens[14], tok::kw_case, TT_SwitchExpressionLabel);
3129   EXPECT_TOKEN(Tokens[16], tok::arrow, TT_CaseLabelArrow);
3130   EXPECT_TOKEN(Tokens[19], tok::kw_default, TT_SwitchExpressionLabel);
3131   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_CaseLabelArrow);
3132 }
3133 
3134 TEST_F(TokenAnnotatorTest, CppAltOperatorKeywords) {
3135   auto Tokens = annotate("a = b and c;");
3136   ASSERT_EQ(Tokens.size(), 7u);
3137   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_BinaryOperator);
3138 
3139   Tokens = annotate("a = b and_eq c;");
3140   ASSERT_EQ(Tokens.size(), 7u);
3141   EXPECT_TOKEN(Tokens[3], tok::ampequal, TT_BinaryOperator);
3142 
3143   Tokens = annotate("a = b bitand c;");
3144   ASSERT_EQ(Tokens.size(), 7u);
3145   EXPECT_TOKEN(Tokens[3], tok::amp, TT_BinaryOperator);
3146 
3147   Tokens = annotate("a = b bitor c;");
3148   ASSERT_EQ(Tokens.size(), 7u);
3149   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_BinaryOperator);
3150 
3151   Tokens = annotate("a = b compl c;");
3152   ASSERT_EQ(Tokens.size(), 7u);
3153   EXPECT_TOKEN(Tokens[3], tok::tilde, TT_UnaryOperator);
3154 
3155   Tokens = annotate("a = b not c;");
3156   ASSERT_EQ(Tokens.size(), 7u);
3157   EXPECT_TOKEN(Tokens[3], tok::exclaim, TT_UnaryOperator);
3158 
3159   Tokens = annotate("a = b not_eq c;");
3160   ASSERT_EQ(Tokens.size(), 7u);
3161   EXPECT_TOKEN(Tokens[3], tok::exclaimequal, TT_BinaryOperator);
3162 
3163   Tokens = annotate("a = b or c;");
3164   ASSERT_EQ(Tokens.size(), 7u);
3165   EXPECT_TOKEN(Tokens[3], tok::pipepipe, TT_BinaryOperator);
3166 
3167   Tokens = annotate("a = b or_eq c;");
3168   ASSERT_EQ(Tokens.size(), 7u);
3169   EXPECT_TOKEN(Tokens[3], tok::pipeequal, TT_BinaryOperator);
3170 
3171   Tokens = annotate("a = b xor c;");
3172   ASSERT_EQ(Tokens.size(), 7u);
3173   EXPECT_TOKEN(Tokens[3], tok::caret, TT_BinaryOperator);
3174 
3175   Tokens = annotate("a = b xor_eq c;");
3176   ASSERT_EQ(Tokens.size(), 7u);
3177   EXPECT_TOKEN(Tokens[3], tok::caretequal, TT_BinaryOperator);
3178 
3179   Tokens = annotate("xor = foo;");
3180   ASSERT_EQ(Tokens.size(), 5u);
3181   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
3182 
3183   Tokens = annotate("int xor = foo;");
3184   ASSERT_EQ(Tokens.size(), 6u);
3185   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_StartOfName);
3186 }
3187 
3188 TEST_F(TokenAnnotatorTest, FunctionTryBlock) {
3189   auto Tokens =
3190       annotate("Foo::Foo(int x, int y) try\n"
3191                "    : foo{[] -> std::string { return {}; }(), x}, bar{y} {\n"
3192                "} catch (...) {\n"
3193                "}");
3194   ASSERT_EQ(Tokens.size(), 45u);
3195   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_CtorDtorDeclName);
3196   EXPECT_TOKEN(Tokens[11], tok::colon, TT_CtorInitializerColon);
3197   EXPECT_TOKEN(Tokens[14], tok::l_square, TT_LambdaLSquare);
3198   EXPECT_TOKEN(Tokens[16], tok::arrow, TT_TrailingReturnArrow);
3199   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
3200   EXPECT_TOKEN(Tokens[31], tok::comma, TT_CtorInitializerComma);
3201   EXPECT_TOKEN(Tokens[36], tok::l_brace, TT_FunctionLBrace);
3202 }
3203 
3204 TEST_F(TokenAnnotatorTest, TypenameMacro) {
3205   auto Style = getLLVMStyle();
3206   Style.TypenameMacros.push_back("STRUCT");
3207 
3208   auto Tokens = annotate("STRUCT(T, B) { int i; };", Style);
3209   ASSERT_EQ(Tokens.size(), 13u);
3210   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_TypenameMacro);
3211   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_TypeDeclarationParen);
3212   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_TypeDeclarationParen);
3213   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_Unknown);
3214 }
3215 
3216 } // namespace
3217 } // namespace format
3218 } // namespace clang
3219