xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision c6e7752f8e144ad78aee2e56a7c901c56be360de)
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_TOKEN(FormatTok, Kind, Type)                                    \
44   do {                                                                         \
45     EXPECT_TOKEN_KIND(FormatTok, Kind);                                        \
46     EXPECT_TOKEN_TYPE(FormatTok, Type);                                        \
47   } while (false)
48 
49 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfStarAndAmp) {
50   auto Tokens = annotate("auto x = [](const decltype(x) &ptr) {};");
51   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
52   EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown);
53   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen);
54   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown);
55   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
56   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
57 
58   Tokens = annotate("auto x = [](const decltype(x) *ptr) {};");
59   EXPECT_EQ(Tokens.size(), 18u) << Tokens;
60   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
61   EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference);
62 
63   Tokens = annotate("#define lambda [](const decltype(x) &ptr) {}");
64   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
65   EXPECT_TOKEN(Tokens[7], tok::kw_decltype, TT_Unknown);
66   EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_TypeDeclarationParen);
67   EXPECT_TOKEN(Tokens[9], tok::identifier, TT_Unknown);
68   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
69   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
70 
71   Tokens = annotate("#define lambda [](const decltype(x) *ptr) {}");
72   EXPECT_EQ(Tokens.size(), 17u) << Tokens;
73   EXPECT_TOKEN(Tokens[10], tok::r_paren, TT_TypeDeclarationParen);
74   EXPECT_TOKEN(Tokens[11], tok::star, TT_PointerOrReference);
75 
76   Tokens = annotate("void f() {\n"
77                     "  while (p < a && *p == 'a')\n"
78                     "    p++;\n"
79                     "}");
80   EXPECT_EQ(Tokens.size(), 21u) << Tokens;
81   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
82   EXPECT_TOKEN(Tokens[11], tok::star, TT_UnaryOperator);
83 
84   Tokens = annotate("case *x:");
85   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
86   EXPECT_TOKEN(Tokens[1], tok::star, TT_UnaryOperator);
87   Tokens = annotate("case &x:");
88   EXPECT_EQ(Tokens.size(), 5u) << Tokens;
89   EXPECT_TOKEN(Tokens[1], tok::amp, TT_UnaryOperator);
90 
91   Tokens = annotate("bool b = 3 == int{3} && true;\n");
92   EXPECT_EQ(Tokens.size(), 13u) << Tokens;
93   EXPECT_TOKEN(Tokens[9], tok::ampamp, TT_BinaryOperator);
94 
95   Tokens = annotate("struct {\n"
96                     "} *ptr;");
97   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
98   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
99   Tokens = annotate("union {\n"
100                     "} *ptr;");
101   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
102   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
103   Tokens = annotate("class {\n"
104                     "} *ptr;");
105   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
106   EXPECT_TOKEN(Tokens[3], tok::star, TT_PointerOrReference);
107 
108   Tokens = annotate("struct {\n"
109                     "} &&ptr = {};");
110   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
111   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
112   Tokens = annotate("union {\n"
113                     "} &&ptr = {};");
114   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
115   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
116   Tokens = annotate("class {\n"
117                     "} &&ptr = {};");
118   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
119   EXPECT_TOKEN(Tokens[3], tok::ampamp, TT_PointerOrReference);
120   Tokens = annotate("int i = int{42} * 2;");
121   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
122   EXPECT_TOKEN(Tokens[7], tok::star, TT_BinaryOperator);
123 
124   Tokens = annotate("delete[] *ptr;");
125   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
126   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
127   Tokens = annotate("delete[] **ptr;");
128   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
129   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
130   EXPECT_TOKEN(Tokens[4], tok::star, TT_UnaryOperator);
131   Tokens = annotate("delete[] *(ptr);");
132   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
133   EXPECT_TOKEN(Tokens[3], tok::star, TT_UnaryOperator);
134 }
135 
136 TEST_F(TokenAnnotatorTest, UnderstandsUsesOfPlusAndMinus) {
137   auto Tokens = annotate("x - 0");
138   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
139   EXPECT_TOKEN(Tokens[1], tok::minus, TT_BinaryOperator);
140   Tokens = annotate("0 + 0");
141   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
142   EXPECT_TOKEN(Tokens[1], tok::plus, TT_BinaryOperator);
143   Tokens = annotate("x + +0");
144   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
145   EXPECT_TOKEN(Tokens[2], tok::plus, TT_UnaryOperator);
146   Tokens = annotate("x ? -0 : +0");
147   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
148   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
149   EXPECT_TOKEN(Tokens[5], tok::plus, TT_UnaryOperator);
150   Tokens = annotate("(-0)");
151   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
152   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
153   Tokens = annotate("0, -0");
154   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
155   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
156   Tokens = annotate("for (; -1;) {\n}");
157   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
158   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
159   Tokens = annotate("x = -1;");
160   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
161   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
162   Tokens = annotate("x[-1]");
163   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
164   EXPECT_TOKEN(Tokens[2], tok::minus, TT_UnaryOperator);
165   Tokens = annotate("x = {-1};");
166   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
167   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
168   Tokens = annotate("case -x:");
169   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
170   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
171   Tokens = annotate("co_await -x;");
172   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
173   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
174   Tokens = annotate("co_return -x;");
175   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
176   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
177   Tokens = annotate("co_yield -x;");
178   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
179   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
180   Tokens = annotate("delete -x;");
181   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
182   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
183   Tokens = annotate("return -x;");
184   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
185   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
186   Tokens = annotate("throw -x;");
187   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
188   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
189   Tokens = annotate("sizeof -x");
190   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
191   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
192   Tokens = annotate("co_await +x;");
193   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
194   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
195   Tokens = annotate("co_return +x;");
196   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
197   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
198   Tokens = annotate("co_yield +x;");
199   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
200   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
201   Tokens = annotate("delete +x;");
202   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
203   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
204   Tokens = annotate("return +x;");
205   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
206   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
207   Tokens = annotate("throw +x;");
208   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
209   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
210   Tokens = annotate("sizeof +x");
211   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
212   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
213   Tokens = annotate("(int)-x");
214   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
215   EXPECT_TOKEN(Tokens[3], tok::minus, TT_UnaryOperator);
216   Tokens = annotate("(-x)");
217   ASSERT_EQ(Tokens.size(), 5u) << Tokens;
218   EXPECT_TOKEN(Tokens[1], tok::minus, TT_UnaryOperator);
219   Tokens = annotate("!+x");
220   ASSERT_EQ(Tokens.size(), 4u) << Tokens;
221   EXPECT_TOKEN(Tokens[0], tok::exclaim, TT_UnaryOperator);
222   EXPECT_TOKEN(Tokens[1], tok::plus, TT_UnaryOperator);
223 }
224 
225 TEST_F(TokenAnnotatorTest, UnderstandsClasses) {
226   auto Tokens = annotate("class C {};");
227   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
228   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
229 
230   Tokens = annotate("const class C {} c;");
231   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
232   EXPECT_TOKEN(Tokens[3], tok::l_brace, TT_ClassLBrace);
233 
234   Tokens = annotate("const class {} c;");
235   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
236   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_ClassLBrace);
237 }
238 
239 TEST_F(TokenAnnotatorTest, UnderstandsStructs) {
240   auto Tokens = annotate("struct S {};");
241   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
242   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_StructLBrace);
243 }
244 
245 TEST_F(TokenAnnotatorTest, UnderstandsUnions) {
246   auto Tokens = annotate("union U {};");
247   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
248   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
249 
250   Tokens = annotate("union U { void f() { return; } };");
251   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
252   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_UnionLBrace);
253   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_FunctionLBrace);
254 }
255 
256 TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
257   auto Tokens = annotate("enum E {};");
258   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
259   EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
260 }
261 
262 TEST_F(TokenAnnotatorTest, UnderstandsDefaultedAndDeletedFunctions) {
263   auto Tokens = annotate("auto operator<=>(const T &) const & = default;");
264   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
265   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
266 
267   Tokens = annotate("template <typename T> void F(T) && = delete;");
268   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
269   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_PointerOrReference);
270 }
271 
272 TEST_F(TokenAnnotatorTest, UnderstandsVariables) {
273   auto Tokens =
274       annotate("inline bool var = is_integral_v<int> && is_signed_v<int>;");
275   EXPECT_EQ(Tokens.size(), 15u) << Tokens;
276   EXPECT_TOKEN(Tokens[8], tok::ampamp, TT_BinaryOperator);
277 }
278 
279 TEST_F(TokenAnnotatorTest, UnderstandsVariableTemplates) {
280   auto Tokens =
281       annotate("template <typename T> "
282                "inline bool var = is_integral_v<int> && is_signed_v<int>;");
283   EXPECT_EQ(Tokens.size(), 20u) << Tokens;
284   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
285 }
286 
287 TEST_F(TokenAnnotatorTest, UnderstandsWhitespaceSensitiveMacros) {
288   FormatStyle Style = getLLVMStyle();
289   Style.WhitespaceSensitiveMacros.push_back("FOO");
290 
291   auto Tokens = annotate("FOO(1+2 )\n", Style);
292   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
293   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
294 
295   Tokens = annotate("FOO(a:b:c)\n", Style);
296   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
297   EXPECT_TOKEN(Tokens[0], tok::identifier, TT_UntouchableMacroFunc);
298 }
299 
300 TEST_F(TokenAnnotatorTest, UnderstandsDelete) {
301   auto Tokens = annotate("delete (void *)p;");
302   EXPECT_EQ(Tokens.size(), 8u) << Tokens;
303   EXPECT_TOKEN(Tokens[4], tok::r_paren, TT_CastRParen);
304 
305   Tokens = annotate("delete[] (void *)p;");
306   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
307   EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_CastRParen);
308 
309   Tokens = annotate("delete[] /*comment*/ (void *)p;");
310   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
311   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
312 
313   Tokens = annotate("delete[/*comment*/] (void *)p;");
314   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
315   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
316 
317   Tokens = annotate("delete/*comment*/[] (void *)p;");
318   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
319   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
320 }
321 
322 TEST_F(TokenAnnotatorTest, UnderstandsCasts) {
323   auto Tokens = annotate("(void)p;");
324   EXPECT_EQ(Tokens.size(), 6u) << Tokens;
325   EXPECT_TOKEN(Tokens[2], tok::r_paren, TT_CastRParen);
326 
327   Tokens = annotate("auto x = (Foo)p;");
328   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
329   EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_CastRParen);
330 
331   Tokens = annotate("(std::vector<int>)p;");
332   EXPECT_EQ(Tokens.size(), 11u) << Tokens;
333   EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_CastRParen);
334 
335   Tokens = annotate("return (Foo)p;");
336   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
337   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
338 
339   Tokens = annotate("throw (Foo)p;");
340   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
341   EXPECT_TOKEN(Tokens[3], tok::r_paren, TT_CastRParen);
342 }
343 
344 TEST_F(TokenAnnotatorTest, UnderstandsDynamicExceptionSpecifier) {
345   auto Tokens = annotate("void f() throw(int);");
346   EXPECT_EQ(Tokens.size(), 10u) << Tokens;
347   EXPECT_TOKEN(Tokens[4], tok::kw_throw, TT_Unknown);
348 }
349 
350 TEST_F(TokenAnnotatorTest, UnderstandsFunctionRefQualifiers) {
351   auto Tokens = annotate("void f() &;");
352   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
353   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
354 
355   Tokens = annotate("void operator=(T) &&;");
356   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
357   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
358 
359   Tokens = annotate("template <typename T> void f() &;");
360   EXPECT_EQ(Tokens.size(), 12u) << Tokens;
361   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
362 
363   Tokens = annotate("template <typename T> void operator=(T) &;");
364   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
365   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
366 }
367 
368 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
369   auto Tokens = annotate("template <typename T>\n"
370                          "concept C = (Foo && Bar) && (Bar && Baz);");
371 
372   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
373   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
374   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
375   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
376 
377   Tokens = annotate("template <typename T>\n"
378                     "concept C = requires(T t) {\n"
379                     "  { t.foo() };\n"
380                     "} && Bar<T> && Baz<T>;");
381   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
382   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
383   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
384   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
385   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
386   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
387 
388   Tokens = annotate("template<typename T>\n"
389                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
390                     "struct Foo;");
391   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
392   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
393   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
394   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
395   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
396   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
397   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
398   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
399   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
400   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
401   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
402 
403   Tokens =
404       annotate("template<typename T>\n"
405                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
406                "struct Foo;");
407   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
408   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
409   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
410   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
411   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
412   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
413   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
414   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
415   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
416   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
417   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
418   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
419 
420   Tokens = annotate("template <typename T>\n"
421                     "void foo(T) noexcept requires Bar<T>;");
422   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
423   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
424 
425   Tokens = annotate("template <typename T>\n"
426                     "struct S {\n"
427                     "  void foo() const requires Bar<T>;\n"
428                     "  void bar() const & requires Baz<T>;\n"
429                     "  void bar() && requires Baz2<T>;\n"
430                     "  void baz() const & noexcept requires Baz<T>;\n"
431                     "  void baz() && noexcept requires Baz2<T>;\n"
432                     "};\n"
433                     "\n"
434                     "void S::bar() const & requires Baz<T> { }");
435   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
436   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
437   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
438   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
439   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
440   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
441   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
442 
443   Tokens = annotate("void Class::member() && requires(Constant) {}");
444   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
445   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
446 
447   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
448   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
449   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
450 
451   Tokens =
452       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
453   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
454   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
455 
456   Tokens = annotate("void Class::member() && requires(typename "
457                     "Namespace::Outer<T>::Inner::Constant) {}");
458   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
459   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
460 
461   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
462                     "  template<class T>\n"
463                     "    requires requires { number_zero_v<T>; }\n"
464                     "  [[nodiscard]] constexpr operator T() const { "
465                     "return number_zero_v<T>; }\n"
466                     "};");
467   ASSERT_EQ(Tokens.size(), 44u);
468   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
469   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
470   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
471   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
472   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
473   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
474 
475   Tokens =
476       annotate("template <class A, class B> concept C ="
477                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
478   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
479   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
480   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
481   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
482   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
483   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
484   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
485   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
486 
487   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
488   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
489   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
490 
491   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
492   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
493   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
494 
495   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
496   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
497   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
498 
499   Tokens =
500       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
501   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
502   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
503 
504   Tokens =
505       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
506   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
507   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
508 
509   Tokens =
510       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
511   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
512   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
513 }
514 
515 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
516   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
517   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
518   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
519   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
520   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
521 
522   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
523   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
524   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
525   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
526   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
527 
528   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
529   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
530   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
531   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
532   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
533 
534   Tokens = annotate("foo(requires(const T t) {});");
535   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
536   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
537   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
538   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
539 
540   Tokens = annotate("foo(requires(const int t) {});");
541   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
542   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
543   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
544   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
545 
546   Tokens = annotate("foo(requires(const T t) {});");
547   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
548   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
549   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
550   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
551 
552   Tokens = annotate("foo(requires(int const* volatile t) {});");
553   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
554   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
555   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
556   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
557 
558   Tokens = annotate("foo(requires(T const* volatile t) {});");
559   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
560   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
561   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
562   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
563 
564   Tokens =
565       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
566   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
567   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
568   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
569   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
570 
571   Tokens = annotate("template <typename T>\n"
572                     "concept C = requires(T T) {\n"
573                     "  requires Bar<T> && Foo<T>;\n"
574                     "};");
575   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
576   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
577   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
578   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
579   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
580                TT_RequiresClauseInARequiresExpression);
581 
582   Tokens = annotate("template <typename T>\n"
583                     "concept C = requires(T T) {\n"
584                     "  { t.func() } -> std::same_as<int>;"
585                     "  requires Bar<T> && Foo<T>;\n"
586                     "};");
587   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
588   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
589   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
590   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
591   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
592                TT_RequiresClauseInARequiresExpression);
593 
594   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
595   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
596                     "requires true; };");
597   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
598   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
599   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
600   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
601 }
602 
603 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
604   const char *BaseCode = nullptr;
605   const char *ConstrainedCode = nullptr;
606   auto BaseTokenCount = 0u;
607   auto RequiresTokenCount = 0u;
608   auto PrefixTokenCount = 0u;
609 
610   auto TestRequires = [&](int Line) {
611     const auto BaseTokens = annotate(BaseCode);
612     const auto ConstrainedTokens = annotate(ConstrainedCode);
613 
614 #define LINE " (Line " << Line << ')'
615 
616     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
617     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
618         << LINE;
619 
620     for (auto I = 0u; I < BaseTokenCount; ++I) {
621       EXPECT_EQ(
622           *BaseTokens[I],
623           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
624           << I << LINE;
625     }
626 
627 #undef LINE
628   };
629 
630   BaseCode = "template<typename T>\n"
631              "T Pi = 3.14;";
632   ConstrainedCode = "template<typename T>\n"
633                     "  requires Foo<T>\n"
634                     "T Pi = 3.14;";
635   BaseTokenCount = 11;
636   RequiresTokenCount = 5;
637   PrefixTokenCount = 5;
638   TestRequires(__LINE__);
639 
640   BaseCode = "template<typename T>\n"
641              "struct Bar;";
642   ConstrainedCode = "template<typename T>\n"
643                     "  requires Foo<T>\n"
644                     "struct Bar;";
645   BaseTokenCount = 9;
646   TestRequires(__LINE__);
647 
648   BaseCode = "template<typename T>\n"
649              "struct Bar {\n"
650              "  T foo();\n"
651              "  T bar();\n"
652              "};";
653   ConstrainedCode = "template<typename T>\n"
654                     "  requires Foo<T>\n"
655                     "struct Bar {\n"
656                     "  T foo();\n"
657                     "  T bar();\n"
658                     "};";
659   BaseTokenCount = 21;
660   TestRequires(__LINE__);
661 
662   BaseCode = "template<typename T>\n"
663              "Bar(T) -> Bar<T>;";
664   ConstrainedCode = "template<typename T>\n"
665                     "  requires Foo<T>\n"
666                     "Bar(T) -> Bar<T>;";
667   BaseTokenCount = 16;
668   TestRequires(__LINE__);
669 
670   BaseCode = "template<typename T>\n"
671              "T foo();";
672   ConstrainedCode = "template<typename T>\n"
673                     "  requires Foo<T>\n"
674                     "T foo();";
675   BaseTokenCount = 11;
676   TestRequires(__LINE__);
677 
678   BaseCode = "template<typename T>\n"
679              "T foo() {\n"
680              "  auto bar = baz();\n"
681              "  return bar + T{};\n"
682              "}";
683   ConstrainedCode = "template<typename T>\n"
684                     "  requires Foo<T>\n"
685                     "T foo() {\n"
686                     "  auto bar = baz();\n"
687                     "  return bar + T{};\n"
688                     "}";
689   BaseTokenCount = 26;
690   TestRequires(__LINE__);
691 
692   BaseCode = "template<typename T>\n"
693              "T foo();";
694   ConstrainedCode = "template<typename T>\n"
695                     "T foo() requires Foo<T>;";
696   BaseTokenCount = 11;
697   PrefixTokenCount = 9;
698   TestRequires(__LINE__);
699 
700   BaseCode = "template<typename T>\n"
701              "T foo() {\n"
702              "  auto bar = baz();\n"
703              "  return bar + T{};\n"
704              "}";
705   ConstrainedCode = "template<typename T>\n"
706                     "T foo() requires Foo<T> {\n"
707                     "  auto bar = baz();\n"
708                     "  return bar + T{};\n"
709                     "}";
710   BaseTokenCount = 26;
711   TestRequires(__LINE__);
712 
713   BaseCode = "template<typename T>\n"
714              "Bar(T) -> Bar<typename T::I>;";
715   ConstrainedCode = "template<typename T>\n"
716                     "  requires requires(T &&t) {\n"
717                     "             typename T::I;\n"
718                     "           }\n"
719                     "Bar(T) -> Bar<typename T::I>;";
720   BaseTokenCount = 19;
721   RequiresTokenCount = 14;
722   PrefixTokenCount = 5;
723   TestRequires(__LINE__);
724 
725   BaseCode = "struct [[nodiscard]] zero_t {\n"
726              "  template<class T>\n"
727              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
728              "};";
729   ConstrainedCode =
730       "struct [[nodiscard]] zero_t {\n"
731       "  template<class T>\n"
732       "    requires requires { v<T>; }\n"
733       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
734       "};";
735   BaseTokenCount = 35;
736   RequiresTokenCount = 9;
737   PrefixTokenCount = 13;
738   TestRequires(__LINE__);
739 
740   BaseCode = "constexpr Foo(Foo const &other)\n"
741              "    : value{other.value} {\n"
742              "  do_magic();\n"
743              "  do_more_magic();\n"
744              "}";
745   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
746                     "  requires std::is_copy_constructible<T>\n"
747                     "    : value{other.value} {\n"
748                     "  do_magic();\n"
749                     "  do_more_magic();\n"
750                     "}";
751   BaseTokenCount = 26;
752   RequiresTokenCount = 7;
753   PrefixTokenCount = 8;
754   TestRequires(__LINE__);
755 
756   BaseCode = "constexpr Foo(Foo const &other)\n"
757              "    : value{other.value} {\n"
758              "  do_magic();\n"
759              "  do_more_magic();\n"
760              "}";
761   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
762                     "  requires (std::is_copy_constructible<T>)\n"
763                     "    : value{other.value} {\n"
764                     "  do_magic();\n"
765                     "  do_more_magic();\n"
766                     "}";
767   RequiresTokenCount = 9;
768   TestRequires(__LINE__);
769 }
770 
771 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
772   auto Tokens = annotate("__asm{\n"
773                          "a:\n"
774                          "};");
775   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
776   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
777   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
778   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
779 }
780 
781 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
782   auto Tokens = annotate("int (^)() = ^ ()\n"
783                          "  external_source_symbol() { //\n"
784                          "  return 1;\n"
785                          "};");
786   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
787   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
788   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
789 
790   Tokens = annotate("int *p = ^int*(){ //\n"
791                     "  return nullptr;\n"
792                     "}();");
793   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
794   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
795 }
796 
797 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
798   auto Tokens = annotate("[]() constexpr {}");
799   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
800   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
801   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
802 
803   Tokens = annotate("[]() -> auto {}");
804   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
805   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
806   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
807 
808   Tokens = annotate("[]() -> auto & {}");
809   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
810   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
811   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
812 
813   Tokens = annotate("[]() -> auto * {}");
814   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
815   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
816   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
817 }
818 
819 TEST_F(TokenAnnotatorTest, UnderstandsFunctionAnnotations) {
820   auto Tokens = annotate("template <typename T>\n"
821                          "DEPRECATED(\"Use NewClass::NewFunction instead.\")\n"
822                          "string OldFunction(const string &parameter) {}");
823   ASSERT_EQ(Tokens.size(), 20u) << Tokens;
824   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_FunctionAnnotationRParen);
825 
826   Tokens = annotate("template <typename T>\n"
827                     "A(T) noexcept;");
828   ASSERT_EQ(Tokens.size(), 12u) << Tokens;
829   EXPECT_TOKEN(Tokens[8], tok::r_paren, TT_Unknown);
830 }
831 
832 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
833   auto Annotate = [this](llvm::StringRef Code) {
834     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
835   };
836   // Test that unary operators get labeled as such and that operators like '++'
837   // don't get split.
838   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
839                             tok::tilde, tok::amp,      tok::pipe,
840                             tok::caret, tok::plusplus, tok::minusminus};
841   for (auto Kind : Unary) {
842     auto Tokens =
843         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
844     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
845     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
846   }
847   // Operators formed by joining two operators like '^~'. For some of these
848   // joined operators, we don't have a separate type, so we only test for their
849   // precedence.
850   std::pair<prec::Level, std::string> JoinedBinary[] = {
851       {prec::Comma, "<->"},       {prec::Assignment, "+="},
852       {prec::Assignment, "-="},   {prec::Assignment, "*="},
853       {prec::Assignment, "/="},   {prec::Assignment, "%="},
854       {prec::Assignment, "&="},   {prec::Assignment, "^="},
855       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
856       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
857       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
858       {prec::Equality, "=="},     {prec::Equality, "!="},
859       {prec::Equality, "==="},    {prec::Equality, "!=="},
860       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
861       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
862   };
863   for (auto Operator : JoinedBinary) {
864     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
865     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
866     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
867     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
868   }
869   // '~^' and '^~' can be unary as well as binary operators.
870   auto Tokens = Annotate("x = ~^x;");
871   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
872   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
873   Tokens = Annotate("x = ^~x;");
874   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
875   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
876   // The unary operators '~&' and '~|' can only be unary operators. The current
877   // implementation treats each of them as separate unary '~' and '&' or '|'
878   // operators, which is enough for formatting purposes. In FormatTestVerilog,
879   // there is a test that there is no space in between. And even if a new line
880   // is inserted between the '~' and '|', the semantic meaning is the same as
881   // the joined operator, so the CanBreakBefore property doesn't need to be
882   // false for the second operator.
883   Tokens = Annotate("x = ~&x;");
884   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
885   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
886   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
887   Tokens = Annotate("x = ~|x;");
888   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
889   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
890   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
891   // Test for block label colons.
892   Tokens = Annotate("begin : x\n"
893                     "end : x");
894   ASSERT_EQ(Tokens.size(), 7u);
895   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
896   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
897   // Test that the dimension colon is annotated correctly.
898   Tokens = Annotate("var [1 : 0] x;");
899   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
900   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
901   Tokens = Annotate("extern function [1 : 0] x;");
902   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
903   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
904   // Test case labels and ternary operators.
905   Tokens = Annotate("case (x)\n"
906                     "  x:\n"
907                     "    x;\n"
908                     "endcase\n");
909   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
910   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GotoLabelColon);
911   Tokens = Annotate("case (x)\n"
912                     "  x ? x : x:\n"
913                     "    x;\n"
914                     "endcase\n");
915   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
916   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
917   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
918   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GotoLabelColon);
919 }
920 
921 } // namespace
922 } // namespace format
923 } // namespace clang
924