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