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