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