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