xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision f826f55b2ab68c2515fae751dc2d6ef77f37b172)
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 
625 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
626   auto Tokens = annotate("void f() throw(int);");
627   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
628   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
629 }
630 
631 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
632   auto Tokens = annotate("void f() &;");
633   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
634   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
635 
636   Tokens = annotate("void operator=(T) &&;");
637   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
638   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
639 
640   Tokens = annotate("template <typename T> void f() &;");
641   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
642   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
643 
644   Tokens = annotate("template <typename T> void operator=(T) &;");
645   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
646   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
647 }
648 
649 TEST_F(TokenAnnotatorTest, UnderstandsOverloadedOperators) {
650   auto Tokens = annotate("x.operator+()");
651   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
652   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
653   EXPECT_TOKEN(Tokens[3], tok::plus, TT_OverloadedOperator);
654   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
655   Tokens = annotate("x.operator=()");
656   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
657   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
658   EXPECT_TOKEN(Tokens[3], tok::equal, TT_OverloadedOperator);
659   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
660   Tokens = annotate("x.operator+=()");
661   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
662   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
663   EXPECT_TOKEN(Tokens[3], tok::plusequal, TT_OverloadedOperator);
664   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
665   Tokens = annotate("x.operator,()");
666   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
667   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
668   EXPECT_TOKEN(Tokens[3], tok::comma, TT_OverloadedOperator);
669   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
670   Tokens = annotate("x.operator()()");
671   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
672   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
673   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperator);
674   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_OverloadedOperator);
675   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
676   Tokens = annotate("x.operator[]()");
677   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
678   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
679   // EXPECT_TOKEN(Tokens[3], tok::l_square, TT_OverloadedOperator);
680   // EXPECT_TOKEN(Tokens[4], tok::r_square, TT_OverloadedOperator);
681   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
682   Tokens = annotate("x.operator\"\"_a()");
683   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
684   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
685   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
686   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
687   Tokens = annotate("x.operator\"\" _a()");
688   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
689   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
690   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
691   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
692   Tokens = annotate("x.operator\"\"if()");
693   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
694   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
695   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
696   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
697   Tokens = annotate("x.operator\"\"s()");
698   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
699   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
700   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
701   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
702   Tokens = annotate("x.operator\"\" s()");
703   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
704   EXPECT_TOKEN(Tokens[2], tok::kw_operator, TT_Unknown);
705   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_OverloadedOperator);
706   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperatorLParen);
707 
708   Tokens = annotate("int operator+(int);");
709   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
710   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
711   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
712   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
713   Tokens = annotate("auto operator=(T&) {}");
714   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
715   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
716   EXPECT_TOKEN(Tokens[2], tok::equal, TT_OverloadedOperator);
717   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
718   Tokens = annotate("auto operator()() {}");
719   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
720   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_FunctionDeclarationName);
721   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_OverloadedOperator);
722   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_OverloadedOperator);
723   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_OverloadedOperatorLParen);
724 
725   Tokens = annotate("class Foo {\n"
726                     "  int operator+(a* b);\n"
727                     "}");
728   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
729   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
730   EXPECT_TOKEN(Tokens[5], tok::plus, TT_OverloadedOperator);
731   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_OverloadedOperatorLParen);
732   EXPECT_TOKEN(Tokens[8], tok::star, TT_PointerOrReference);
733 
734   Tokens = annotate("class Foo {\n"
735                     "  int c = operator+(a * b);\n"
736                     "}");
737   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
738   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_Unknown);
739   EXPECT_TOKEN(Tokens[7], tok::plus, TT_OverloadedOperator);
740   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_OverloadedOperatorLParen);
741   EXPECT_TOKEN(Tokens[10], tok::star, TT_BinaryOperator);
742 
743   Tokens = annotate("void foo() {\n"
744                     "  operator+(a * b);\n"
745                     "}");
746   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
747   EXPECT_TOKEN(Tokens[5], tok::kw_operator, TT_Unknown);
748   EXPECT_TOKEN(Tokens[6], tok::plus, TT_OverloadedOperator);
749   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
750   EXPECT_TOKEN(Tokens[9], tok::star, TT_BinaryOperator);
751 
752   Tokens = annotate("return operator+(a * b, c & d) + operator+(a && b && c);");
753   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
754   EXPECT_TOKEN(Tokens[1], tok::kw_operator, TT_Unknown);
755   EXPECT_TOKEN(Tokens[2], tok::plus, TT_OverloadedOperator);
756   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_OverloadedOperatorLParen);
757   EXPECT_TOKEN(Tokens[5], tok::star, TT_BinaryOperator);
758   EXPECT_TOKEN(Tokens[9], tok::amp, TT_BinaryOperator);
759   EXPECT_TOKEN(Tokens[13], tok::kw_operator, TT_Unknown);
760   EXPECT_TOKEN(Tokens[14], tok::plus, TT_OverloadedOperator);
761   EXPECT_TOKEN(Tokens[15], tok::l_paren, TT_OverloadedOperatorLParen);
762   EXPECT_TOKEN(Tokens[17], tok::ampamp, TT_BinaryOperator);
763   EXPECT_TOKEN(Tokens[19], tok::ampamp, TT_BinaryOperator);
764 
765   Tokens = annotate("class Foo {\n"
766                     "  void foo() {\n"
767                     "    operator+(a * b);\n"
768                     "  }\n"
769                     "}");
770   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
771   EXPECT_TOKEN(Tokens[8], tok::kw_operator, TT_Unknown);
772   EXPECT_TOKEN(Tokens[9], tok::plus, TT_OverloadedOperator);
773   EXPECT_TOKEN(Tokens[10], tok::l_paren, TT_OverloadedOperatorLParen);
774   EXPECT_TOKEN(Tokens[12], tok::star, TT_BinaryOperator);
775 
776   Tokens = annotate("std::vector<Foo> operator()(Foo &foo);");
777   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
778   EXPECT_TOKEN(Tokens[3], tok::less, TT_TemplateOpener);
779   EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
780   EXPECT_TOKEN(Tokens[6], tok::kw_operator, TT_FunctionDeclarationName);
781   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperator);
782   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_OverloadedOperator);
783   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_OverloadedOperatorLParen);
784   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
785 
786   Tokens = annotate("decltype(auto) operator()(T &x);");
787   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
788   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_TypeDeclarationParen);
789   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_TypeDeclarationParen);
790   EXPECT_TOKEN(Tokens[4], tok::kw_operator, TT_FunctionDeclarationName);
791   EXPECT_TOKEN(Tokens[5], tok::l_paren, TT_OverloadedOperator);
792   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_OverloadedOperator);
793   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_OverloadedOperatorLParen);
794   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
795 }
796 
797 TEST_F(TokenAnnotatorTest, OverloadedOperatorInTemplate) {
798   struct {
799     const char *Text;
800     tok::TokenKind Kind;
801   } Operators[] = {{"+", tok::plus},
802                    {"-", tok::minus},
803                    // FIXME:
804                    // {"*", tok::star},
805                    {"/", tok::slash},
806                    {"%", tok::percent},
807                    {"^", tok::caret},
808                    // FIXME:
809                    // {"&", tok::amp},
810                    {"|", tok::pipe},
811                    {"~", tok::tilde},
812                    {"!", tok::exclaim},
813                    {"=", tok::equal},
814                    // FIXME:
815                    // {"<", tok::less},
816                    {">", tok::greater},
817                    {"+=", tok::plusequal},
818                    {"-=", tok::minusequal},
819                    {"*=", tok::starequal},
820                    {"/=", tok::slashequal},
821                    {"%=", tok::percentequal},
822                    {"^=", tok::caretequal},
823                    {"&=", tok::ampequal},
824                    {"|=", tok::pipeequal},
825                    {"<<", tok::lessless},
826                    {">>", tok::greatergreater},
827                    {">>=", tok::greatergreaterequal},
828                    {"<<=", tok::lesslessequal},
829                    {"==", tok::equalequal},
830                    {"!=", tok::exclaimequal},
831                    {"<=", tok::lessequal},
832                    {">=", tok::greaterequal},
833                    {"<=>", tok::spaceship},
834                    {"&&", tok::ampamp},
835                    {"||", tok::pipepipe},
836                    {"++", tok::plusplus},
837                    {"--", tok::minusminus},
838                    {",", tok::comma},
839                    {"->*", tok::arrowstar},
840                    {"->", tok::arrow}};
841 
842   for (const auto &Operator : Operators) {
843     std::string Input("C<&operator");
844     Input += Operator.Text;
845     Input += " > a;";
846     auto Tokens = annotate(std::string(Input));
847     ASSERT_EQ(Tokens.size(), 9u) << Tokens;
848     EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
849     EXPECT_TOKEN(Tokens[4], Operator.Kind, TT_OverloadedOperator);
850     EXPECT_TOKEN(Tokens[5], tok::greater, TT_TemplateCloser);
851   }
852 
853   auto Tokens = annotate("C<&operator< <X>> lt;");
854   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
855   EXPECT_TOKEN(Tokens[1], tok::less, TT_TemplateOpener);
856   EXPECT_TOKEN(Tokens[4], tok::less, TT_OverloadedOperator);
857   EXPECT_TOKEN(Tokens[5], tok::less, TT_TemplateOpener);
858   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
859   EXPECT_TOKEN(Tokens[8], tok::greater, TT_TemplateCloser);
860 }
861 
862 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
863   auto Tokens = annotate("template <typename T>\n"
864                          "concept C = (Foo && Bar) && (Bar && Baz);");
865 
866   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
867   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
868   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
869   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
870 
871   Tokens = annotate("template <typename T>\n"
872                     "concept C = Foo && !Bar;");
873 
874   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
875   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
876   EXPECT_TOKEN(Tokens[10], tok::exclaim, TT_UnaryOperator);
877 
878   Tokens = annotate("template <typename T>\n"
879                     "concept C = requires(T t) {\n"
880                     "  { t.foo() };\n"
881                     "} && Bar<T> && Baz<T>;");
882   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
883   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
884   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
885   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
886   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
887   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
888 
889   Tokens = annotate("template<typename T>\n"
890                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
891                     "struct Foo;");
892   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
893   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
894   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
895   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
896   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
897   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
898   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
899   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
900   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
901   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
902   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
903 
904   Tokens =
905       annotate("template<typename T>\n"
906                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
907                "struct Foo;");
908   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
909   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
910   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
911   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
912   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
913   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
914   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
915   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
916   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
917   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
918   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
919   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
920 
921   Tokens = annotate("template <typename T>\n"
922                     "void foo(T) noexcept requires Bar<T>;");
923   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
924   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
925 
926   Tokens = annotate("template <typename T>\n"
927                     "requires Bar<T> || Baz<T>\n"
928                     "auto foo(T) -> int;");
929   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
930   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
931   EXPECT_EQ(Tokens[11]->FakeLParens.size(), 0u);
932   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
933   EXPECT_TOKEN(Tokens[20], tok::arrow, TT_TrailingReturnArrow);
934 
935   Tokens = annotate("template <typename T>\n"
936                     "requires Bar<T>\n"
937                     "bool foo(T) { return false; }");
938   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
939   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
940   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
941   EXPECT_TOKEN(Tokens[11], tok::identifier, TT_FunctionDeclarationName);
942 
943   Tokens = annotate("template <typename T>\n"
944                     "requires Bar<T>\n"
945                     "decltype(auto) foo(T) { return false; }");
946   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
947   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
948   EXPECT_TRUE(Tokens[9]->ClosesRequiresClause);
949   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_FunctionDeclarationName);
950 
951   Tokens = annotate("template <typename T>\n"
952                     "struct S {\n"
953                     "  void foo() const requires Bar<T>;\n"
954                     "  void bar() const & requires Baz<T>;\n"
955                     "  void bar() && requires Baz2<T>;\n"
956                     "  void baz() const & noexcept requires Baz<T>;\n"
957                     "  void baz() && noexcept requires Baz2<T>;\n"
958                     "};\n"
959                     "\n"
960                     "void S::bar() const & requires Baz<T> { }");
961   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
962   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
963   EXPECT_TOKEN(Tokens[24], tok::amp, TT_PointerOrReference);
964   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
965   EXPECT_TOKEN(Tokens[35], tok::ampamp, TT_PointerOrReference);
966   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
967   EXPECT_TOKEN(Tokens[47], tok::amp, TT_PointerOrReference);
968   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
969   EXPECT_TOKEN(Tokens[59], tok::ampamp, TT_PointerOrReference);
970   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
971   EXPECT_TOKEN(Tokens[76], tok::amp, TT_PointerOrReference);
972   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
973 
974   Tokens = annotate("void Class::member() && requires(Constant) {}");
975   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
976   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
977 
978   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
979   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
980   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
981 
982   Tokens =
983       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
984   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
985   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
986 
987   Tokens = annotate("void Class::member() && requires(typename "
988                     "Namespace::Outer<T>::Inner::Constant) {}");
989   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
990   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
991 
992   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
993                     "  template<class T>\n"
994                     "    requires requires { number_zero_v<T>; }\n"
995                     "  [[nodiscard]] constexpr operator T() const { "
996                     "return number_zero_v<T>; }\n"
997                     "};");
998   ASSERT_EQ(Tokens.size(), 44u) << Tokens;
999   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
1000   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
1001   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
1002   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
1003   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
1004   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
1005 
1006   Tokens =
1007       annotate("template <class A, class B> concept C ="
1008                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
1009   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
1010   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
1011   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
1012   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
1013   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
1014   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
1015   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
1016   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
1017 
1018   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
1019   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1020   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1021 
1022   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
1023   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1024   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1025 
1026   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
1027   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1028   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1029 
1030   Tokens =
1031       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
1032   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1033   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1034 
1035   Tokens =
1036       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
1037   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1038   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1039 
1040   Tokens =
1041       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
1042   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1043   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
1044 
1045   Tokens = annotate("void foo() requires((A<T>) && C) {}");
1046   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1047   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1048   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_BinaryOperator);
1049 
1050   Tokens = annotate("void foo() requires(((A<T>) && C)) {}");
1051   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1052   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1053   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
1054 
1055   Tokens = annotate("void foo() requires([](T&&){}(t)) {}");
1056   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1057   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1058   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1059 
1060   Tokens = annotate("void foo() requires([](T&& u){}(t)) {}");
1061   ASSERT_EQ(Tokens.size(), 22u) << Tokens;
1062   EXPECT_TOKEN(Tokens[4], tok::kw_requires, TT_RequiresClause);
1063   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1064 
1065   Tokens = annotate("void f() & requires(true) {}");
1066   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1067   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1068   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1069 
1070   Tokens = annotate("void f() & requires(C<true, true>) {}");
1071   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1072   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
1073   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
1074 
1075   Tokens = annotate("template <typename T>\n"
1076                     "concept C = (!Foo<T>) && Bar;");
1077   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1078   EXPECT_TOKEN(Tokens[15], tok::ampamp, TT_BinaryOperator);
1079 }
1080 
1081 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
1082   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
1083   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1084   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1085   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1086   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1087 
1088   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
1089   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1090   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1091   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1092   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
1093 
1094   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
1095   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1096   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
1097   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
1098   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
1099 
1100   Tokens = annotate("foo(requires(const T t) {});");
1101   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1102   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1103   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1104   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1105 
1106   Tokens = annotate("foo(requires(const int t) {});");
1107   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1108   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1109   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1110   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1111 
1112   Tokens = annotate("foo(requires(const T t) {});");
1113   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1114   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1115   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1116   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1117 
1118   Tokens = annotate("foo(requires(int const* volatile t) {});");
1119   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1120   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1121   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1122   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1123   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1124 
1125   Tokens = annotate("foo(requires(T const* volatile t) {});");
1126   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1127   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1128   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1129   EXPECT_TOKEN(Tokens[6], tok::star, TT_PointerOrReference);
1130   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
1131 
1132   Tokens = annotate("foo(requires(T& t) {});");
1133   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1134   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1135   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1136   EXPECT_TOKEN(Tokens[5], tok::amp, TT_PointerOrReference);
1137   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1138 
1139   Tokens = annotate("foo(requires(T&& t) {});");
1140   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1141   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1142   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1143   EXPECT_TOKEN(Tokens[5], tok::ampamp, TT_PointerOrReference);
1144   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
1145 
1146   Tokens = annotate("bool foo = requires(T& t) {};");
1147   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1148   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1149   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1150   EXPECT_TOKEN(Tokens[6], tok::amp, TT_PointerOrReference);
1151   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1152 
1153   Tokens = annotate("bool foo = requires(T&& t) {};");
1154   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1155   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1156   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1157   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
1158   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_RequiresExpressionLBrace);
1159 
1160   Tokens =
1161       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
1162   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1163   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
1164   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
1165   EXPECT_TOKEN(Tokens[12], tok::star, TT_PointerOrReference);
1166   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
1167 
1168   Tokens = annotate("template <typename T>\n"
1169                     "concept C = requires(T T) {\n"
1170                     "  requires Bar<T> && Foo<T>;\n"
1171                     "};");
1172   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
1173   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1174   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1175   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1176   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
1177                TT_RequiresClauseInARequiresExpression);
1178 
1179   Tokens = annotate("template <typename T>\n"
1180                     "concept C = requires(T T) {\n"
1181                     "  { t.func() } -> std::same_as<int>;"
1182                     "  requires Bar<T> && Foo<T>;\n"
1183                     "};");
1184   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
1185   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
1186   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
1187   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1188   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
1189                TT_RequiresClauseInARequiresExpression);
1190 
1191   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
1192   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
1193                     "requires true; };");
1194   ASSERT_EQ(Tokens.size(), 21u) << 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[14], tok::l_brace, TT_RequiresExpressionLBrace);
1198 
1199   Tokens = annotate("bool foo = requires(C<true, true> c) {\n"
1200                     "  { c.foo(); }\n"
1201                     "};");
1202   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1203   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
1204   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
1205   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
1206 }
1207 
1208 TEST_F(TokenAnnotatorTest, UnderstandsPragmaRegion) {
1209   // Everything after #pragma region should be ImplicitStringLiteral
1210   auto Tokens = annotate("#pragma region Foo(Bar: Hello)");
1211   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1212   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_ImplicitStringLiteral);
1213   EXPECT_TOKEN(Tokens[6], tok::colon, TT_ImplicitStringLiteral);
1214   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_ImplicitStringLiteral);
1215 
1216   // Make sure it's annotated correctly inside a function as well
1217   Tokens = annotate("void test(){\n#pragma region Foo(Bar: Hello)\n}");
1218   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1219   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_ImplicitStringLiteral);
1220   EXPECT_TOKEN(Tokens[11], tok::colon, TT_ImplicitStringLiteral);
1221   EXPECT_TOKEN(Tokens[12], tok::identifier, TT_ImplicitStringLiteral);
1222 }
1223 
1224 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
1225   const char *BaseCode = nullptr;
1226   const char *ConstrainedCode = nullptr;
1227   auto BaseTokenCount = 0u;
1228   auto RequiresTokenCount = 0u;
1229   auto PrefixTokenCount = 0u;
1230 
1231   auto TestRequires = [&](int Line) {
1232     const auto BaseTokens = annotate(BaseCode);
1233     const auto ConstrainedTokens = annotate(ConstrainedCode);
1234 
1235 #define LINE " (Line " << Line << ')'
1236 
1237     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
1238     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
1239         << LINE;
1240 
1241     for (auto I = 0u; I < BaseTokenCount; ++I) {
1242       EXPECT_EQ(
1243           *BaseTokens[I],
1244           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
1245           << I << LINE;
1246     }
1247 
1248 #undef LINE
1249   };
1250 
1251   BaseCode = "template<typename T>\n"
1252              "T Pi = 3.14;";
1253   ConstrainedCode = "template<typename T>\n"
1254                     "  requires Foo<T>\n"
1255                     "T Pi = 3.14;";
1256   BaseTokenCount = 11;
1257   RequiresTokenCount = 5;
1258   PrefixTokenCount = 5;
1259   TestRequires(__LINE__);
1260 
1261   BaseCode = "template<typename T>\n"
1262              "struct Bar;";
1263   ConstrainedCode = "template<typename T>\n"
1264                     "  requires Foo<T>\n"
1265                     "struct Bar;";
1266   BaseTokenCount = 9;
1267   TestRequires(__LINE__);
1268 
1269   BaseCode = "template<typename T>\n"
1270              "struct Bar {\n"
1271              "  T foo();\n"
1272              "  T bar();\n"
1273              "};";
1274   ConstrainedCode = "template<typename T>\n"
1275                     "  requires Foo<T>\n"
1276                     "struct Bar {\n"
1277                     "  T foo();\n"
1278                     "  T bar();\n"
1279                     "};";
1280   BaseTokenCount = 21;
1281   TestRequires(__LINE__);
1282 
1283   BaseCode = "template<typename T>\n"
1284              "Bar(T) -> Bar<T>;";
1285   ConstrainedCode = "template<typename T>\n"
1286                     "  requires Foo<T>\n"
1287                     "Bar(T) -> Bar<T>;";
1288   BaseTokenCount = 16;
1289   TestRequires(__LINE__);
1290 
1291   BaseCode = "template<typename T>\n"
1292              "T foo();";
1293   ConstrainedCode = "template<typename T>\n"
1294                     "  requires Foo<T>\n"
1295                     "T foo();";
1296   BaseTokenCount = 11;
1297   TestRequires(__LINE__);
1298 
1299   BaseCode = "template<typename T>\n"
1300              "T foo() {\n"
1301              "  auto bar = baz();\n"
1302              "  return bar + T{};\n"
1303              "}";
1304   ConstrainedCode = "template<typename T>\n"
1305                     "  requires Foo<T>\n"
1306                     "T foo() {\n"
1307                     "  auto bar = baz();\n"
1308                     "  return bar + T{};\n"
1309                     "}";
1310   BaseTokenCount = 26;
1311   TestRequires(__LINE__);
1312 
1313   BaseCode = "template<typename T>\n"
1314              "T foo();";
1315   ConstrainedCode = "template<typename T>\n"
1316                     "T foo() requires Foo<T>;";
1317   BaseTokenCount = 11;
1318   PrefixTokenCount = 9;
1319   TestRequires(__LINE__);
1320 
1321   BaseCode = "template<typename T>\n"
1322              "T foo() {\n"
1323              "  auto bar = baz();\n"
1324              "  return bar + T{};\n"
1325              "}";
1326   ConstrainedCode = "template<typename T>\n"
1327                     "T foo() requires Foo<T> {\n"
1328                     "  auto bar = baz();\n"
1329                     "  return bar + T{};\n"
1330                     "}";
1331   BaseTokenCount = 26;
1332   TestRequires(__LINE__);
1333 
1334   BaseCode = "template<typename T>\n"
1335              "T foo();";
1336   ConstrainedCode = "template<typename T>\n"
1337                     "  requires(Foo<T>)\n"
1338                     "T foo();";
1339   BaseTokenCount = 11;
1340   RequiresTokenCount = 7;
1341   PrefixTokenCount = 5;
1342   TestRequires(__LINE__);
1343 
1344   BaseCode = "template<typename T>\n"
1345              "Bar(T) -> Bar<typename T::I>;";
1346   ConstrainedCode = "template<typename T>\n"
1347                     "  requires requires(T &&t) {\n"
1348                     "             typename T::I;\n"
1349                     "           }\n"
1350                     "Bar(T) -> Bar<typename T::I>;";
1351   BaseTokenCount = 19;
1352   RequiresTokenCount = 14;
1353   PrefixTokenCount = 5;
1354   TestRequires(__LINE__);
1355 
1356   BaseCode = "struct [[nodiscard]] zero_t {\n"
1357              "  template<class T>\n"
1358              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1359              "};";
1360   ConstrainedCode =
1361       "struct [[nodiscard]] zero_t {\n"
1362       "  template<class T>\n"
1363       "    requires requires { v<T>; }\n"
1364       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
1365       "};";
1366   BaseTokenCount = 35;
1367   RequiresTokenCount = 9;
1368   PrefixTokenCount = 13;
1369   TestRequires(__LINE__);
1370 
1371   BaseCode = "constexpr Foo(Foo const &other)\n"
1372              "    : value{other.value} {\n"
1373              "  do_magic();\n"
1374              "  do_more_magic();\n"
1375              "}";
1376   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1377                     "  requires std::is_copy_constructible<T>\n"
1378                     "    : value{other.value} {\n"
1379                     "  do_magic();\n"
1380                     "  do_more_magic();\n"
1381                     "}";
1382   BaseTokenCount = 26;
1383   RequiresTokenCount = 7;
1384   PrefixTokenCount = 8;
1385   TestRequires(__LINE__);
1386 
1387   BaseCode = "constexpr Foo(Foo const &other)\n"
1388              "    : value{other.value} {\n"
1389              "  do_magic();\n"
1390              "  do_more_magic();\n"
1391              "}";
1392   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
1393                     "  requires (std::is_copy_constructible<T>)\n"
1394                     "    : value{other.value} {\n"
1395                     "  do_magic();\n"
1396                     "  do_more_magic();\n"
1397                     "}";
1398   RequiresTokenCount = 9;
1399   TestRequires(__LINE__);
1400 
1401   BaseCode = "template<typename T>\n"
1402              "ANNOTATE(\"S\"\n"
1403              "         \"S\")\n"
1404              "void foo();";
1405   ConstrainedCode = "template<typename T>\n"
1406                     "  requires(true)\n"
1407                     "ANNOTATE(\"S\"\n"
1408                     "         \"S\")\n"
1409                     "void foo();";
1410   BaseTokenCount = 16;
1411   RequiresTokenCount = 4;
1412   PrefixTokenCount = 5;
1413   TestRequires(__LINE__);
1414 }
1415 
1416 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
1417   auto Tokens = annotate("__asm{\n"
1418                          "a:\n"
1419                          "};");
1420   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1421   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
1422   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
1423   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
1424 }
1425 
1426 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
1427   auto Tokens = annotate("int (^)() = ^ ()\n"
1428                          "  external_source_symbol() { //\n"
1429                          "  return 1;\n"
1430                          "};");
1431   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
1432   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
1433   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
1434 
1435   Tokens = annotate("int *p = ^int*(){ //\n"
1436                     "  return nullptr;\n"
1437                     "}();");
1438   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1439   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
1440 }
1441 
1442 TEST_F(TokenAnnotatorTest, UnderstandsObjCMethodExpr) {
1443   auto Tokens = annotate("void f() {\n"
1444                          "  //\n"
1445                          "  BOOL a = [b.c n] > 1;\n"
1446                          "}");
1447   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1448   EXPECT_TOKEN(Tokens[9], tok::l_square, TT_ObjCMethodExpr);
1449   EXPECT_TOKEN(Tokens[15], tok::greater, TT_BinaryOperator);
1450 }
1451 
1452 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
1453   auto Tokens = annotate("[]() constexpr {}");
1454   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1455   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1456   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1457 
1458   Tokens = annotate("[]() consteval {}");
1459   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1460   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1461   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1462 
1463   Tokens = annotate("[]() mutable {}");
1464   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1465   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1466   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1467 
1468   Tokens = annotate("[]() static {}");
1469   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1470   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1471   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
1472 
1473   Tokens = annotate("[]() -> auto {}");
1474   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1475   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1476   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1477   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1478 
1479   Tokens = annotate("[]() -> auto & {}");
1480   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1481   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1482   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1483   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1484 
1485   Tokens = annotate("[]() -> auto * {}");
1486   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1487   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1488   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1489   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1490 
1491   Tokens = annotate("[] {}");
1492   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
1493   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1494   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_LambdaLBrace);
1495 
1496   Tokens = annotate("[] noexcept {}");
1497   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
1498   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1499   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_LambdaLBrace);
1500 
1501   Tokens = annotate("[] -> auto {}");
1502   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1503   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1504   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_TrailingReturnArrow);
1505   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_LambdaLBrace);
1506 
1507   Tokens = annotate("[] <typename T> () {}");
1508   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1509   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1510   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1511   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_LambdaLBrace);
1512 
1513   Tokens = annotate("[] <typename T> {}");
1514   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1515   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1516   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1517   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
1518 
1519   Tokens = annotate("[] <typename... T> () {}");
1520   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1521   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1522   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1523   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1524 
1525   Tokens = annotate("[] <typename... T> {}");
1526   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1527   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1528   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1529   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1530 
1531   Tokens = annotate("[] <int... T> () {}");
1532   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1533   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1534   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1535   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1536 
1537   Tokens = annotate("[] <int... T> {}");
1538   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1539   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1540   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1541   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1542 
1543   Tokens = annotate("[] <Foo... T> () {}");
1544   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1545   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1546   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1547   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_LambdaLBrace);
1548 
1549   Tokens = annotate("[] <Foo... T> {}");
1550   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1551   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1552   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1553   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
1554 
1555   // Lambdas with a requires-clause
1556   Tokens = annotate("[] <typename T> (T t) requires Bar<T> {}");
1557   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1558   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1559   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1560   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1561   EXPECT_TRUE(Tokens[14]->ClosesRequiresClause);
1562   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1563 
1564   Tokens = annotate("[] <typename T> (T &&t) requires Bar<T> {}");
1565   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1566   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1567   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1568   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_PointerOrReference);
1569   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
1570   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1571   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1572 
1573   Tokens = annotate("[] <typename T> (T t) requires Foo<T> || Bar<T> {}");
1574   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1575   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1576   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1577   EXPECT_TOKEN(Tokens[10], tok::kw_requires, TT_RequiresClause);
1578   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1579   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1580 
1581   Tokens = annotate("[] <typename T> (T t) -> T requires Bar<T> {}");
1582   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1583   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1584   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1585   EXPECT_TOKEN(Tokens[10], tok::arrow, TT_TrailingReturnArrow);
1586   EXPECT_TOKEN(Tokens[12], tok::kw_requires, TT_RequiresClause);
1587   EXPECT_TRUE(Tokens[16]->ClosesRequiresClause);
1588   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1589 
1590   Tokens = annotate("[] <typename T> requires Bar<T> (T t) {}");
1591   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1592   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1593   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1594   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1595   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1596   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1597 
1598   Tokens = annotate("[] <typename T> requires Bar<T> (T &&t) {}");
1599   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
1600   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1601   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1602   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1603   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1604   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_PointerOrReference);
1605   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_LambdaLBrace);
1606 
1607   Tokens = annotate("[] <typename T> requires Foo<T> || Bar<T> (T t) {}");
1608   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1609   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1610   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1611   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1612   EXPECT_TRUE(Tokens[15]->ClosesRequiresClause);
1613   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1614 
1615   Tokens = annotate("[] <typename T> requires true (T&& t) {}");
1616   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1617   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1618   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1619   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1620   EXPECT_TRUE(Tokens[7]->ClosesRequiresClause);
1621   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
1622   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1623 
1624   Tokens = annotate("[] <typename T> requires Bar<T> {}");
1625   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1626   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1627   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1628   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1629   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1630   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_LambdaLBrace);
1631 
1632   Tokens = annotate("[] <typename T> requires Bar<T> noexcept {}");
1633   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1634   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1635   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1636   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1637   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1638   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1639 
1640   Tokens = annotate("[] <typename T> requires Bar<T> -> T {}");
1641   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1642   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1643   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1644   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1645   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1646   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_TrailingReturnArrow);
1647   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_LambdaLBrace);
1648 
1649   Tokens = annotate("[] <typename T> requires Foo<T> (T t) requires Bar<T> {}");
1650   ASSERT_EQ(Tokens.size(), 23u) << Tokens;
1651   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1652   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1653   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
1654   EXPECT_TRUE(Tokens[10]->ClosesRequiresClause);
1655   EXPECT_TOKEN(Tokens[15], tok::kw_requires, TT_RequiresClause);
1656   EXPECT_TRUE(Tokens[19]->ClosesRequiresClause);
1657   EXPECT_TOKEN(Tokens[20], tok::l_brace, TT_LambdaLBrace);
1658 
1659   Tokens = annotate("[] <typename T = int> (T t) {}");
1660   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1661   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1662   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1663   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1664   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1665 
1666   Tokens = annotate("[] <int I = 0> (T t) {}");
1667   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1668   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1669   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1670   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1671   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1672 
1673   Tokens = annotate("[] <bool b = false> (T t) {}");
1674   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1675   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1676   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1677   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1678   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_LambdaLBrace);
1679 
1680   Tokens = annotate("[] <bool b = true && false> (T&& t) {}");
1681   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1682   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1683   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1684   EXPECT_TOKEN(Tokens[7], tok::ampamp, TT_BinaryOperator);
1685   EXPECT_TOKEN(Tokens[9], tok::greater, TT_TemplateCloser);
1686   EXPECT_TOKEN(Tokens[12], tok::ampamp, TT_PointerOrReference);
1687   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_LambdaLBrace);
1688 
1689   Tokens = annotate("[] <typename T = int> requires Foo<T> (T t) {}");
1690   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1691   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
1692   EXPECT_TOKEN(Tokens[2], tok::less, TT_TemplateOpener);
1693   EXPECT_TOKEN(Tokens[7], tok::greater, TT_TemplateCloser);
1694   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
1695   EXPECT_TOKEN(Tokens[17], tok::l_brace, TT_LambdaLBrace);
1696 }
1697 
1698 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
1699   auto Tokens = annotate("template <typename T>\n"
1700                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
1701                          "string OldFunction(const string &parameter) {}");
1702   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
1703   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
1704 
1705   Tokens = annotate("template <typename T>\n"
1706                     "A(T) noexcept;");
1707   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1708   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
1709 }
1710 
1711 TEST_F(TokenAnnotatorTest, UnderstandsFunctionDeclarationNames) {
1712   auto Tokens = annotate("void f [[noreturn]] ();");
1713   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1714   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1715 
1716   Tokens = annotate("void f [[noreturn]] () {}");
1717   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1718   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1719 
1720   Tokens = annotate("#define FOO Foo::\n"
1721                     "FOO Foo();");
1722   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1723   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_FunctionDeclarationName);
1724 
1725   Tokens = annotate("struct Foo {\n"
1726                     "  Bar (*func)();\n"
1727                     "};");
1728   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1729   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
1730   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_FunctionTypeLParen);
1731 
1732   auto Style = getLLVMStyle();
1733   Style.TypeNames.push_back("time_t");
1734   Tokens = annotate("int iso_time(time_t);", Style);
1735   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
1736   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
1737   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_TypeName);
1738 }
1739 
1740 TEST_F(TokenAnnotatorTest, UnderstandsCtorAndDtorDeclNames) {
1741   auto Tokens = annotate("class Foo { public: Foo(); };");
1742   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1743   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_CtorDtorDeclName);
1744 
1745   Tokens = annotate("class Foo { public: ~Foo(); };");
1746   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1747   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_CtorDtorDeclName);
1748 
1749   Tokens = annotate("struct Foo { [[deprecated]] Foo() {} };");
1750   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1751   EXPECT_TOKEN(Tokens[8], tok::identifier, TT_CtorDtorDeclName);
1752   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1753 
1754   Tokens = annotate("struct Foo { [[deprecated]] ~Foo() {} };");
1755   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1756   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1757   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1758 
1759   Tokens = annotate("struct Foo { Foo() [[deprecated]] {} };");
1760   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1761   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1762   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_FunctionLBrace);
1763 
1764   Tokens = annotate("struct Foo { ~Foo() [[deprecated]] {} };");
1765   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1766   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_CtorDtorDeclName);
1767   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1768 
1769   Tokens = annotate("struct Foo { [[deprecated]] explicit Foo() {} };");
1770   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
1771   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_CtorDtorDeclName);
1772   EXPECT_TOKEN(Tokens[12], tok::l_brace, TT_FunctionLBrace);
1773 
1774   Tokens = annotate("struct Foo { virtual [[deprecated]] ~Foo() {} };");
1775   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1776   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_CtorDtorDeclName);
1777   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
1778 
1779   Tokens = annotate("Foo::Foo() {}");
1780   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1781   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_CtorDtorDeclName);
1782   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
1783 
1784   Tokens = annotate("Foo::~Foo() {}");
1785   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1786   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1787   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
1788 
1789   Tokens = annotate("struct Test {\n"
1790                     "  Test()\n"
1791                     "      : l([] {\n"
1792                     "          Short::foo();\n"
1793                     "        }) {}\n"
1794                     "};");
1795   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
1796   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_CtorDtorDeclName);
1797   EXPECT_TOKEN(Tokens[14], tok::identifier, TT_Unknown);
1798 }
1799 
1800 TEST_F(TokenAnnotatorTest, UnderstandsC11GenericSelection) {
1801   auto Tokens = annotate("_Generic(x, int: 1, default: 0)");
1802   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1803   EXPECT_TOKEN(Tokens[0], tok::kw__Generic, TT_Unknown);
1804   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GenericSelectionColon);
1805   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GenericSelectionColon);
1806 }
1807 
1808 TEST_F(TokenAnnotatorTest, UnderstandsTrailingReturnArrow) {
1809   auto Tokens = annotate("auto f() -> int;");
1810   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1811   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1812 
1813   Tokens = annotate("auto operator->() -> int;");
1814   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1815   EXPECT_TOKEN(Tokens[2], tok::arrow, TT_OverloadedOperator);
1816   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1817 
1818   Tokens = annotate("auto operator++(int) -> int;");
1819   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1820   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1821 
1822   Tokens = annotate("auto operator=() -> int;");
1823   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
1824   EXPECT_TOKEN(Tokens[5], tok::arrow, TT_TrailingReturnArrow);
1825 
1826   Tokens = annotate("auto operator=(int) -> int;");
1827   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1828   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_TrailingReturnArrow);
1829 
1830   Tokens = annotate("auto foo() -> auto { return Val; }");
1831   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1832   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1833 
1834   Tokens = annotate("struct S { auto bar() const -> int; };");
1835   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
1836   EXPECT_TOKEN(Tokens[8], tok::arrow, TT_TrailingReturnArrow);
1837 
1838   // Not trailing return arrows
1839   Tokens = annotate("auto a = b->c;");
1840   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1841   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1842 
1843   Tokens = annotate("auto a = (b)->c;");
1844   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1845   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1846 
1847   Tokens = annotate("auto a = b()->c;");
1848   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1849   EXPECT_TOKEN(Tokens[6], tok::arrow, TT_Unknown);
1850 
1851   Tokens = annotate("auto a = b->c();");
1852   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
1853   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_Unknown);
1854 
1855   Tokens = annotate("decltype(auto) a = b()->c;");
1856   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1857   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1858 
1859   Tokens = annotate("void f() { auto a = b->c(); }");
1860   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1861   EXPECT_TOKEN(Tokens[9], tok::arrow, TT_Unknown);
1862 
1863   Tokens = annotate("void f() { auto a = b()->c; }");
1864   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
1865   EXPECT_TOKEN(Tokens[11], tok::arrow, TT_Unknown);
1866 
1867   Tokens = annotate("#define P(ptr) auto p = (ptr)->p");
1868   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
1869   EXPECT_TOKEN(Tokens[12], tok::arrow, TT_Unknown);
1870 
1871   Tokens = annotate("void f() FOO(foo->bar);");
1872   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
1873   EXPECT_TOKEN(Tokens[7], tok::arrow, TT_Unknown);
1874 
1875   // Mixed
1876   Tokens = annotate("auto f() -> int { auto a = b()->c; }");
1877   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
1878   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_TrailingReturnArrow);
1879   EXPECT_TOKEN(Tokens[13], tok::arrow, TT_Unknown);
1880 }
1881 
1882 TEST_F(TokenAnnotatorTest, UnderstandHashInMacro) {
1883   auto Tokens = annotate("#define Foo(Bar) \\\n"
1884                          "  { \\\n"
1885                          "    #Bar \\\n"
1886                          "  }");
1887   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1888   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
1889   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
1890 
1891   Tokens = annotate("#define Foo(Bar) \\\n"
1892                     "  { #Bar }");
1893   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1894   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
1895   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
1896 }
1897 
1898 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacros) {
1899   // '__attribute__' has special handling.
1900   auto Tokens = annotate("__attribute__(X) void Foo(void);");
1901   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1902   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
1903   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1904   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1905 
1906   // Generic macro has no special handling in this location.
1907   Tokens = annotate("A(X) void Foo(void);");
1908   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1909   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
1910   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_Unknown);
1911 
1912   // Add a custom AttributeMacro. Test that it has the same behavior.
1913   FormatStyle Style = getLLVMStyle();
1914   Style.AttributeMacros.push_back("A");
1915 
1916   // An "AttributeMacro" gets annotated like '__attribute__'.
1917   Tokens = annotate("A(X) void Foo(void);", Style);
1918   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1919   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
1920   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1921   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1922 }
1923 
1924 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCDecl) {
1925   // '__attribute__' has special handling.
1926   auto Tokens = annotate("__attribute__(X) @interface Foo");
1927   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1928   EXPECT_TOKEN(Tokens[0], tok::kw___attribute, TT_Unknown);
1929   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1930   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1931 
1932   // Generic macro has no special handling in this location.
1933   Tokens = annotate("A(X) @interface Foo");
1934   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1935   // Note: Don't check token-type as a random token in this position is hard to
1936   // reason about.
1937   EXPECT_TOKEN_KIND(Tokens[0], tok::identifier);
1938   EXPECT_TOKEN_KIND(Tokens[1], tok::l_paren);
1939 
1940   // Add a custom AttributeMacro. Test that it has the same behavior.
1941   FormatStyle Style = getLLVMStyle();
1942   Style.AttributeMacros.push_back("A");
1943 
1944   // An "AttributeMacro" gets annotated like '__attribute__'.
1945   Tokens = annotate("A(X) @interface Foo", Style);
1946   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
1947   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_AttributeMacro);
1948   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_AttributeLParen);
1949   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_AttributeRParen);
1950 }
1951 
1952 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCMethodDecl) {
1953   // '__attribute__' has special handling.
1954   auto Tokens = annotate("- (id)init __attribute__(X);");
1955   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1956   EXPECT_TOKEN(Tokens[5], tok::kw___attribute, TT_Unknown);
1957   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
1958   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
1959 
1960   // Generic macro has no special handling in this location.
1961   Tokens = annotate("- (id)init A(X);");
1962   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1963   // Note: Don't check token-type as a random token in this position is hard to
1964   // reason about.
1965   EXPECT_TOKEN_KIND(Tokens[5], tok::identifier);
1966   EXPECT_TOKEN_KIND(Tokens[6], tok::l_paren);
1967 
1968   // Add a custom AttributeMacro. Test that it has the same behavior.
1969   FormatStyle Style = getLLVMStyle();
1970   Style.AttributeMacros.push_back("A");
1971 
1972   // An "AttributeMacro" gets annotated like '__attribute__'.
1973   Tokens = annotate("- (id)init A(X);", Style);
1974   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
1975   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_AttributeMacro);
1976   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_AttributeLParen);
1977   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_AttributeRParen);
1978 }
1979 
1980 TEST_F(TokenAnnotatorTest, UnderstandsAttributeMacrosOnObjCProperty) {
1981   // '__attribute__' has special handling.
1982   auto Tokens = annotate("@property(weak) id delegate __attribute__(X);");
1983   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1984   EXPECT_TOKEN(Tokens[7], tok::kw___attribute, TT_Unknown);
1985   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
1986   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
1987 
1988   // Generic macro has no special handling in this location.
1989   Tokens = annotate("@property(weak) id delegate A(X);");
1990   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
1991   // Note: Don't check token-type as a random token in this position is hard to
1992   // reason about.
1993   EXPECT_TOKEN_KIND(Tokens[7], tok::identifier);
1994   EXPECT_TOKEN_KIND(Tokens[8], tok::l_paren);
1995 
1996   // Add a custom AttributeMacro. Test that it has the same behavior.
1997   FormatStyle Style = getLLVMStyle();
1998   Style.AttributeMacros.push_back("A");
1999 
2000   // An "AttributeMacro" gets annotated like '__attribute__'.
2001   Tokens = annotate("@property(weak) id delegate A(X);", Style);
2002   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
2003   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_AttributeMacro);
2004   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_AttributeLParen);
2005   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_AttributeRParen);
2006 }
2007 
2008 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
2009   auto Annotate = [this](llvm::StringRef Code) {
2010     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
2011   };
2012   // Test that unary operators get labeled as such and that operators like '++'
2013   // don't get split.
2014   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
2015                             tok::tilde, tok::amp,      tok::pipe,
2016                             tok::caret, tok::plusplus, tok::minusminus};
2017   for (auto Kind : Unary) {
2018     auto Tokens =
2019         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
2020     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2021     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
2022   }
2023   // Operators formed by joining two operators like '^~'. For some of these
2024   // joined operators, we don't have a separate type, so we only test for their
2025   // precedence.
2026   std::pair<prec::Level, std::string> JoinedBinary[] = {
2027       {prec::Comma, "->"},        {prec::Comma, "<->"},
2028       {prec::Assignment, "+="},   {prec::Assignment, "-="},
2029       {prec::Assignment, "*="},   {prec::Assignment, "/="},
2030       {prec::Assignment, "%="},   {prec::Assignment, "&="},
2031       {prec::Assignment, "^="},   {prec::Assignment, "<<="},
2032       {prec::Assignment, ">>="},  {prec::Assignment, "<<<="},
2033       {prec::Assignment, ">>>="}, {prec::LogicalOr, "||"},
2034       {prec::LogicalAnd, "&&"},   {prec::Equality, "=="},
2035       {prec::Equality, "!="},     {prec::Equality, "==="},
2036       {prec::Equality, "!=="},    {prec::Equality, "==?"},
2037       {prec::Equality, "!=?"},    {prec::ExclusiveOr, "~^"},
2038       {prec::ExclusiveOr, "^~"},
2039   };
2040   for (auto Operator : JoinedBinary) {
2041     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
2042     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2043     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
2044     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
2045   }
2046   // '~^' and '^~' can be unary as well as binary operators.
2047   auto Tokens = Annotate("x = ~^x;");
2048   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2049   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
2050   Tokens = Annotate("x = ^~x;");
2051   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2052   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
2053   // The unary operators '~&' and '~|' can only be unary operators. The current
2054   // implementation treats each of them as separate unary '~' and '&' or '|'
2055   // operators, which is enough for formatting purposes. In FormatTestVerilog,
2056   // there is a test that there is no space in between. And even if a new line
2057   // is inserted between the '~' and '|', the semantic meaning is the same as
2058   // the joined operator, so the CanBreakBefore property doesn't need to be
2059   // false for the second operator.
2060   Tokens = Annotate("x = ~&x;");
2061   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2062   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2063   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
2064   Tokens = Annotate("x = ~|x;");
2065   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2066   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
2067   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
2068   // Test for block label colons.
2069   Tokens = Annotate("begin : x\n"
2070                     "end : x");
2071   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2072   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
2073   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
2074   // Test that the dimension colon is annotated correctly.
2075   Tokens = Annotate("var [1 : 0] x;");
2076   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2077   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
2078   Tokens = Annotate("extern function [1 : 0] x;");
2079   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2080   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
2081   Tokens = Annotate("module test\n"
2082                     "    (input wire [7 : 0] a[7 : 0]);\n"
2083                     "endmodule");
2084   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2085   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_VerilogDimensionedTypeName);
2086   EXPECT_TOKEN(Tokens[7], tok::colon, TT_BitFieldColon);
2087   EXPECT_TOKEN(Tokens[13], tok::colon, TT_BitFieldColon);
2088   // Test case labels and ternary operators.
2089   Tokens = Annotate("case (x)\n"
2090                     "  x:\n"
2091                     "    x;\n"
2092                     "endcase");
2093   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2094   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CaseLabelColon);
2095   Tokens = Annotate("case (x)\n"
2096                     "  x ? x : x:\n"
2097                     "    x;\n"
2098                     "endcase");
2099   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2100   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
2101   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
2102   EXPECT_TOKEN(Tokens[9], tok::colon, TT_CaseLabelColon);
2103   // Non-blocking assignments.
2104   Tokens = Annotate("a <= b;");
2105   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2106   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2107   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2108   Tokens = Annotate("if (a <= b) break;");
2109   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2110   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2111   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2112   Tokens = Annotate("a <= b <= a;");
2113   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2114   EXPECT_TOKEN(Tokens[1], tok::lessequal, TT_BinaryOperator);
2115   EXPECT_TOKEN_PRECEDENCE(Tokens[1], prec::Assignment);
2116   EXPECT_TOKEN(Tokens[3], tok::lessequal, TT_BinaryOperator);
2117   EXPECT_TOKEN_PRECEDENCE(Tokens[3], prec::Relational);
2118 
2119   // Port lists in module instantiation.
2120   Tokens = Annotate("module_x instance_1(port_1), instance_2(port_2);");
2121   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2122   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2123   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_VerilogInstancePortLParen);
2124   Tokens = Annotate("module_x #(parameter) instance_1(port_1), "
2125                     "instance_2(port_2);");
2126   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2127   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_VerilogInstancePortLParen);
2128   EXPECT_TOKEN(Tokens[6], tok::l_paren, TT_VerilogInstancePortLParen);
2129   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_VerilogInstancePortLParen);
2130 
2131   // Condition parentheses.
2132   Tokens = Annotate("assert (x);");
2133   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2134   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2135   Tokens = Annotate("assert #0 (x);");
2136   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2137   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_ConditionLParen);
2138   Tokens = Annotate("assert final (x);");
2139   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2140   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2141   Tokens = Annotate("foreach (x[x]) continue;");
2142   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2143   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2144   Tokens = Annotate("repeat (x[x]) continue;");
2145   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2146   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2147   Tokens = Annotate("case (x) endcase;");
2148   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2149   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2150 
2151   // Sensitivity list. The TT_Unknown type is clearly not binding for the
2152   // future, please adapt if those tokens get annotated.  This test is only here
2153   // to prevent the comma from being annotated as TT_VerilogInstancePortComma.
2154   Tokens = Annotate("always @(posedge x, posedge y);");
2155   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2156   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_Unknown);
2157   EXPECT_TOKEN(Tokens[5], tok::comma, TT_Unknown);
2158   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2159 
2160   // String literals in concatenation.
2161   Tokens = Annotate("x = {\"\"};");
2162   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2163   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2164   Tokens = Annotate("x = {\"\", \"\"};");
2165   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2166   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_StringInConcatenation);
2167   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2168   Tokens = Annotate("x = '{{\"\"}};");
2169   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2170   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_StringInConcatenation);
2171   // Cases where the string should not be annotated that type.  Fix the
2172   // `TT_Unknown` if needed in the future.
2173   Tokens = Annotate("x = {\"\" == \"\"};");
2174   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2175   EXPECT_TOKEN(Tokens[3], tok::string_literal, TT_Unknown);
2176   EXPECT_TOKEN(Tokens[5], tok::string_literal, TT_Unknown);
2177   Tokens = Annotate("x = {(\"\")};");
2178   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2179   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2180   Tokens = Annotate("x = '{\"\"};");
2181   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2182   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_Unknown);
2183 }
2184 
2185 TEST_F(TokenAnnotatorTest, UnderstandTableGenTokens) {
2186   auto Style = getLLVMStyle(FormatStyle::LK_TableGen);
2187   ASSERT_TRUE(Style.isTableGen());
2188 
2189   TestLexer Lexer(Allocator, Buffers, Style);
2190   AdditionalKeywords Keywords(Lexer.IdentTable);
2191   auto Annotate = [&Lexer](llvm::StringRef Code) {
2192     return Lexer.annotate(Code);
2193   };
2194 
2195   // Additional keywords representation test.
2196   auto Tokens = Annotate("def foo : Bar<1>;");
2197   ASSERT_TRUE(Keywords.isTableGenKeyword(*Tokens[0]));
2198   ASSERT_TRUE(Keywords.isTableGenDefinition(*Tokens[0]));
2199   ASSERT_TRUE(Tokens[0]->is(Keywords.kw_def));
2200   ASSERT_TRUE(Tokens[1]->is(TT_StartOfName));
2201 
2202   // Code, the multiline string token.
2203   Tokens = Annotate("[{ code is multiline string }]");
2204   ASSERT_EQ(Tokens.size(), 2u) << Tokens;
2205   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2206   EXPECT_FALSE(Tokens[0]->IsMultiline);
2207   // Case with multiple lines.
2208   Tokens = Annotate("[{ It can break\n"
2209                     "   across lines and the line breaks\n"
2210                     "   are retained in \n"
2211                     "   the string. }]");
2212   ASSERT_EQ(Tokens.size(), 2u) << Tokens;
2213   EXPECT_TOKEN(Tokens[0], tok::string_literal, TT_TableGenMultiLineString);
2214   EXPECT_EQ(Tokens[0]->ColumnWidth, sizeof("[{ It can break\n") - 1);
2215   EXPECT_TRUE(Tokens[0]->IsMultiline);
2216   EXPECT_EQ(Tokens[0]->LastLineColumnWidth, sizeof("   the string. }]") - 1);
2217 
2218   // Identifier tokens. In TableGen, identifiers can begin with a number.
2219   // In ambiguous cases, the lexer tries to lex it as a number.
2220   // Even if the try fails, it does not fall back to identifier lexing and
2221   // regard as an error.
2222   // The ambiguity is not documented. The result of those tests are based on the
2223   // implementation of llvm::TGLexer::LexToken.
2224   Tokens = Annotate("1234");
2225   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2226   Tokens = Annotate("0x1abC");
2227   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2228   // This is invalid syntax of number, but not an identifier.
2229   Tokens = Annotate("0x1234x");
2230   EXPECT_TOKEN(Tokens[0], tok::numeric_constant, TT_Unknown);
2231   Tokens = Annotate("identifier");
2232   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2233   // Identifier beginning with a number.
2234   Tokens = Annotate("0x");
2235   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2236   Tokens = Annotate("2dVector");
2237   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2238   Tokens = Annotate("01234Vector");
2239   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_Unknown);
2240 
2241   // Structured statements.
2242   Tokens = Annotate("class Foo {}");
2243   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_FunctionLBrace);
2244   Tokens = Annotate("def Def: Foo {}");
2245   EXPECT_TOKEN(Tokens[2], tok::colon, TT_InheritanceColon);
2246   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2247   Tokens = Annotate("if cond then {} else {}");
2248   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ControlStatementLBrace);
2249   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_ElseLBrace);
2250   Tokens = Annotate("defset Foo Def2 = {}");
2251   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2252 }
2253 
2254 TEST_F(TokenAnnotatorTest, UnderstandConstructors) {
2255   auto Tokens = annotate("Class::Class() : BaseClass(), Member() {}");
2256 
2257   // The TT_Unknown is clearly not binding for the future, please adapt if those
2258   // tokens get annotated.
2259   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2260   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2261   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2262   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_Unknown);
2263   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
2264   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2265   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2266   EXPECT_TOKEN(Tokens[11], tok::l_paren, TT_Unknown);
2267   EXPECT_TOKEN(Tokens[12], tok::r_paren, TT_Unknown);
2268   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2269   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2270 
2271   Tokens = annotate("Class::Class() : BaseClass{}, Member{} {}");
2272   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2273   EXPECT_TOKEN(Tokens[5], tok::colon, TT_CtorInitializerColon);
2274   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
2275   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_Unknown);
2276   EXPECT_TOKEN(Tokens[8], tok::r_brace, TT_Unknown);
2277   EXPECT_TOKEN(Tokens[9], tok::comma, TT_CtorInitializerComma);
2278   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_Unknown);
2279   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_Unknown);
2280   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_Unknown);
2281   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2282   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2283 
2284   Tokens = annotate("class Class {\n"
2285                     "  Class() : BaseClass() {\n"
2286                     "#if 0\n"
2287                     "    // comment\n"
2288                     "#endif\n"
2289                     "  }\n"
2290                     "  Class f();\n"
2291                     "}");
2292   ASSERT_EQ(Tokens.size(), 25u) << Tokens;
2293   EXPECT_TOKEN(Tokens[6], tok::colon, TT_CtorInitializerColon);
2294   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_FunctionLBrace);
2295   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2296 }
2297 
2298 TEST_F(TokenAnnotatorTest, UnderstandsConditionParens) {
2299   auto Tokens = annotate("if (x) {}");
2300   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2301   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2302   Tokens = annotate("if constexpr (x) {}");
2303   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2304   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2305   Tokens = annotate("if CONSTEXPR (x) {}");
2306   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2307   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_ConditionLParen);
2308   Tokens = annotate("if (x) {} else if (x) {}");
2309   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2310   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ConditionLParen);
2311   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_ConditionLParen);
2312 }
2313 
2314 TEST_F(TokenAnnotatorTest, CSharpNullableTypes) {
2315   FormatStyle Style = getGoogleStyle(FormatStyle::LK_CSharp);
2316 
2317   auto Tokens = annotate("int? a;", Style);
2318   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
2319   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2320 
2321   Tokens = annotate("int? a = 1;", Style);
2322   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2323   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2324 
2325   Tokens = annotate("int?)", Style);
2326   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
2327   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2328 
2329   Tokens = annotate("int?>", Style);
2330   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
2331   EXPECT_TOKEN(Tokens[1], tok::question, TT_CSharpNullable);
2332 
2333   Tokens = annotate("cond? id : id2", Style);
2334   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2335   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2336 
2337   Tokens = annotate("cond ? cond2 ? : id1 : id2", Style);
2338   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2339   EXPECT_TOKEN(Tokens[1], tok::question, TT_ConditionalExpr);
2340 }
2341 
2342 TEST_F(TokenAnnotatorTest, UnderstandsLabels) {
2343   auto Tokens = annotate("{ x: break; }");
2344   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2345   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2346   Tokens = annotate("{ case x: break; }");
2347   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2348   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2349   Tokens = annotate("{ x: { break; } }");
2350   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2351   EXPECT_TOKEN(Tokens[2], tok::colon, TT_GotoLabelColon);
2352   Tokens = annotate("{ case x: { break; } }");
2353   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2354   EXPECT_TOKEN(Tokens[3], tok::colon, TT_CaseLabelColon);
2355 }
2356 
2357 TEST_F(TokenAnnotatorTest, UnderstandsNestedBlocks) {
2358   // The closing braces are not annotated. It doesn't seem to cause a problem.
2359   // So we only test for the opening braces.
2360   auto Tokens = annotate("{\n"
2361                          "  {\n"
2362                          "    { int a = 0; }\n"
2363                          "  }\n"
2364                          "  {}\n"
2365                          "}");
2366   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2367   EXPECT_BRACE_KIND(Tokens[0], BK_Block);
2368   EXPECT_BRACE_KIND(Tokens[1], BK_Block);
2369   EXPECT_BRACE_KIND(Tokens[2], BK_Block);
2370   EXPECT_BRACE_KIND(Tokens[10], BK_Block);
2371 }
2372 
2373 TEST_F(TokenAnnotatorTest, UnderstandDesignatedInitializers) {
2374   auto Tokens = annotate("SomeStruct { .a = 1 };");
2375   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2376   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2377   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2378 
2379   Tokens = annotate("SomeStruct { .a = 1, .b = 2 };");
2380   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2381   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2382   EXPECT_TOKEN(Tokens[2], tok::period, TT_DesignatedInitializerPeriod);
2383   EXPECT_TOKEN(Tokens[7], tok::period, TT_DesignatedInitializerPeriod);
2384 
2385   Tokens = annotate("SomeStruct {\n"
2386                     "#ifdef FOO\n"
2387                     "  .a = 1,\n"
2388                     "#endif\n"
2389                     "  .b = 2\n"
2390                     "};");
2391   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
2392   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2393   EXPECT_TOKEN(Tokens[5], tok::period, TT_DesignatedInitializerPeriod);
2394   EXPECT_TOKEN(Tokens[12], tok::period, TT_DesignatedInitializerPeriod);
2395 
2396   Tokens = annotate("SomeStruct {\n"
2397                     "#if defined FOO\n"
2398                     "  .a = 1,\n"
2399                     "#endif\n"
2400                     "  .b = 2\n"
2401                     "};");
2402   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
2403   EXPECT_BRACE_KIND(Tokens[1], BK_BracedInit);
2404   EXPECT_TOKEN(Tokens[6], tok::period, TT_DesignatedInitializerPeriod);
2405   EXPECT_TOKEN(Tokens[13], tok::period, TT_DesignatedInitializerPeriod);
2406 
2407   Tokens = annotate("Foo foo[] = {[0]{}};");
2408   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2409   EXPECT_TOKEN(Tokens[6], tok::l_square, TT_DesignatedInitializerLSquare);
2410   EXPECT_BRACE_KIND(Tokens[9], BK_BracedInit);
2411 }
2412 
2413 TEST_F(TokenAnnotatorTest, UnderstandsJavaScript) {
2414   auto Annotate = [this](llvm::StringRef Code) {
2415     return annotate(Code, getLLVMStyle(FormatStyle::LK_JavaScript));
2416   };
2417 
2418   // Dictionary.
2419   auto Tokens = Annotate("var x = {'x' : 1, 'y' : 2};");
2420   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2421   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_DictLiteral);
2422   EXPECT_TOKEN(Tokens[4], tok::string_literal, TT_SelectorName);
2423   EXPECT_TOKEN(Tokens[5], tok::colon, TT_DictLiteral);
2424   EXPECT_TOKEN(Tokens[8], tok::string_literal, TT_SelectorName);
2425   EXPECT_TOKEN(Tokens[9], tok::colon, TT_DictLiteral);
2426   // Change when we need to annotate these.
2427   EXPECT_BRACE_KIND(Tokens[3], BK_Unknown);
2428   EXPECT_BRACE_KIND(Tokens[11], BK_Unknown);
2429   EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_Unknown);
2430 }
2431 
2432 TEST_F(TokenAnnotatorTest, UnderstandsAttributes) {
2433   auto Tokens = annotate("bool foo __attribute__((unused));");
2434   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2435   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_StartOfName);
2436   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2437   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_Unknown);
2438   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_Unknown);
2439   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_AttributeRParen);
2440 
2441   Tokens = annotate("bool foo __declspec(dllimport);");
2442   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2443   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2444   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2445 
2446   Tokens = annotate("bool __attribute__((unused)) foo;");
2447   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2448   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_AttributeLParen);
2449   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_Unknown);
2450   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_Unknown);
2451   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_AttributeRParen);
2452   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_StartOfName);
2453 
2454   Tokens = annotate("void __attribute__((x)) Foo();");
2455   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2456   EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_AttributeLParen);
2457   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_Unknown);
2458   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_Unknown);
2459   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_AttributeRParen);
2460   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_FunctionDeclarationName);
2461 
2462   FormatStyle Style = getLLVMStyle();
2463   Style.AttributeMacros.push_back("FOO");
2464   Tokens = annotate("bool foo FOO(unused);", Style);
2465   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2466   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
2467   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
2468   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
2469 }
2470 
2471 TEST_F(TokenAnnotatorTest, UnderstandsControlStatements) {
2472   auto Tokens = annotate("while (true) {}");
2473   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2474   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2475   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2476 
2477   Tokens = annotate("for (;;) {}");
2478   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2479   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_ControlStatementLBrace);
2480   EXPECT_TOKEN(Tokens[6], tok::r_brace, TT_ControlStatementRBrace);
2481 
2482   Tokens = annotate("do {} while (true);");
2483   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2484   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_ControlStatementLBrace);
2485   EXPECT_TOKEN(Tokens[2], tok::r_brace, TT_ControlStatementRBrace);
2486 
2487   Tokens = annotate("if (true) {} else if (false) {} else {}");
2488   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
2489   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2490   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2491   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_ControlStatementLBrace);
2492   EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_ControlStatementRBrace);
2493   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_ElseLBrace);
2494   EXPECT_TOKEN(Tokens[15], tok::r_brace, TT_ElseRBrace);
2495 
2496   Tokens = annotate("switch (foo) {}");
2497   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2498   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_ControlStatementLBrace);
2499   EXPECT_TOKEN(Tokens[5], tok::r_brace, TT_ControlStatementRBrace);
2500 }
2501 
2502 TEST_F(TokenAnnotatorTest, UnderstandsDoWhile) {
2503   auto Tokens = annotate("do { ++i; } while ( i > 5 );");
2504   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
2505   EXPECT_TOKEN(Tokens[6], tok::kw_while, TT_DoWhile);
2506 
2507   Tokens = annotate("do ++i; while ( i > 5 );");
2508   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2509   EXPECT_TOKEN(Tokens[4], tok::kw_while, TT_DoWhile);
2510 }
2511 
2512 TEST_F(TokenAnnotatorTest, StartOfName) {
2513   auto Tokens = annotate("#pragma clang diagnostic push");
2514   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2515   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2516   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2517   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
2518 
2519   Tokens = annotate("#pragma clang diagnostic ignored \"-Wzero-length-array\"");
2520   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
2521   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2522   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2523   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_Unknown);
2524 
2525   Tokens = annotate("#define FOO Foo foo");
2526   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
2527   EXPECT_TOKEN(Tokens[2], tok::identifier, TT_Unknown);
2528   EXPECT_TOKEN(Tokens[3], tok::identifier, TT_Unknown);
2529   EXPECT_TOKEN(Tokens[4], tok::identifier, TT_StartOfName);
2530 }
2531 
2532 TEST_F(TokenAnnotatorTest, BraceKind) {
2533   auto Tokens = annotate("void f() {};");
2534   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
2535   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2536   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2537   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2538   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2539 
2540   Tokens = annotate("class Foo<int> f() {}");
2541   ASSERT_EQ(Tokens.size(), 11u) << Tokens;
2542   EXPECT_TOKEN(Tokens[5], tok::identifier, TT_FunctionDeclarationName);
2543   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_FunctionLBrace);
2544   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
2545   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
2546 
2547   Tokens = annotate("template <typename T> class Foo<T> f() {}");
2548   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
2549   EXPECT_TOKEN(Tokens[10], tok::identifier, TT_FunctionDeclarationName);
2550   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_FunctionLBrace);
2551   EXPECT_BRACE_KIND(Tokens[13], BK_Block);
2552   EXPECT_BRACE_KIND(Tokens[14], BK_Block);
2553 
2554   Tokens = annotate("void f() override {};");
2555   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2556   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2557   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_FunctionLBrace);
2558   EXPECT_BRACE_KIND(Tokens[5], BK_Block);
2559   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2560 
2561   Tokens = annotate("void f() noexcept(false) {};");
2562   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
2563   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2564   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_FunctionLBrace);
2565   EXPECT_BRACE_KIND(Tokens[8], BK_Block);
2566   EXPECT_BRACE_KIND(Tokens[9], BK_Block);
2567 
2568   Tokens = annotate("auto f() -> void {};");
2569   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
2570   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2571   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_FunctionLBrace);
2572   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2573   EXPECT_BRACE_KIND(Tokens[7], BK_Block);
2574 
2575   Tokens = annotate("void f() { /**/ };");
2576   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2577   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2578   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2579   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2580   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2581 
2582   Tokens = annotate("void f() { //\n"
2583                     "};");
2584   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2585   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2586   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2587   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2588   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2589 
2590   Tokens = annotate("void f() {\n"
2591                     "  //\n"
2592                     "};");
2593   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2594   EXPECT_TOKEN(Tokens[1], tok::identifier, TT_FunctionDeclarationName);
2595   EXPECT_TOKEN(Tokens[4], tok::l_brace, TT_FunctionLBrace);
2596   EXPECT_BRACE_KIND(Tokens[4], BK_Block);
2597   EXPECT_BRACE_KIND(Tokens[6], BK_Block);
2598 }
2599 
2600 TEST_F(TokenAnnotatorTest, StreamOperator) {
2601   auto Tokens = annotate("\"foo\\n\" << aux << \"foo\\n\" << \"foo\";");
2602   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
2603   EXPECT_FALSE(Tokens[1]->MustBreakBefore);
2604   EXPECT_FALSE(Tokens[3]->MustBreakBefore);
2605   // Only break between string literals if the former ends with \n.
2606   EXPECT_TRUE(Tokens[5]->MustBreakBefore);
2607 }
2608 
2609 } // namespace
2610 } // namespace format
2611 } // namespace clang
2612