xref: /llvm-project/clang/unittests/Format/TokenAnnotatorTest.cpp (revision 3bbdf06b28275a56ad36a844d271d84956d1d7e9)
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, UnderstandsFunctionRefQualifiers) {
323   auto Tokens = annotate("void f() &;");
324   EXPECT_EQ(Tokens.size(), 7u) << Tokens;
325   EXPECT_TOKEN(Tokens[4], tok::amp, TT_PointerOrReference);
326 
327   Tokens = annotate("void operator=(T) &&;");
328   EXPECT_EQ(Tokens.size(), 9u) << Tokens;
329   EXPECT_TOKEN(Tokens[6], tok::ampamp, TT_PointerOrReference);
330 
331   Tokens = annotate("template <typename T> void f() &;");
332   EXPECT_EQ(Tokens.size(), 12u) << Tokens;
333   EXPECT_TOKEN(Tokens[9], tok::amp, TT_PointerOrReference);
334 
335   Tokens = annotate("template <typename T> void operator=(T) &;");
336   EXPECT_EQ(Tokens.size(), 14u) << Tokens;
337   EXPECT_TOKEN(Tokens[11], tok::amp, TT_PointerOrReference);
338 }
339 
340 TEST_F(TokenAnnotatorTest, UnderstandsRequiresClausesAndConcepts) {
341   auto Tokens = annotate("template <typename T>\n"
342                          "concept C = (Foo && Bar) && (Bar && Baz);");
343 
344   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
345   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
346   EXPECT_TOKEN(Tokens[13], tok::ampamp, TT_BinaryOperator);
347   EXPECT_TOKEN(Tokens[16], tok::ampamp, TT_BinaryOperator);
348 
349   Tokens = annotate("template <typename T>\n"
350                     "concept C = requires(T t) {\n"
351                     "  { t.foo() };\n"
352                     "} && Bar<T> && Baz<T>;");
353   ASSERT_EQ(Tokens.size(), 35u) << Tokens;
354   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
355   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
356   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
357   EXPECT_TOKEN(Tokens[23], tok::ampamp, TT_BinaryOperator);
358   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
359 
360   Tokens = annotate("template<typename T>\n"
361                     "requires C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>\n"
362                     "struct Foo;");
363   ASSERT_EQ(Tokens.size(), 36u) << Tokens;
364   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
365   EXPECT_TOKEN(Tokens[6], tok::identifier, TT_Unknown);
366   EXPECT_EQ(Tokens[6]->FakeLParens.size(), 1u);
367   EXPECT_TOKEN(Tokens[10], tok::ampamp, TT_BinaryOperator);
368   EXPECT_TOKEN(Tokens[16], tok::pipepipe, TT_BinaryOperator);
369   EXPECT_TOKEN(Tokens[21], tok::ampamp, TT_BinaryOperator);
370   EXPECT_TOKEN(Tokens[27], tok::ampamp, TT_BinaryOperator);
371   EXPECT_TOKEN(Tokens[31], tok::greater, TT_TemplateCloser);
372   EXPECT_EQ(Tokens[31]->FakeRParens, 1u);
373   EXPECT_TRUE(Tokens[31]->ClosesRequiresClause);
374 
375   Tokens =
376       annotate("template<typename T>\n"
377                "requires (C1<T> && (C21<T> || C22<T> && C2e<T>) && C3<T>)\n"
378                "struct Foo;");
379   ASSERT_EQ(Tokens.size(), 38u) << Tokens;
380   EXPECT_TOKEN(Tokens[5], tok::kw_requires, TT_RequiresClause);
381   EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
382   EXPECT_EQ(Tokens[7]->FakeLParens.size(), 1u);
383   EXPECT_TOKEN(Tokens[11], tok::ampamp, TT_BinaryOperator);
384   EXPECT_TOKEN(Tokens[17], tok::pipepipe, TT_BinaryOperator);
385   EXPECT_TOKEN(Tokens[22], tok::ampamp, TT_BinaryOperator);
386   EXPECT_TOKEN(Tokens[28], tok::ampamp, TT_BinaryOperator);
387   EXPECT_TOKEN(Tokens[32], tok::greater, TT_TemplateCloser);
388   EXPECT_EQ(Tokens[32]->FakeRParens, 1u);
389   EXPECT_TOKEN(Tokens[33], tok::r_paren, TT_Unknown);
390   EXPECT_TRUE(Tokens[33]->ClosesRequiresClause);
391 
392   Tokens = annotate("template <typename T>\n"
393                     "void foo(T) noexcept requires Bar<T>;");
394   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
395   EXPECT_TOKEN(Tokens[11], tok::kw_requires, TT_RequiresClause);
396 
397   Tokens = annotate("template <typename T>\n"
398                     "struct S {\n"
399                     "  void foo() const requires Bar<T>;\n"
400                     "  void bar() const & requires Baz<T>;\n"
401                     "  void bar() && requires Baz2<T>;\n"
402                     "  void baz() const & noexcept requires Baz<T>;\n"
403                     "  void baz() && noexcept requires Baz2<T>;\n"
404                     "};\n"
405                     "\n"
406                     "void S::bar() const & requires Baz<T> { }");
407   ASSERT_EQ(Tokens.size(), 85u) << Tokens;
408   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
409   EXPECT_TOKEN(Tokens[25], tok::kw_requires, TT_RequiresClause);
410   EXPECT_TOKEN(Tokens[36], tok::kw_requires, TT_RequiresClause);
411   EXPECT_TOKEN(Tokens[49], tok::kw_requires, TT_RequiresClause);
412   EXPECT_TOKEN(Tokens[61], tok::kw_requires, TT_RequiresClause);
413   EXPECT_TOKEN(Tokens[77], tok::kw_requires, TT_RequiresClause);
414 
415   Tokens = annotate("void Class::member() && requires(Constant) {}");
416   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
417   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
418 
419   Tokens = annotate("void Class::member() && requires(Constant<T>) {}");
420   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
421   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
422 
423   Tokens =
424       annotate("void Class::member() && requires(Namespace::Constant<T>) {}");
425   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
426   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
427 
428   Tokens = annotate("void Class::member() && requires(typename "
429                     "Namespace::Outer<T>::Inner::Constant) {}");
430   ASSERT_EQ(Tokens.size(), 24u) << Tokens;
431   EXPECT_TOKEN(Tokens[7], tok::kw_requires, TT_RequiresClause);
432 
433   Tokens = annotate("struct [[nodiscard]] zero_t {\n"
434                     "  template<class T>\n"
435                     "    requires requires { number_zero_v<T>; }\n"
436                     "  [[nodiscard]] constexpr operator T() const { "
437                     "return number_zero_v<T>; }\n"
438                     "};");
439   ASSERT_EQ(Tokens.size(), 44u);
440   EXPECT_TOKEN(Tokens[13], tok::kw_requires, TT_RequiresClause);
441   EXPECT_TOKEN(Tokens[14], tok::kw_requires, TT_RequiresExpression);
442   EXPECT_TOKEN(Tokens[15], tok::l_brace, TT_RequiresExpressionLBrace);
443   EXPECT_TOKEN(Tokens[21], tok::r_brace, TT_Unknown);
444   EXPECT_EQ(Tokens[21]->MatchingParen, Tokens[15]);
445   EXPECT_TRUE(Tokens[21]->ClosesRequiresClause);
446 
447   Tokens =
448       annotate("template <class A, class B> concept C ="
449                "std::same_as<std::iter_value_t<A>, std::iter_value_t<B>>;");
450   ASSERT_EQ(Tokens.size(), 31u) << Tokens;
451   EXPECT_TOKEN(Tokens[8], tok::kw_concept, TT_Unknown);
452   EXPECT_TOKEN(Tokens[14], tok::less, TT_TemplateOpener);
453   EXPECT_TOKEN(Tokens[18], tok::less, TT_TemplateOpener);
454   EXPECT_TOKEN(Tokens[20], tok::greater, TT_TemplateCloser);
455   EXPECT_TOKEN(Tokens[25], tok::less, TT_TemplateOpener);
456   EXPECT_TOKEN(Tokens[27], tok::greater, TT_TemplateCloser);
457   EXPECT_TOKEN(Tokens[28], tok::greater, TT_TemplateCloser);
458 
459   Tokens = annotate("auto bar() -> int requires(is_integral_v<T>) {}");
460   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
461   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
462 
463   Tokens = annotate("auto bar() -> void requires(is_integral_v<T>) {}");
464   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
465   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
466 
467   Tokens = annotate("auto bar() -> MyType requires(is_integral_v<T>) {}");
468   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
469   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
470 
471   Tokens =
472       annotate("auto bar() -> SOME_MACRO_TYPE requires(is_integral_v<T>) {}");
473   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
474   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresClause);
475 
476   Tokens =
477       annotate("auto bar() -> qualified::type requires(is_integral_v<T>) {}");
478   ASSERT_EQ(Tokens.size(), 18u) << Tokens;
479   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresClause);
480 
481   Tokens =
482       annotate("auto bar() -> Template<type> requires(is_integral_v<T>) {}");
483   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
484   EXPECT_TOKEN(Tokens[9], tok::kw_requires, TT_RequiresClause);
485 }
486 
487 TEST_F(TokenAnnotatorTest, UnderstandsRequiresExpressions) {
488   auto Tokens = annotate("bool b = requires(int i) { i + 5; };");
489   ASSERT_EQ(Tokens.size(), 16u) << Tokens;
490   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
491   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
492   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
493 
494   Tokens = annotate("if (requires(int i) { i + 5; }) return;");
495   ASSERT_EQ(Tokens.size(), 17u) << Tokens;
496   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
497   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
498   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_RequiresExpressionLBrace);
499 
500   Tokens = annotate("if (func() && requires(int i) { i + 5; }) return;");
501   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
502   EXPECT_TOKEN(Tokens[6], tok::kw_requires, TT_RequiresExpression);
503   EXPECT_TOKEN(Tokens[7], tok::l_paren, TT_RequiresExpressionLParen);
504   EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_RequiresExpressionLBrace);
505 
506   Tokens = annotate("foo(requires(const T t) {});");
507   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
508   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
509   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
510   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
511 
512   Tokens = annotate("foo(requires(const int t) {});");
513   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
514   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
515   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
516   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
517 
518   Tokens = annotate("foo(requires(const T t) {});");
519   ASSERT_EQ(Tokens.size(), 13u) << Tokens;
520   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
521   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
522   EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_RequiresExpressionLBrace);
523 
524   Tokens = annotate("foo(requires(int const* volatile t) {});");
525   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
526   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
527   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
528   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
529 
530   Tokens = annotate("foo(requires(T const* volatile t) {});");
531   ASSERT_EQ(Tokens.size(), 15u) << Tokens;
532   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
533   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
534   EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_RequiresExpressionLBrace);
535 
536   Tokens =
537       annotate("foo(requires(const typename Outer<T>::Inner * const t) {});");
538   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
539   EXPECT_TOKEN(Tokens[2], tok::kw_requires, TT_RequiresExpression);
540   EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_RequiresExpressionLParen);
541   EXPECT_TOKEN(Tokens[16], tok::l_brace, TT_RequiresExpressionLBrace);
542 
543   Tokens = annotate("template <typename T>\n"
544                     "concept C = requires(T T) {\n"
545                     "  requires Bar<T> && Foo<T>;\n"
546                     "};");
547   ASSERT_EQ(Tokens.size(), 28u) << Tokens;
548   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
549   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
550   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
551   EXPECT_TOKEN(Tokens[14], tok::kw_requires,
552                TT_RequiresClauseInARequiresExpression);
553 
554   Tokens = annotate("template <typename T>\n"
555                     "concept C = requires(T T) {\n"
556                     "  { t.func() } -> std::same_as<int>;"
557                     "  requires Bar<T> && Foo<T>;\n"
558                     "};");
559   ASSERT_EQ(Tokens.size(), 43u) << Tokens;
560   EXPECT_TOKEN(Tokens[8], tok::kw_requires, TT_RequiresExpression);
561   EXPECT_TOKEN(Tokens[9], tok::l_paren, TT_RequiresExpressionLParen);
562   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_RequiresExpressionLBrace);
563   EXPECT_TOKEN(Tokens[29], tok::kw_requires,
564                TT_RequiresClauseInARequiresExpression);
565 
566   // Invalid Code, but we don't want to crash. See http://llvm.org/PR54350.
567   Tokens = annotate("bool r10 = requires (struct new_struct { int x; } s) { "
568                     "requires true; };");
569   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
570   EXPECT_TOKEN(Tokens[3], tok::kw_requires, TT_RequiresExpression);
571   EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_RequiresExpressionLParen);
572   EXPECT_TOKEN(Tokens[14], tok::l_brace, TT_RequiresExpressionLBrace);
573 }
574 
575 TEST_F(TokenAnnotatorTest, RequiresDoesNotChangeParsingOfTheRest) {
576   const char *BaseCode = nullptr;
577   const char *ConstrainedCode = nullptr;
578   auto BaseTokenCount = 0u;
579   auto RequiresTokenCount = 0u;
580   auto PrefixTokenCount = 0u;
581 
582   auto TestRequires = [&](int Line) {
583     const auto BaseTokens = annotate(BaseCode);
584     const auto ConstrainedTokens = annotate(ConstrainedCode);
585 
586 #define LINE " (Line " << Line << ')'
587 
588     ASSERT_EQ(BaseTokens.size(), BaseTokenCount) << BaseTokens << LINE;
589     ASSERT_EQ(ConstrainedTokens.size(), BaseTokenCount + RequiresTokenCount)
590         << LINE;
591 
592     for (auto I = 0u; I < BaseTokenCount; ++I) {
593       EXPECT_EQ(
594           *BaseTokens[I],
595           *ConstrainedTokens[I < PrefixTokenCount ? I : I + RequiresTokenCount])
596           << I << LINE;
597     }
598 
599 #undef LINE
600   };
601 
602   BaseCode = "template<typename T>\n"
603              "T Pi = 3.14;";
604   ConstrainedCode = "template<typename T>\n"
605                     "  requires Foo<T>\n"
606                     "T Pi = 3.14;";
607   BaseTokenCount = 11;
608   RequiresTokenCount = 5;
609   PrefixTokenCount = 5;
610   TestRequires(__LINE__);
611 
612   BaseCode = "template<typename T>\n"
613              "struct Bar;";
614   ConstrainedCode = "template<typename T>\n"
615                     "  requires Foo<T>\n"
616                     "struct Bar;";
617   BaseTokenCount = 9;
618   TestRequires(__LINE__);
619 
620   BaseCode = "template<typename T>\n"
621              "struct Bar {\n"
622              "  T foo();\n"
623              "  T bar();\n"
624              "};";
625   ConstrainedCode = "template<typename T>\n"
626                     "  requires Foo<T>\n"
627                     "struct Bar {\n"
628                     "  T foo();\n"
629                     "  T bar();\n"
630                     "};";
631   BaseTokenCount = 21;
632   TestRequires(__LINE__);
633 
634   BaseCode = "template<typename T>\n"
635              "Bar(T) -> Bar<T>;";
636   ConstrainedCode = "template<typename T>\n"
637                     "  requires Foo<T>\n"
638                     "Bar(T) -> Bar<T>;";
639   BaseTokenCount = 16;
640   TestRequires(__LINE__);
641 
642   BaseCode = "template<typename T>\n"
643              "T foo();";
644   ConstrainedCode = "template<typename T>\n"
645                     "  requires Foo<T>\n"
646                     "T foo();";
647   BaseTokenCount = 11;
648   TestRequires(__LINE__);
649 
650   BaseCode = "template<typename T>\n"
651              "T foo() {\n"
652              "  auto bar = baz();\n"
653              "  return bar + T{};\n"
654              "}";
655   ConstrainedCode = "template<typename T>\n"
656                     "  requires Foo<T>\n"
657                     "T foo() {\n"
658                     "  auto bar = baz();\n"
659                     "  return bar + T{};\n"
660                     "}";
661   BaseTokenCount = 26;
662   TestRequires(__LINE__);
663 
664   BaseCode = "template<typename T>\n"
665              "T foo();";
666   ConstrainedCode = "template<typename T>\n"
667                     "T foo() requires Foo<T>;";
668   BaseTokenCount = 11;
669   PrefixTokenCount = 9;
670   TestRequires(__LINE__);
671 
672   BaseCode = "template<typename T>\n"
673              "T foo() {\n"
674              "  auto bar = baz();\n"
675              "  return bar + T{};\n"
676              "}";
677   ConstrainedCode = "template<typename T>\n"
678                     "T foo() requires Foo<T> {\n"
679                     "  auto bar = baz();\n"
680                     "  return bar + T{};\n"
681                     "}";
682   BaseTokenCount = 26;
683   TestRequires(__LINE__);
684 
685   BaseCode = "template<typename T>\n"
686              "Bar(T) -> Bar<typename T::I>;";
687   ConstrainedCode = "template<typename T>\n"
688                     "  requires requires(T &&t) {\n"
689                     "             typename T::I;\n"
690                     "           }\n"
691                     "Bar(T) -> Bar<typename T::I>;";
692   BaseTokenCount = 19;
693   RequiresTokenCount = 14;
694   PrefixTokenCount = 5;
695   TestRequires(__LINE__);
696 
697   BaseCode = "struct [[nodiscard]] zero_t {\n"
698              "  template<class T>\n"
699              "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
700              "};";
701   ConstrainedCode =
702       "struct [[nodiscard]] zero_t {\n"
703       "  template<class T>\n"
704       "    requires requires { v<T>; }\n"
705       "  [[nodiscard]] constexpr operator T() const { return v<T>; }\n"
706       "};";
707   BaseTokenCount = 35;
708   RequiresTokenCount = 9;
709   PrefixTokenCount = 13;
710   TestRequires(__LINE__);
711 
712   BaseCode = "constexpr Foo(Foo const &other)\n"
713              "    : value{other.value} {\n"
714              "  do_magic();\n"
715              "  do_more_magic();\n"
716              "}";
717   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
718                     "  requires std::is_copy_constructible<T>\n"
719                     "    : value{other.value} {\n"
720                     "  do_magic();\n"
721                     "  do_more_magic();\n"
722                     "}";
723   BaseTokenCount = 26;
724   RequiresTokenCount = 7;
725   PrefixTokenCount = 8;
726   TestRequires(__LINE__);
727 
728   BaseCode = "constexpr Foo(Foo const &other)\n"
729              "    : value{other.value} {\n"
730              "  do_magic();\n"
731              "  do_more_magic();\n"
732              "}";
733   ConstrainedCode = "constexpr Foo(Foo const &other)\n"
734                     "  requires (std::is_copy_constructible<T>)\n"
735                     "    : value{other.value} {\n"
736                     "  do_magic();\n"
737                     "  do_more_magic();\n"
738                     "}";
739   RequiresTokenCount = 9;
740   TestRequires(__LINE__);
741 }
742 
743 TEST_F(TokenAnnotatorTest, UnderstandsAsm) {
744   auto Tokens = annotate("__asm{\n"
745                          "a:\n"
746                          "};");
747   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
748   EXPECT_TOKEN(Tokens[0], tok::kw_asm, TT_Unknown);
749   EXPECT_TOKEN(Tokens[1], tok::l_brace, TT_InlineASMBrace);
750   EXPECT_TOKEN(Tokens[4], tok::r_brace, TT_InlineASMBrace);
751 }
752 
753 TEST_F(TokenAnnotatorTest, UnderstandsObjCBlock) {
754   auto Tokens = annotate("int (^)() = ^ ()\n"
755                          "  external_source_symbol() { //\n"
756                          "  return 1;\n"
757                          "};");
758   ASSERT_EQ(Tokens.size(), 21u) << Tokens;
759   EXPECT_TOKEN(Tokens[1], tok::l_paren, TT_ObjCBlockLParen);
760   EXPECT_TOKEN(Tokens[13], tok::l_brace, TT_ObjCBlockLBrace);
761 
762   Tokens = annotate("int *p = ^int*(){ //\n"
763                     "  return nullptr;\n"
764                     "}();");
765   ASSERT_EQ(Tokens.size(), 19u) << Tokens;
766   EXPECT_TOKEN(Tokens[9], tok::l_brace, TT_ObjCBlockLBrace);
767 }
768 
769 TEST_F(TokenAnnotatorTest, UnderstandsLambdas) {
770   auto Tokens = annotate("[]() constexpr {}");
771   ASSERT_EQ(Tokens.size(), 8u) << Tokens;
772   EXPECT_TOKEN(Tokens[0], tok::l_square, TT_LambdaLSquare);
773   EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_LambdaLBrace);
774 
775   Tokens = annotate("[]() -> auto {}");
776   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
777   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
778   EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_LambdaLBrace);
779 
780   Tokens = annotate("[]() -> auto & {}");
781   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
782   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
783   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
784 
785   Tokens = annotate("[]() -> auto * {}");
786   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
787   EXPECT_TOKEN(Tokens[4], tok::arrow, TT_LambdaArrow);
788   EXPECT_TOKEN(Tokens[7], tok::l_brace, TT_LambdaLBrace);
789 }
790 
791 TEST_F(TokenAnnotatorTest, UnderstandsVerilogOperators) {
792   auto Annotate = [this](llvm::StringRef Code) {
793     return annotate(Code, getLLVMStyle(FormatStyle::LK_Verilog));
794   };
795   // Test that unary operators get labeled as such and that operators like '++'
796   // don't get split.
797   tok::TokenKind Unary[] = {tok::plus,  tok::minus,    tok::exclaim,
798                             tok::tilde, tok::amp,      tok::pipe,
799                             tok::caret, tok::plusplus, tok::minusminus};
800   for (auto Kind : Unary) {
801     auto Tokens =
802         Annotate(std::string("x = ") + tok::getPunctuatorSpelling(Kind) + "x;");
803     ASSERT_EQ(Tokens.size(), 6u) << Tokens;
804     EXPECT_TOKEN(Tokens[2], Kind, TT_UnaryOperator);
805   }
806   // Operators formed by joining two operators like '^~'. For some of these
807   // joined operators, we don't have a separate type, so we only test for their
808   // precedence.
809   std::pair<prec::Level, std::string> JoinedBinary[] = {
810       {prec::Comma, "<->"},       {prec::Assignment, "+="},
811       {prec::Assignment, "-="},   {prec::Assignment, "*="},
812       {prec::Assignment, "/="},   {prec::Assignment, "%="},
813       {prec::Assignment, "&="},   {prec::Assignment, "^="},
814       {prec::Assignment, "<<="},  {prec::Assignment, ">>="},
815       {prec::Assignment, "<<<="}, {prec::Assignment, ">>>="},
816       {prec::LogicalOr, "||"},    {prec::LogicalAnd, "&&"},
817       {prec::Equality, "=="},     {prec::Equality, "!="},
818       {prec::Equality, "==="},    {prec::Equality, "!=="},
819       {prec::Equality, "==?"},    {prec::Equality, "!=?"},
820       {prec::ExclusiveOr, "~^"},  {prec::ExclusiveOr, "^~"},
821   };
822   for (auto Operator : JoinedBinary) {
823     auto Tokens = Annotate(std::string("x = x ") + Operator.second + " x;");
824     ASSERT_EQ(Tokens.size(), 7u) << Tokens;
825     EXPECT_TOKEN_TYPE(Tokens[3], TT_BinaryOperator);
826     EXPECT_TOKEN_PRECEDENCE(Tokens[3], Operator.first);
827   }
828   // '~^' and '^~' can be unary as well as binary operators.
829   auto Tokens = Annotate("x = ~^x;");
830   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
831   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
832   Tokens = Annotate("x = ^~x;");
833   ASSERT_EQ(Tokens.size(), 6u) << Tokens;
834   EXPECT_TOKEN_TYPE(Tokens[2], TT_UnaryOperator);
835   // The unary operators '~&' and '~|' can only be unary operators. The current
836   // implementation treats each of them as separate unary '~' and '&' or '|'
837   // operators, which is enough for formatting purposes. In FormatTestVerilog,
838   // there is a test that there is no space in between. And even if a new line
839   // is inserted between the '~' and '|', the semantic meaning is the same as
840   // the joined operator, so the CanBreakBefore property doesn't need to be
841   // false for the second operator.
842   Tokens = Annotate("x = ~&x;");
843   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
844   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
845   EXPECT_TOKEN(Tokens[3], tok::amp, TT_UnaryOperator);
846   Tokens = Annotate("x = ~|x;");
847   ASSERT_EQ(Tokens.size(), 7u) << Tokens;
848   EXPECT_TOKEN(Tokens[2], tok::tilde, TT_UnaryOperator);
849   EXPECT_TOKEN(Tokens[3], tok::pipe, TT_UnaryOperator);
850   // Test for block label colons.
851   Tokens = Annotate("begin : x\n"
852                     "end : x");
853   ASSERT_EQ(Tokens.size(), 7u);
854   EXPECT_TOKEN(Tokens[1], tok::colon, TT_VerilogBlockLabelColon);
855   EXPECT_TOKEN(Tokens[4], tok::colon, TT_VerilogBlockLabelColon);
856   // Test that the dimension colon is annotated correctly.
857   Tokens = Annotate("var [1 : 0] x;");
858   ASSERT_EQ(Tokens.size(), 9u) << Tokens;
859   EXPECT_TOKEN(Tokens[3], tok::colon, TT_BitFieldColon);
860   Tokens = Annotate("extern function [1 : 0] x;");
861   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
862   EXPECT_TOKEN(Tokens[4], tok::colon, TT_BitFieldColon);
863   // Test case labels and ternary operators.
864   Tokens = Annotate("case (x)\n"
865                     "  x:\n"
866                     "    x;\n"
867                     "endcase\n");
868   ASSERT_EQ(Tokens.size(), 10u) << Tokens;
869   EXPECT_TOKEN(Tokens[5], tok::colon, TT_GotoLabelColon);
870   Tokens = Annotate("case (x)\n"
871                     "  x ? x : x:\n"
872                     "    x;\n"
873                     "endcase\n");
874   ASSERT_EQ(Tokens.size(), 14u) << Tokens;
875   EXPECT_TOKEN(Tokens[5], tok::question, TT_ConditionalExpr);
876   EXPECT_TOKEN(Tokens[7], tok::colon, TT_ConditionalExpr);
877   EXPECT_TOKEN(Tokens[9], tok::colon, TT_GotoLabelColon);
878 }
879 
880 } // namespace
881 } // namespace format
882 } // namespace clang
883