1 //===--- TokenAnnotator.cpp - Format C++ code -----------------------------===//
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 /// \file
10 /// This file implements a token annotator, i.e. creates
11 /// \c AnnotatedTokens out of \c FormatTokens with required extra information.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #include "TokenAnnotator.h"
16 #include "FormatToken.h"
17 #include "clang/Basic/SourceManager.h"
18 #include "clang/Basic/TokenKinds.h"
19 #include "llvm/ADT/SmallPtrSet.h"
20 #include "llvm/Support/Debug.h"
21 
22 #define DEBUG_TYPE "format-token-annotator"
23 
24 namespace clang {
25 namespace format {
26 
27 namespace {
28 
29 /// Returns \c true if the line starts with a token that can start a statement
30 /// with an initializer.
31 static bool startsWithInitStatement(const AnnotatedLine &Line) {
32   return Line.startsWith(tok::kw_for) || Line.startsWith(tok::kw_if) ||
33          Line.startsWith(tok::kw_switch);
34 }
35 
36 /// Returns \c true if the token can be used as an identifier in
37 /// an Objective-C \c \@selector, \c false otherwise.
38 ///
39 /// Because getFormattingLangOpts() always lexes source code as
40 /// Objective-C++, C++ keywords like \c new and \c delete are
41 /// lexed as tok::kw_*, not tok::identifier, even for Objective-C.
42 ///
43 /// For Objective-C and Objective-C++, both identifiers and keywords
44 /// are valid inside @selector(...) (or a macro which
45 /// invokes @selector(...)). So, we allow treat any identifier or
46 /// keyword as a potential Objective-C selector component.
47 static bool canBeObjCSelectorComponent(const FormatToken &Tok) {
48   return Tok.Tok.getIdentifierInfo() != nullptr;
49 }
50 
51 /// With `Left` being '(', check if we're at either `[...](` or
52 /// `[...]<...>(`, where the [ opens a lambda capture list.
53 static bool isLambdaParameterList(const FormatToken *Left) {
54   // Skip <...> if present.
55   if (Left->Previous && Left->Previous->is(tok::greater) &&
56       Left->Previous->MatchingParen &&
57       Left->Previous->MatchingParen->is(TT_TemplateOpener))
58     Left = Left->Previous->MatchingParen;
59 
60   // Check for `[...]`.
61   return Left->Previous && Left->Previous->is(tok::r_square) &&
62          Left->Previous->MatchingParen &&
63          Left->Previous->MatchingParen->is(TT_LambdaLSquare);
64 }
65 
66 /// Returns \c true if the token is followed by a boolean condition, \c false
67 /// otherwise.
68 static bool isKeywordWithCondition(const FormatToken &Tok) {
69   return Tok.isOneOf(tok::kw_if, tok::kw_for, tok::kw_while, tok::kw_switch,
70                      tok::kw_constexpr, tok::kw_catch);
71 }
72 
73 /// A parser that gathers additional information about tokens.
74 ///
75 /// The \c TokenAnnotator tries to match parenthesis and square brakets and
76 /// store a parenthesis levels. It also tries to resolve matching "<" and ">"
77 /// into template parameter lists.
78 class AnnotatingParser {
79 public:
80   AnnotatingParser(const FormatStyle &Style, AnnotatedLine &Line,
81                    const AdditionalKeywords &Keywords)
82       : Style(Style), Line(Line), CurrentToken(Line.First), AutoFound(false),
83         Keywords(Keywords) {
84     Contexts.push_back(Context(tok::unknown, 1, /*IsExpression=*/false));
85     resetTokenMetadata();
86   }
87 
88 private:
89   bool parseAngle() {
90     if (!CurrentToken || !CurrentToken->Previous)
91       return false;
92     if (NonTemplateLess.count(CurrentToken->Previous))
93       return false;
94 
95     const FormatToken &Previous = *CurrentToken->Previous; // The '<'.
96     if (Previous.Previous) {
97       if (Previous.Previous->Tok.isLiteral())
98         return false;
99       if (Previous.Previous->is(tok::r_paren) && Contexts.size() > 1 &&
100           (!Previous.Previous->MatchingParen ||
101            !Previous.Previous->MatchingParen->is(TT_OverloadedOperatorLParen)))
102         return false;
103     }
104 
105     FormatToken *Left = CurrentToken->Previous;
106     Left->ParentBracket = Contexts.back().ContextKind;
107     ScopedContextCreator ContextCreator(*this, tok::less, 12);
108 
109     // If this angle is in the context of an expression, we need to be more
110     // hesitant to detect it as opening template parameters.
111     bool InExprContext = Contexts.back().IsExpression;
112 
113     Contexts.back().IsExpression = false;
114     // If there's a template keyword before the opening angle bracket, this is a
115     // template parameter, not an argument.
116     if (Left->Previous && Left->Previous->isNot(tok::kw_template))
117       Contexts.back().ContextType = Context::TemplateArgument;
118 
119     if (Style.Language == FormatStyle::LK_Java &&
120         CurrentToken->is(tok::question))
121       next();
122 
123     while (CurrentToken) {
124       if (CurrentToken->is(tok::greater)) {
125         // Try to do a better job at looking for ">>" within the condition of
126         // a statement. Conservatively insert spaces between consecutive ">"
127         // tokens to prevent splitting right bitshift operators and potentially
128         // altering program semantics. This check is overly conservative and
129         // will prevent spaces from being inserted in select nested template
130         // parameter cases, but should not alter program semantics.
131         if (CurrentToken->Next && CurrentToken->Next->is(tok::greater) &&
132             Left->ParentBracket != tok::less &&
133             (isKeywordWithCondition(*Line.First) ||
134              CurrentToken->getStartOfNonWhitespace() ==
135                  CurrentToken->Next->getStartOfNonWhitespace().getLocWithOffset(
136                      -1)))
137           return false;
138         Left->MatchingParen = CurrentToken;
139         CurrentToken->MatchingParen = Left;
140         // In TT_Proto, we must distignuish between:
141         //   map<key, value>
142         //   msg < item: data >
143         //   msg: < item: data >
144         // In TT_TextProto, map<key, value> does not occur.
145         if (Style.Language == FormatStyle::LK_TextProto ||
146             (Style.Language == FormatStyle::LK_Proto && Left->Previous &&
147              Left->Previous->isOneOf(TT_SelectorName, TT_DictLiteral)))
148           CurrentToken->setType(TT_DictLiteral);
149         else
150           CurrentToken->setType(TT_TemplateCloser);
151         next();
152         return true;
153       }
154       if (CurrentToken->is(tok::question) &&
155           Style.Language == FormatStyle::LK_Java) {
156         next();
157         continue;
158       }
159       if (CurrentToken->isOneOf(tok::r_paren, tok::r_square, tok::r_brace) ||
160           (CurrentToken->isOneOf(tok::colon, tok::question) && InExprContext &&
161            !Style.isCSharp() && Style.Language != FormatStyle::LK_Proto &&
162            Style.Language != FormatStyle::LK_TextProto))
163         return false;
164       // If a && or || is found and interpreted as a binary operator, this set
165       // of angles is likely part of something like "a < b && c > d". If the
166       // angles are inside an expression, the ||/&& might also be a binary
167       // operator that was misinterpreted because we are parsing template
168       // parameters.
169       // FIXME: This is getting out of hand, write a decent parser.
170       if (CurrentToken->Previous->isOneOf(tok::pipepipe, tok::ampamp) &&
171           CurrentToken->Previous->is(TT_BinaryOperator) &&
172           Contexts[Contexts.size() - 2].IsExpression &&
173           !Line.startsWith(tok::kw_template))
174         return false;
175       updateParameterCount(Left, CurrentToken);
176       if (Style.Language == FormatStyle::LK_Proto) {
177         if (FormatToken *Previous = CurrentToken->getPreviousNonComment()) {
178           if (CurrentToken->is(tok::colon) ||
179               (CurrentToken->isOneOf(tok::l_brace, tok::less) &&
180                Previous->isNot(tok::colon)))
181             Previous->setType(TT_SelectorName);
182         }
183       }
184       if (!consumeToken())
185         return false;
186     }
187     return false;
188   }
189 
190   bool parseUntouchableParens() {
191     while (CurrentToken) {
192       CurrentToken->Finalized = true;
193       switch (CurrentToken->Tok.getKind()) {
194       case tok::l_paren:
195         next();
196         if (!parseUntouchableParens())
197           return false;
198         continue;
199       case tok::r_paren:
200         next();
201         return true;
202       default:
203         // no-op
204         break;
205       }
206       next();
207     }
208     return false;
209   }
210 
211   bool parseParens(bool LookForDecls = false) {
212     if (!CurrentToken)
213       return false;
214     assert(CurrentToken->Previous && "Unknown previous token");
215     FormatToken &OpeningParen = *CurrentToken->Previous;
216     assert(OpeningParen.is(tok::l_paren));
217     FormatToken *PrevNonComment = OpeningParen.getPreviousNonComment();
218     OpeningParen.ParentBracket = Contexts.back().ContextKind;
219     ScopedContextCreator ContextCreator(*this, tok::l_paren, 1);
220 
221     // FIXME: This is a bit of a hack. Do better.
222     Contexts.back().ColonIsForRangeExpr =
223         Contexts.size() == 2 && Contexts[0].ColonIsForRangeExpr;
224 
225     if (OpeningParen.Previous &&
226         OpeningParen.Previous->is(TT_UntouchableMacroFunc)) {
227       OpeningParen.Finalized = true;
228       return parseUntouchableParens();
229     }
230 
231     bool StartsObjCMethodExpr = false;
232     if (FormatToken *MaybeSel = OpeningParen.Previous) {
233       // @selector( starts a selector.
234       if (MaybeSel->isObjCAtKeyword(tok::objc_selector) && MaybeSel->Previous &&
235           MaybeSel->Previous->is(tok::at))
236         StartsObjCMethodExpr = true;
237     }
238 
239     if (OpeningParen.is(TT_OverloadedOperatorLParen)) {
240       // Find the previous kw_operator token.
241       FormatToken *Prev = &OpeningParen;
242       while (!Prev->is(tok::kw_operator)) {
243         Prev = Prev->Previous;
244         assert(Prev && "Expect a kw_operator prior to the OperatorLParen!");
245       }
246 
247       // If faced with "a.operator*(argument)" or "a->operator*(argument)",
248       // i.e. the operator is called as a member function,
249       // then the argument must be an expression.
250       bool OperatorCalledAsMemberFunction =
251           Prev->Previous && Prev->Previous->isOneOf(tok::period, tok::arrow);
252       Contexts.back().IsExpression = OperatorCalledAsMemberFunction;
253     } else if (Style.isJavaScript() &&
254                (Line.startsWith(Keywords.kw_type, tok::identifier) ||
255                 Line.startsWith(tok::kw_export, Keywords.kw_type,
256                                 tok::identifier))) {
257       // type X = (...);
258       // export type X = (...);
259       Contexts.back().IsExpression = false;
260     } else if (OpeningParen.Previous &&
261                (OpeningParen.Previous->isOneOf(tok::kw_static_assert,
262                                                tok::kw_while, tok::l_paren,
263                                                tok::comma, TT_BinaryOperator) ||
264                 OpeningParen.Previous->isIf())) {
265       // static_assert, if and while usually contain expressions.
266       Contexts.back().IsExpression = true;
267     } else if (Style.isJavaScript() && OpeningParen.Previous &&
268                (OpeningParen.Previous->is(Keywords.kw_function) ||
269                 (OpeningParen.Previous->endsSequence(tok::identifier,
270                                                      Keywords.kw_function)))) {
271       // function(...) or function f(...)
272       Contexts.back().IsExpression = false;
273     } else if (Style.isJavaScript() && OpeningParen.Previous &&
274                OpeningParen.Previous->is(TT_JsTypeColon)) {
275       // let x: (SomeType);
276       Contexts.back().IsExpression = false;
277     } else if (isLambdaParameterList(&OpeningParen)) {
278       // This is a parameter list of a lambda expression.
279       Contexts.back().IsExpression = false;
280     } else if (Line.InPPDirective &&
281                (!OpeningParen.Previous ||
282                 !OpeningParen.Previous->is(tok::identifier))) {
283       Contexts.back().IsExpression = true;
284     } else if (Contexts[Contexts.size() - 2].CaretFound) {
285       // This is the parameter list of an ObjC block.
286       Contexts.back().IsExpression = false;
287     } else if (OpeningParen.Previous &&
288                OpeningParen.Previous->is(TT_ForEachMacro)) {
289       // The first argument to a foreach macro is a declaration.
290       Contexts.back().ContextType = Context::ForEachMacro;
291       Contexts.back().IsExpression = false;
292     } else if (OpeningParen.Previous && OpeningParen.Previous->MatchingParen &&
293                OpeningParen.Previous->MatchingParen->is(TT_ObjCBlockLParen)) {
294       Contexts.back().IsExpression = false;
295     } else if (!Line.MustBeDeclaration && !Line.InPPDirective) {
296       bool IsForOrCatch =
297           OpeningParen.Previous &&
298           OpeningParen.Previous->isOneOf(tok::kw_for, tok::kw_catch);
299       Contexts.back().IsExpression = !IsForOrCatch;
300     }
301 
302     // Infer the role of the l_paren based on the previous token if we haven't
303     // detected one one yet.
304     if (PrevNonComment && OpeningParen.is(TT_Unknown)) {
305       if (PrevNonComment->is(tok::kw___attribute)) {
306         OpeningParen.setType(TT_AttributeParen);
307       } else if (PrevNonComment->isOneOf(TT_TypenameMacro, tok::kw_decltype,
308                                          tok::kw_typeof, tok::kw__Atomic,
309                                          tok::kw___underlying_type)) {
310         OpeningParen.setType(TT_TypeDeclarationParen);
311         // decltype() and typeof() usually contain expressions.
312         if (PrevNonComment->isOneOf(tok::kw_decltype, tok::kw_typeof))
313           Contexts.back().IsExpression = true;
314       }
315     }
316 
317     if (StartsObjCMethodExpr) {
318       Contexts.back().ColonIsObjCMethodExpr = true;
319       OpeningParen.setType(TT_ObjCMethodExpr);
320     }
321 
322     // MightBeFunctionType and ProbablyFunctionType are used for
323     // function pointer and reference types as well as Objective-C
324     // block types:
325     //
326     // void (*FunctionPointer)(void);
327     // void (&FunctionReference)(void);
328     // void (&&FunctionReference)(void);
329     // void (^ObjCBlock)(void);
330     bool MightBeFunctionType = !Contexts[Contexts.size() - 2].IsExpression;
331     bool ProbablyFunctionType =
332         CurrentToken->isOneOf(tok::star, tok::amp, tok::ampamp, tok::caret);
333     bool HasMultipleLines = false;
334     bool HasMultipleParametersOnALine = false;
335     bool MightBeObjCForRangeLoop =
336         OpeningParen.Previous && OpeningParen.Previous->is(tok::kw_for);
337     FormatToken *PossibleObjCForInToken = nullptr;
338     while (CurrentToken) {
339       // LookForDecls is set when "if (" has been seen. Check for
340       // 'identifier' '*' 'identifier' followed by not '=' -- this
341       // '*' has to be a binary operator but determineStarAmpUsage() will
342       // categorize it as an unary operator, so set the right type here.
343       if (LookForDecls && CurrentToken->Next) {
344         FormatToken *Prev = CurrentToken->getPreviousNonComment();
345         if (Prev) {
346           FormatToken *PrevPrev = Prev->getPreviousNonComment();
347           FormatToken *Next = CurrentToken->Next;
348           if (PrevPrev && PrevPrev->is(tok::identifier) &&
349               Prev->isOneOf(tok::star, tok::amp, tok::ampamp) &&
350               CurrentToken->is(tok::identifier) && Next->isNot(tok::equal)) {
351             Prev->setType(TT_BinaryOperator);
352             LookForDecls = false;
353           }
354         }
355       }
356 
357       if (CurrentToken->Previous->is(TT_PointerOrReference) &&
358           CurrentToken->Previous->Previous->isOneOf(tok::l_paren,
359                                                     tok::coloncolon))
360         ProbablyFunctionType = true;
361       if (CurrentToken->is(tok::comma))
362         MightBeFunctionType = false;
363       if (CurrentToken->Previous->is(TT_BinaryOperator))
364         Contexts.back().IsExpression = true;
365       if (CurrentToken->is(tok::r_paren)) {
366         if (OpeningParen.isNot(TT_CppCastLParen) && MightBeFunctionType &&
367             ProbablyFunctionType && CurrentToken->Next &&
368             (CurrentToken->Next->is(tok::l_paren) ||
369              (CurrentToken->Next->is(tok::l_square) && Line.MustBeDeclaration)))
370           OpeningParen.setType(OpeningParen.Next->is(tok::caret)
371                                    ? TT_ObjCBlockLParen
372                                    : TT_FunctionTypeLParen);
373         OpeningParen.MatchingParen = CurrentToken;
374         CurrentToken->MatchingParen = &OpeningParen;
375 
376         if (CurrentToken->Next && CurrentToken->Next->is(tok::l_brace) &&
377             OpeningParen.Previous && OpeningParen.Previous->is(tok::l_paren)) {
378           // Detect the case where macros are used to generate lambdas or
379           // function bodies, e.g.:
380           //   auto my_lambda = MACRO((Type *type, int i) { .. body .. });
381           for (FormatToken *Tok = &OpeningParen; Tok != CurrentToken;
382                Tok = Tok->Next)
383             if (Tok->is(TT_BinaryOperator) &&
384                 Tok->isOneOf(tok::star, tok::amp, tok::ampamp))
385               Tok->setType(TT_PointerOrReference);
386         }
387 
388         if (StartsObjCMethodExpr) {
389           CurrentToken->setType(TT_ObjCMethodExpr);
390           if (Contexts.back().FirstObjCSelectorName) {
391             Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
392                 Contexts.back().LongestObjCSelectorName;
393           }
394         }
395 
396         if (OpeningParen.is(TT_AttributeParen))
397           CurrentToken->setType(TT_AttributeParen);
398         if (OpeningParen.is(TT_TypeDeclarationParen))
399           CurrentToken->setType(TT_TypeDeclarationParen);
400         if (OpeningParen.Previous &&
401             OpeningParen.Previous->is(TT_JavaAnnotation))
402           CurrentToken->setType(TT_JavaAnnotation);
403         if (OpeningParen.Previous &&
404             OpeningParen.Previous->is(TT_LeadingJavaAnnotation))
405           CurrentToken->setType(TT_LeadingJavaAnnotation);
406         if (OpeningParen.Previous &&
407             OpeningParen.Previous->is(TT_AttributeSquare))
408           CurrentToken->setType(TT_AttributeSquare);
409 
410         if (!HasMultipleLines)
411           OpeningParen.setPackingKind(PPK_Inconclusive);
412         else if (HasMultipleParametersOnALine)
413           OpeningParen.setPackingKind(PPK_BinPacked);
414         else
415           OpeningParen.setPackingKind(PPK_OnePerLine);
416 
417         next();
418         return true;
419       }
420       if (CurrentToken->isOneOf(tok::r_square, tok::r_brace))
421         return false;
422 
423       if (CurrentToken->is(tok::l_brace) && OpeningParen.is(TT_ObjCBlockLParen))
424         OpeningParen.setType(TT_Unknown);
425       if (CurrentToken->is(tok::comma) && CurrentToken->Next &&
426           !CurrentToken->Next->HasUnescapedNewline &&
427           !CurrentToken->Next->isTrailingComment())
428         HasMultipleParametersOnALine = true;
429       bool ProbablyFunctionTypeLParen =
430           (CurrentToken->is(tok::l_paren) && CurrentToken->Next &&
431            CurrentToken->Next->isOneOf(tok::star, tok::amp, tok::caret));
432       if ((CurrentToken->Previous->isOneOf(tok::kw_const, tok::kw_auto) ||
433            CurrentToken->Previous->isSimpleTypeSpecifier()) &&
434           !(CurrentToken->is(tok::l_brace) ||
435             (CurrentToken->is(tok::l_paren) && !ProbablyFunctionTypeLParen)))
436         Contexts.back().IsExpression = false;
437       if (CurrentToken->isOneOf(tok::semi, tok::colon)) {
438         MightBeObjCForRangeLoop = false;
439         if (PossibleObjCForInToken) {
440           PossibleObjCForInToken->setType(TT_Unknown);
441           PossibleObjCForInToken = nullptr;
442         }
443       }
444       if (MightBeObjCForRangeLoop && CurrentToken->is(Keywords.kw_in)) {
445         PossibleObjCForInToken = CurrentToken;
446         PossibleObjCForInToken->setType(TT_ObjCForIn);
447       }
448       // When we discover a 'new', we set CanBeExpression to 'false' in order to
449       // parse the type correctly. Reset that after a comma.
450       if (CurrentToken->is(tok::comma))
451         Contexts.back().CanBeExpression = true;
452 
453       FormatToken *Tok = CurrentToken;
454       if (!consumeToken())
455         return false;
456       updateParameterCount(&OpeningParen, Tok);
457       if (CurrentToken && CurrentToken->HasUnescapedNewline)
458         HasMultipleLines = true;
459     }
460     return false;
461   }
462 
463   bool isCSharpAttributeSpecifier(const FormatToken &Tok) {
464     if (!Style.isCSharp())
465       return false;
466 
467     // `identifier[i]` is not an attribute.
468     if (Tok.Previous && Tok.Previous->is(tok::identifier))
469       return false;
470 
471     // Chains of [] in `identifier[i][j][k]` are not attributes.
472     if (Tok.Previous && Tok.Previous->is(tok::r_square)) {
473       auto *MatchingParen = Tok.Previous->MatchingParen;
474       if (!MatchingParen || MatchingParen->is(TT_ArraySubscriptLSquare))
475         return false;
476     }
477 
478     const FormatToken *AttrTok = Tok.Next;
479     if (!AttrTok)
480       return false;
481 
482     // Just an empty declaration e.g. string [].
483     if (AttrTok->is(tok::r_square))
484       return false;
485 
486     // Move along the tokens inbetween the '[' and ']' e.g. [STAThread].
487     while (AttrTok && AttrTok->isNot(tok::r_square))
488       AttrTok = AttrTok->Next;
489 
490     if (!AttrTok)
491       return false;
492 
493     // Allow an attribute to be the only content of a file.
494     AttrTok = AttrTok->Next;
495     if (!AttrTok)
496       return true;
497 
498     // Limit this to being an access modifier that follows.
499     if (AttrTok->isOneOf(tok::kw_public, tok::kw_private, tok::kw_protected,
500                          tok::comment, tok::kw_class, tok::kw_static,
501                          tok::l_square, Keywords.kw_internal))
502       return true;
503 
504     // incase its a [XXX] retval func(....
505     if (AttrTok->Next &&
506         AttrTok->Next->startsSequence(tok::identifier, tok::l_paren))
507       return true;
508 
509     return false;
510   }
511 
512   bool isCpp11AttributeSpecifier(const FormatToken &Tok) {
513     if (!Style.isCpp() || !Tok.startsSequence(tok::l_square, tok::l_square))
514       return false;
515     // The first square bracket is part of an ObjC array literal
516     if (Tok.Previous && Tok.Previous->is(tok::at))
517       return false;
518     const FormatToken *AttrTok = Tok.Next->Next;
519     if (!AttrTok)
520       return false;
521     // C++17 '[[using ns: foo, bar(baz, blech)]]'
522     // We assume nobody will name an ObjC variable 'using'.
523     if (AttrTok->startsSequence(tok::kw_using, tok::identifier, tok::colon))
524       return true;
525     if (AttrTok->isNot(tok::identifier))
526       return false;
527     while (AttrTok && !AttrTok->startsSequence(tok::r_square, tok::r_square)) {
528       // ObjC message send. We assume nobody will use : in a C++11 attribute
529       // specifier parameter, although this is technically valid:
530       // [[foo(:)]].
531       if (AttrTok->is(tok::colon) ||
532           AttrTok->startsSequence(tok::identifier, tok::identifier) ||
533           AttrTok->startsSequence(tok::r_paren, tok::identifier))
534         return false;
535       if (AttrTok->is(tok::ellipsis))
536         return true;
537       AttrTok = AttrTok->Next;
538     }
539     return AttrTok && AttrTok->startsSequence(tok::r_square, tok::r_square);
540   }
541 
542   bool parseSquare() {
543     if (!CurrentToken)
544       return false;
545 
546     // A '[' could be an index subscript (after an identifier or after
547     // ')' or ']'), it could be the start of an Objective-C method
548     // expression, it could the start of an Objective-C array literal,
549     // or it could be a C++ attribute specifier [[foo::bar]].
550     FormatToken *Left = CurrentToken->Previous;
551     Left->ParentBracket = Contexts.back().ContextKind;
552     FormatToken *Parent = Left->getPreviousNonComment();
553 
554     // Cases where '>' is followed by '['.
555     // In C++, this can happen either in array of templates (foo<int>[10])
556     // or when array is a nested template type (unique_ptr<type1<type2>[]>).
557     bool CppArrayTemplates =
558         Style.isCpp() && Parent && Parent->is(TT_TemplateCloser) &&
559         (Contexts.back().CanBeExpression || Contexts.back().IsExpression ||
560          Contexts.back().ContextType == Context::TemplateArgument);
561 
562     bool IsCpp11AttributeSpecifier = isCpp11AttributeSpecifier(*Left) ||
563                                      Contexts.back().InCpp11AttributeSpecifier;
564 
565     // Treat C# Attributes [STAThread] much like C++ attributes [[...]].
566     bool IsCSharpAttributeSpecifier =
567         isCSharpAttributeSpecifier(*Left) ||
568         Contexts.back().InCSharpAttributeSpecifier;
569 
570     bool InsideInlineASM = Line.startsWith(tok::kw_asm);
571     bool IsCppStructuredBinding = Left->isCppStructuredBinding(Style);
572     bool StartsObjCMethodExpr =
573         !IsCppStructuredBinding && !InsideInlineASM && !CppArrayTemplates &&
574         Style.isCpp() && !IsCpp11AttributeSpecifier &&
575         !IsCSharpAttributeSpecifier && Contexts.back().CanBeExpression &&
576         Left->isNot(TT_LambdaLSquare) &&
577         !CurrentToken->isOneOf(tok::l_brace, tok::r_square) &&
578         (!Parent ||
579          Parent->isOneOf(tok::colon, tok::l_square, tok::l_paren,
580                          tok::kw_return, tok::kw_throw) ||
581          Parent->isUnaryOperator() ||
582          // FIXME(bug 36976): ObjC return types shouldn't use TT_CastRParen.
583          Parent->isOneOf(TT_ObjCForIn, TT_CastRParen) ||
584          (getBinOpPrecedence(Parent->Tok.getKind(), true, true) >
585           prec::Unknown));
586     bool ColonFound = false;
587 
588     unsigned BindingIncrease = 1;
589     if (IsCppStructuredBinding) {
590       Left->setType(TT_StructuredBindingLSquare);
591     } else if (Left->is(TT_Unknown)) {
592       if (StartsObjCMethodExpr) {
593         Left->setType(TT_ObjCMethodExpr);
594       } else if (InsideInlineASM) {
595         Left->setType(TT_InlineASMSymbolicNameLSquare);
596       } else if (IsCpp11AttributeSpecifier) {
597         Left->setType(TT_AttributeSquare);
598       } else if (Style.isJavaScript() && Parent &&
599                  Contexts.back().ContextKind == tok::l_brace &&
600                  Parent->isOneOf(tok::l_brace, tok::comma)) {
601         Left->setType(TT_JsComputedPropertyName);
602       } else if (Style.isCpp() && Contexts.back().ContextKind == tok::l_brace &&
603                  Parent && Parent->isOneOf(tok::l_brace, tok::comma)) {
604         Left->setType(TT_DesignatedInitializerLSquare);
605       } else if (IsCSharpAttributeSpecifier) {
606         Left->setType(TT_AttributeSquare);
607       } else if (CurrentToken->is(tok::r_square) && Parent &&
608                  Parent->is(TT_TemplateCloser)) {
609         Left->setType(TT_ArraySubscriptLSquare);
610       } else if (Style.Language == FormatStyle::LK_Proto ||
611                  Style.Language == FormatStyle::LK_TextProto) {
612         // Square braces in LK_Proto can either be message field attributes:
613         //
614         // optional Aaa aaa = 1 [
615         //   (aaa) = aaa
616         // ];
617         //
618         // extensions 123 [
619         //   (aaa) = aaa
620         // ];
621         //
622         // or text proto extensions (in options):
623         //
624         // option (Aaa.options) = {
625         //   [type.type/type] {
626         //     key: value
627         //   }
628         // }
629         //
630         // or repeated fields (in options):
631         //
632         // option (Aaa.options) = {
633         //   keys: [ 1, 2, 3 ]
634         // }
635         //
636         // In the first and the third case we want to spread the contents inside
637         // the square braces; in the second we want to keep them inline.
638         Left->setType(TT_ArrayInitializerLSquare);
639         if (!Left->endsSequence(tok::l_square, tok::numeric_constant,
640                                 tok::equal) &&
641             !Left->endsSequence(tok::l_square, tok::numeric_constant,
642                                 tok::identifier) &&
643             !Left->endsSequence(tok::l_square, tok::colon, TT_SelectorName)) {
644           Left->setType(TT_ProtoExtensionLSquare);
645           BindingIncrease = 10;
646         }
647       } else if (!CppArrayTemplates && Parent &&
648                  Parent->isOneOf(TT_BinaryOperator, TT_TemplateCloser, tok::at,
649                                  tok::comma, tok::l_paren, tok::l_square,
650                                  tok::question, tok::colon, tok::kw_return,
651                                  // Should only be relevant to JavaScript:
652                                  tok::kw_default)) {
653         Left->setType(TT_ArrayInitializerLSquare);
654       } else {
655         BindingIncrease = 10;
656         Left->setType(TT_ArraySubscriptLSquare);
657       }
658     }
659 
660     ScopedContextCreator ContextCreator(*this, tok::l_square, BindingIncrease);
661     Contexts.back().IsExpression = true;
662     if (Style.isJavaScript() && Parent && Parent->is(TT_JsTypeColon))
663       Contexts.back().IsExpression = false;
664 
665     Contexts.back().ColonIsObjCMethodExpr = StartsObjCMethodExpr;
666     Contexts.back().InCpp11AttributeSpecifier = IsCpp11AttributeSpecifier;
667     Contexts.back().InCSharpAttributeSpecifier = IsCSharpAttributeSpecifier;
668 
669     while (CurrentToken) {
670       if (CurrentToken->is(tok::r_square)) {
671         if (IsCpp11AttributeSpecifier)
672           CurrentToken->setType(TT_AttributeSquare);
673         if (IsCSharpAttributeSpecifier)
674           CurrentToken->setType(TT_AttributeSquare);
675         else if (((CurrentToken->Next &&
676                    CurrentToken->Next->is(tok::l_paren)) ||
677                   (CurrentToken->Previous &&
678                    CurrentToken->Previous->Previous == Left)) &&
679                  Left->is(TT_ObjCMethodExpr)) {
680           // An ObjC method call is rarely followed by an open parenthesis. It
681           // also can't be composed of just one token, unless it's a macro that
682           // will be expanded to more tokens.
683           // FIXME: Do we incorrectly label ":" with this?
684           StartsObjCMethodExpr = false;
685           Left->setType(TT_Unknown);
686         }
687         if (StartsObjCMethodExpr && CurrentToken->Previous != Left) {
688           CurrentToken->setType(TT_ObjCMethodExpr);
689           // If we haven't seen a colon yet, make sure the last identifier
690           // before the r_square is tagged as a selector name component.
691           if (!ColonFound && CurrentToken->Previous &&
692               CurrentToken->Previous->is(TT_Unknown) &&
693               canBeObjCSelectorComponent(*CurrentToken->Previous))
694             CurrentToken->Previous->setType(TT_SelectorName);
695           // determineStarAmpUsage() thinks that '*' '[' is allocating an
696           // array of pointers, but if '[' starts a selector then '*' is a
697           // binary operator.
698           if (Parent && Parent->is(TT_PointerOrReference))
699             Parent->overwriteFixedType(TT_BinaryOperator);
700         }
701         // An arrow after an ObjC method expression is not a lambda arrow.
702         if (CurrentToken->getType() == TT_ObjCMethodExpr &&
703             CurrentToken->Next && CurrentToken->Next->is(TT_LambdaArrow))
704           CurrentToken->Next->overwriteFixedType(TT_Unknown);
705         Left->MatchingParen = CurrentToken;
706         CurrentToken->MatchingParen = Left;
707         // FirstObjCSelectorName is set when a colon is found. This does
708         // not work, however, when the method has no parameters.
709         // Here, we set FirstObjCSelectorName when the end of the method call is
710         // reached, in case it was not set already.
711         if (!Contexts.back().FirstObjCSelectorName) {
712           FormatToken *Previous = CurrentToken->getPreviousNonComment();
713           if (Previous && Previous->is(TT_SelectorName)) {
714             Previous->ObjCSelectorNameParts = 1;
715             Contexts.back().FirstObjCSelectorName = Previous;
716           }
717         } else {
718           Left->ParameterCount =
719               Contexts.back().FirstObjCSelectorName->ObjCSelectorNameParts;
720         }
721         if (Contexts.back().FirstObjCSelectorName) {
722           Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
723               Contexts.back().LongestObjCSelectorName;
724           if (Left->BlockParameterCount > 1)
725             Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName = 0;
726         }
727         next();
728         return true;
729       }
730       if (CurrentToken->isOneOf(tok::r_paren, tok::r_brace))
731         return false;
732       if (CurrentToken->is(tok::colon)) {
733         if (IsCpp11AttributeSpecifier &&
734             CurrentToken->endsSequence(tok::colon, tok::identifier,
735                                        tok::kw_using)) {
736           // Remember that this is a [[using ns: foo]] C++ attribute, so we
737           // don't add a space before the colon (unlike other colons).
738           CurrentToken->setType(TT_AttributeColon);
739         } else if (Left->isOneOf(TT_ArraySubscriptLSquare,
740                                  TT_DesignatedInitializerLSquare)) {
741           Left->setType(TT_ObjCMethodExpr);
742           StartsObjCMethodExpr = true;
743           Contexts.back().ColonIsObjCMethodExpr = true;
744           if (Parent && Parent->is(tok::r_paren))
745             // FIXME(bug 36976): ObjC return types shouldn't use TT_CastRParen.
746             Parent->setType(TT_CastRParen);
747         }
748         ColonFound = true;
749       }
750       if (CurrentToken->is(tok::comma) && Left->is(TT_ObjCMethodExpr) &&
751           !ColonFound)
752         Left->setType(TT_ArrayInitializerLSquare);
753       FormatToken *Tok = CurrentToken;
754       if (!consumeToken())
755         return false;
756       updateParameterCount(Left, Tok);
757     }
758     return false;
759   }
760 
761   bool couldBeInStructArrayInitializer() const {
762     if (Contexts.size() < 2)
763       return false;
764     // We want to back up no more then 2 context levels i.e.
765     // . { { <-
766     const auto End = std::next(Contexts.rbegin(), 2);
767     auto Last = Contexts.rbegin();
768     unsigned Depth = 0;
769     for (; Last != End; ++Last)
770       if (Last->ContextKind == tok::l_brace)
771         ++Depth;
772     return Depth == 2 && Last->ContextKind != tok::l_brace;
773   }
774 
775   bool parseBrace() {
776     if (!CurrentToken)
777       return true;
778 
779     assert(CurrentToken->Previous);
780     FormatToken &OpeningBrace = *CurrentToken->Previous;
781     assert(OpeningBrace.is(tok::l_brace));
782     OpeningBrace.ParentBracket = Contexts.back().ContextKind;
783 
784     if (Contexts.back().CaretFound)
785       OpeningBrace.overwriteFixedType(TT_ObjCBlockLBrace);
786     Contexts.back().CaretFound = false;
787 
788     ScopedContextCreator ContextCreator(*this, tok::l_brace, 1);
789     Contexts.back().ColonIsDictLiteral = true;
790     if (OpeningBrace.is(BK_BracedInit))
791       Contexts.back().IsExpression = true;
792     if (Style.isJavaScript() && OpeningBrace.Previous &&
793         OpeningBrace.Previous->is(TT_JsTypeColon))
794       Contexts.back().IsExpression = false;
795 
796     unsigned CommaCount = 0;
797     while (CurrentToken) {
798       if (CurrentToken->is(tok::r_brace)) {
799         assert(OpeningBrace.Optional == CurrentToken->Optional);
800         OpeningBrace.MatchingParen = CurrentToken;
801         CurrentToken->MatchingParen = &OpeningBrace;
802         if (Style.AlignArrayOfStructures != FormatStyle::AIAS_None) {
803           if (OpeningBrace.ParentBracket == tok::l_brace &&
804               couldBeInStructArrayInitializer() && CommaCount > 0)
805             Contexts.back().ContextType = Context::StructArrayInitializer;
806         }
807         next();
808         return true;
809       }
810       if (CurrentToken->isOneOf(tok::r_paren, tok::r_square))
811         return false;
812       updateParameterCount(&OpeningBrace, CurrentToken);
813       if (CurrentToken->isOneOf(tok::colon, tok::l_brace, tok::less)) {
814         FormatToken *Previous = CurrentToken->getPreviousNonComment();
815         if (Previous->is(TT_JsTypeOptionalQuestion))
816           Previous = Previous->getPreviousNonComment();
817         if ((CurrentToken->is(tok::colon) &&
818              (!Contexts.back().ColonIsDictLiteral || !Style.isCpp())) ||
819             Style.Language == FormatStyle::LK_Proto ||
820             Style.Language == FormatStyle::LK_TextProto) {
821           OpeningBrace.setType(TT_DictLiteral);
822           if (Previous->Tok.getIdentifierInfo() ||
823               Previous->is(tok::string_literal))
824             Previous->setType(TT_SelectorName);
825         }
826         if (CurrentToken->is(tok::colon) && OpeningBrace.is(TT_Unknown))
827           OpeningBrace.setType(TT_DictLiteral);
828         else if (Style.isJavaScript())
829           OpeningBrace.overwriteFixedType(TT_DictLiteral);
830       }
831       if (CurrentToken->is(tok::comma)) {
832         if (Style.isJavaScript())
833           OpeningBrace.overwriteFixedType(TT_DictLiteral);
834         ++CommaCount;
835       }
836       if (!consumeToken())
837         return false;
838     }
839     return true;
840   }
841 
842   void updateParameterCount(FormatToken *Left, FormatToken *Current) {
843     // For ObjC methods, the number of parameters is calculated differently as
844     // method declarations have a different structure (the parameters are not
845     // inside a bracket scope).
846     if (Current->is(tok::l_brace) && Current->is(BK_Block))
847       ++Left->BlockParameterCount;
848     if (Current->is(tok::comma)) {
849       ++Left->ParameterCount;
850       if (!Left->Role)
851         Left->Role.reset(new CommaSeparatedList(Style));
852       Left->Role->CommaFound(Current);
853     } else if (Left->ParameterCount == 0 && Current->isNot(tok::comment)) {
854       Left->ParameterCount = 1;
855     }
856   }
857 
858   bool parseConditional() {
859     while (CurrentToken) {
860       if (CurrentToken->is(tok::colon)) {
861         CurrentToken->setType(TT_ConditionalExpr);
862         next();
863         return true;
864       }
865       if (!consumeToken())
866         return false;
867     }
868     return false;
869   }
870 
871   bool parseTemplateDeclaration() {
872     if (CurrentToken && CurrentToken->is(tok::less)) {
873       CurrentToken->setType(TT_TemplateOpener);
874       next();
875       if (!parseAngle())
876         return false;
877       if (CurrentToken)
878         CurrentToken->Previous->ClosesTemplateDeclaration = true;
879       return true;
880     }
881     return false;
882   }
883 
884   bool consumeToken() {
885     FormatToken *Tok = CurrentToken;
886     next();
887     switch (Tok->Tok.getKind()) {
888     case tok::plus:
889     case tok::minus:
890       if (!Tok->Previous && Line.MustBeDeclaration)
891         Tok->setType(TT_ObjCMethodSpecifier);
892       break;
893     case tok::colon:
894       if (!Tok->Previous)
895         return false;
896       // Colons from ?: are handled in parseConditional().
897       if (Style.isJavaScript()) {
898         if (Contexts.back().ColonIsForRangeExpr || // colon in for loop
899             (Contexts.size() == 1 &&               // switch/case labels
900              !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) ||
901             Contexts.back().ContextKind == tok::l_paren ||  // function params
902             Contexts.back().ContextKind == tok::l_square || // array type
903             (!Contexts.back().IsExpression &&
904              Contexts.back().ContextKind == tok::l_brace) || // object type
905             (Contexts.size() == 1 &&
906              Line.MustBeDeclaration)) { // method/property declaration
907           Contexts.back().IsExpression = false;
908           Tok->setType(TT_JsTypeColon);
909           break;
910         }
911       } else if (Style.isCSharp()) {
912         if (Contexts.back().InCSharpAttributeSpecifier) {
913           Tok->setType(TT_AttributeColon);
914           break;
915         }
916         if (Contexts.back().ContextKind == tok::l_paren) {
917           Tok->setType(TT_CSharpNamedArgumentColon);
918           break;
919         }
920       }
921       if (Line.First->isOneOf(Keywords.kw_module, Keywords.kw_import) ||
922           Line.First->startsSequence(tok::kw_export, Keywords.kw_module) ||
923           Line.First->startsSequence(tok::kw_export, Keywords.kw_import)) {
924         Tok->setType(TT_ModulePartitionColon);
925       } else if (Contexts.back().ColonIsDictLiteral ||
926                  Style.Language == FormatStyle::LK_Proto ||
927                  Style.Language == FormatStyle::LK_TextProto) {
928         Tok->setType(TT_DictLiteral);
929         if (Style.Language == FormatStyle::LK_TextProto) {
930           if (FormatToken *Previous = Tok->getPreviousNonComment())
931             Previous->setType(TT_SelectorName);
932         }
933       } else if (Contexts.back().ColonIsObjCMethodExpr ||
934                  Line.startsWith(TT_ObjCMethodSpecifier)) {
935         Tok->setType(TT_ObjCMethodExpr);
936         const FormatToken *BeforePrevious = Tok->Previous->Previous;
937         // Ensure we tag all identifiers in method declarations as
938         // TT_SelectorName.
939         bool UnknownIdentifierInMethodDeclaration =
940             Line.startsWith(TT_ObjCMethodSpecifier) &&
941             Tok->Previous->is(tok::identifier) && Tok->Previous->is(TT_Unknown);
942         if (!BeforePrevious ||
943             // FIXME(bug 36976): ObjC return types shouldn't use TT_CastRParen.
944             !(BeforePrevious->is(TT_CastRParen) ||
945               (BeforePrevious->is(TT_ObjCMethodExpr) &&
946                BeforePrevious->is(tok::colon))) ||
947             BeforePrevious->is(tok::r_square) ||
948             Contexts.back().LongestObjCSelectorName == 0 ||
949             UnknownIdentifierInMethodDeclaration) {
950           Tok->Previous->setType(TT_SelectorName);
951           if (!Contexts.back().FirstObjCSelectorName)
952             Contexts.back().FirstObjCSelectorName = Tok->Previous;
953           else if (Tok->Previous->ColumnWidth >
954                    Contexts.back().LongestObjCSelectorName)
955             Contexts.back().LongestObjCSelectorName =
956                 Tok->Previous->ColumnWidth;
957           Tok->Previous->ParameterIndex =
958               Contexts.back().FirstObjCSelectorName->ObjCSelectorNameParts;
959           ++Contexts.back().FirstObjCSelectorName->ObjCSelectorNameParts;
960         }
961       } else if (Contexts.back().ColonIsForRangeExpr) {
962         Tok->setType(TT_RangeBasedForLoopColon);
963       } else if (CurrentToken && CurrentToken->is(tok::numeric_constant)) {
964         Tok->setType(TT_BitFieldColon);
965       } else if (Contexts.size() == 1 &&
966                  !Line.First->isOneOf(tok::kw_enum, tok::kw_case,
967                                       tok::kw_default)) {
968         FormatToken *Prev = Tok->getPreviousNonComment();
969         if (!Prev)
970           break;
971         if (Prev->isOneOf(tok::r_paren, tok::kw_noexcept))
972           Tok->setType(TT_CtorInitializerColon);
973         else if (Prev->is(tok::kw_try)) {
974           // Member initializer list within function try block.
975           FormatToken *PrevPrev = Prev->getPreviousNonComment();
976           if (!PrevPrev)
977             break;
978           if (PrevPrev && PrevPrev->isOneOf(tok::r_paren, tok::kw_noexcept))
979             Tok->setType(TT_CtorInitializerColon);
980         } else
981           Tok->setType(TT_InheritanceColon);
982       } else if (canBeObjCSelectorComponent(*Tok->Previous) && Tok->Next &&
983                  (Tok->Next->isOneOf(tok::r_paren, tok::comma) ||
984                   (canBeObjCSelectorComponent(*Tok->Next) && Tok->Next->Next &&
985                    Tok->Next->Next->is(tok::colon)))) {
986         // This handles a special macro in ObjC code where selectors including
987         // the colon are passed as macro arguments.
988         Tok->setType(TT_ObjCMethodExpr);
989       } else if (Contexts.back().ContextKind == tok::l_paren) {
990         Tok->setType(TT_InlineASMColon);
991       }
992       break;
993     case tok::pipe:
994     case tok::amp:
995       // | and & in declarations/type expressions represent union and
996       // intersection types, respectively.
997       if (Style.isJavaScript() && !Contexts.back().IsExpression)
998         Tok->setType(TT_JsTypeOperator);
999       break;
1000     case tok::kw_if:
1001       if (CurrentToken &&
1002           CurrentToken->isOneOf(tok::kw_constexpr, tok::identifier))
1003         next();
1004       LLVM_FALLTHROUGH;
1005     case tok::kw_while:
1006       if (CurrentToken && CurrentToken->is(tok::l_paren)) {
1007         next();
1008         if (!parseParens(/*LookForDecls=*/true))
1009           return false;
1010       }
1011       break;
1012     case tok::kw_for:
1013       if (Style.isJavaScript()) {
1014         // x.for and {for: ...}
1015         if ((Tok->Previous && Tok->Previous->is(tok::period)) ||
1016             (Tok->Next && Tok->Next->is(tok::colon)))
1017           break;
1018         // JS' for await ( ...
1019         if (CurrentToken && CurrentToken->is(Keywords.kw_await))
1020           next();
1021       }
1022       if (Style.isCpp() && CurrentToken && CurrentToken->is(tok::kw_co_await))
1023         next();
1024       Contexts.back().ColonIsForRangeExpr = true;
1025       if (!CurrentToken || CurrentToken->isNot(tok::l_paren))
1026         return false;
1027       next();
1028       if (!parseParens())
1029         return false;
1030       break;
1031     case tok::l_paren:
1032       // When faced with 'operator()()', the kw_operator handler incorrectly
1033       // marks the first l_paren as a OverloadedOperatorLParen. Here, we make
1034       // the first two parens OverloadedOperators and the second l_paren an
1035       // OverloadedOperatorLParen.
1036       if (Tok->Previous && Tok->Previous->is(tok::r_paren) &&
1037           Tok->Previous->MatchingParen &&
1038           Tok->Previous->MatchingParen->is(TT_OverloadedOperatorLParen)) {
1039         Tok->Previous->setType(TT_OverloadedOperator);
1040         Tok->Previous->MatchingParen->setType(TT_OverloadedOperator);
1041         Tok->setType(TT_OverloadedOperatorLParen);
1042       }
1043 
1044       if (!parseParens())
1045         return false;
1046       if (Line.MustBeDeclaration && Contexts.size() == 1 &&
1047           !Contexts.back().IsExpression && !Line.startsWith(TT_ObjCProperty) &&
1048           !Tok->isOneOf(TT_TypeDeclarationParen, TT_RequiresExpressionLParen) &&
1049           (!Tok->Previous || !Tok->Previous->isOneOf(tok::kw___attribute,
1050                                                      TT_LeadingJavaAnnotation)))
1051         Line.MightBeFunctionDecl = true;
1052       break;
1053     case tok::l_square:
1054       if (!parseSquare())
1055         return false;
1056       break;
1057     case tok::l_brace:
1058       if (Style.Language == FormatStyle::LK_TextProto) {
1059         FormatToken *Previous = Tok->getPreviousNonComment();
1060         if (Previous && Previous->getType() != TT_DictLiteral)
1061           Previous->setType(TT_SelectorName);
1062       }
1063       if (!parseBrace())
1064         return false;
1065       break;
1066     case tok::less:
1067       if (parseAngle()) {
1068         Tok->setType(TT_TemplateOpener);
1069         // In TT_Proto, we must distignuish between:
1070         //   map<key, value>
1071         //   msg < item: data >
1072         //   msg: < item: data >
1073         // In TT_TextProto, map<key, value> does not occur.
1074         if (Style.Language == FormatStyle::LK_TextProto ||
1075             (Style.Language == FormatStyle::LK_Proto && Tok->Previous &&
1076              Tok->Previous->isOneOf(TT_SelectorName, TT_DictLiteral))) {
1077           Tok->setType(TT_DictLiteral);
1078           FormatToken *Previous = Tok->getPreviousNonComment();
1079           if (Previous && Previous->getType() != TT_DictLiteral)
1080             Previous->setType(TT_SelectorName);
1081         }
1082       } else {
1083         Tok->setType(TT_BinaryOperator);
1084         NonTemplateLess.insert(Tok);
1085         CurrentToken = Tok;
1086         next();
1087       }
1088       break;
1089     case tok::r_paren:
1090     case tok::r_square:
1091       return false;
1092     case tok::r_brace:
1093       // Lines can start with '}'.
1094       if (Tok->Previous)
1095         return false;
1096       break;
1097     case tok::greater:
1098       if (Style.Language != FormatStyle::LK_TextProto)
1099         Tok->setType(TT_BinaryOperator);
1100       if (Tok->Previous && Tok->Previous->is(TT_TemplateCloser))
1101         Tok->SpacesRequiredBefore = 1;
1102       break;
1103     case tok::kw_operator:
1104       if (Style.Language == FormatStyle::LK_TextProto ||
1105           Style.Language == FormatStyle::LK_Proto)
1106         break;
1107       while (CurrentToken &&
1108              !CurrentToken->isOneOf(tok::l_paren, tok::semi, tok::r_paren)) {
1109         if (CurrentToken->isOneOf(tok::star, tok::amp))
1110           CurrentToken->setType(TT_PointerOrReference);
1111         consumeToken();
1112         if (CurrentToken && CurrentToken->is(tok::comma) &&
1113             CurrentToken->Previous->isNot(tok::kw_operator))
1114           break;
1115         if (CurrentToken && CurrentToken->Previous->isOneOf(
1116                                 TT_BinaryOperator, TT_UnaryOperator, tok::comma,
1117                                 tok::star, tok::arrow, tok::amp, tok::ampamp))
1118           CurrentToken->Previous->setType(TT_OverloadedOperator);
1119       }
1120       if (CurrentToken && CurrentToken->is(tok::l_paren))
1121         CurrentToken->setType(TT_OverloadedOperatorLParen);
1122       if (CurrentToken && CurrentToken->Previous->is(TT_BinaryOperator))
1123         CurrentToken->Previous->setType(TT_OverloadedOperator);
1124       break;
1125     case tok::question:
1126       if (Style.isJavaScript() && Tok->Next &&
1127           Tok->Next->isOneOf(tok::semi, tok::comma, tok::colon, tok::r_paren,
1128                              tok::r_brace)) {
1129         // Question marks before semicolons, colons, etc. indicate optional
1130         // types (fields, parameters), e.g.
1131         //   function(x?: string, y?) {...}
1132         //   class X { y?; }
1133         Tok->setType(TT_JsTypeOptionalQuestion);
1134         break;
1135       }
1136       // Declarations cannot be conditional expressions, this can only be part
1137       // of a type declaration.
1138       if (Line.MustBeDeclaration && !Contexts.back().IsExpression &&
1139           Style.isJavaScript())
1140         break;
1141       if (Style.isCSharp()) {
1142         // `Type?)`, `Type?>`, `Type? name;` and `Type? name =` can only be
1143         // nullable types.
1144         // Line.MustBeDeclaration will be true for `Type? name;`.
1145         if ((!Contexts.back().IsExpression && Line.MustBeDeclaration) ||
1146             (Tok->Next && Tok->Next->isOneOf(tok::r_paren, tok::greater)) ||
1147             (Tok->Next && Tok->Next->is(tok::identifier) && Tok->Next->Next &&
1148              Tok->Next->Next->is(tok::equal))) {
1149           Tok->setType(TT_CSharpNullable);
1150           break;
1151         }
1152       }
1153       parseConditional();
1154       break;
1155     case tok::kw_template:
1156       parseTemplateDeclaration();
1157       break;
1158     case tok::comma:
1159       switch (Contexts.back().ContextType) {
1160       case Context::CtorInitializer:
1161         Tok->setType(TT_CtorInitializerComma);
1162         break;
1163       case Context::InheritanceList:
1164         Tok->setType(TT_InheritanceComma);
1165         break;
1166       default:
1167         if (Contexts.back().FirstStartOfName &&
1168             (Contexts.size() == 1 || startsWithInitStatement(Line))) {
1169           Contexts.back().FirstStartOfName->PartOfMultiVariableDeclStmt = true;
1170           Line.IsMultiVariableDeclStmt = true;
1171         }
1172         break;
1173       }
1174       if (Contexts.back().ContextType == Context::ForEachMacro)
1175         Contexts.back().IsExpression = true;
1176       break;
1177     case tok::identifier:
1178       if (Tok->isOneOf(Keywords.kw___has_include,
1179                        Keywords.kw___has_include_next))
1180         parseHasInclude();
1181       if (Style.isCSharp() && Tok->is(Keywords.kw_where) && Tok->Next &&
1182           Tok->Next->isNot(tok::l_paren)) {
1183         Tok->setType(TT_CSharpGenericTypeConstraint);
1184         parseCSharpGenericTypeConstraint();
1185       }
1186       break;
1187     case tok::arrow:
1188       if (Tok->Previous && Tok->Previous->is(tok::kw_noexcept))
1189         Tok->setType(TT_TrailingReturnArrow);
1190       break;
1191     default:
1192       break;
1193     }
1194     return true;
1195   }
1196 
1197   void parseCSharpGenericTypeConstraint() {
1198     int OpenAngleBracketsCount = 0;
1199     while (CurrentToken) {
1200       if (CurrentToken->is(tok::less)) {
1201         // parseAngle is too greedy and will consume the whole line.
1202         CurrentToken->setType(TT_TemplateOpener);
1203         ++OpenAngleBracketsCount;
1204         next();
1205       } else if (CurrentToken->is(tok::greater)) {
1206         CurrentToken->setType(TT_TemplateCloser);
1207         --OpenAngleBracketsCount;
1208         next();
1209       } else if (CurrentToken->is(tok::comma) && OpenAngleBracketsCount == 0) {
1210         // We allow line breaks after GenericTypeConstraintComma's
1211         // so do not flag commas in Generics as GenericTypeConstraintComma's.
1212         CurrentToken->setType(TT_CSharpGenericTypeConstraintComma);
1213         next();
1214       } else if (CurrentToken->is(Keywords.kw_where)) {
1215         CurrentToken->setType(TT_CSharpGenericTypeConstraint);
1216         next();
1217       } else if (CurrentToken->is(tok::colon)) {
1218         CurrentToken->setType(TT_CSharpGenericTypeConstraintColon);
1219         next();
1220       } else {
1221         next();
1222       }
1223     }
1224   }
1225 
1226   void parseIncludeDirective() {
1227     if (CurrentToken && CurrentToken->is(tok::less)) {
1228       next();
1229       while (CurrentToken) {
1230         // Mark tokens up to the trailing line comments as implicit string
1231         // literals.
1232         if (CurrentToken->isNot(tok::comment) &&
1233             !CurrentToken->TokenText.startswith("//"))
1234           CurrentToken->setType(TT_ImplicitStringLiteral);
1235         next();
1236       }
1237     }
1238   }
1239 
1240   void parseWarningOrError() {
1241     next();
1242     // We still want to format the whitespace left of the first token of the
1243     // warning or error.
1244     next();
1245     while (CurrentToken) {
1246       CurrentToken->setType(TT_ImplicitStringLiteral);
1247       next();
1248     }
1249   }
1250 
1251   void parsePragma() {
1252     next(); // Consume "pragma".
1253     if (CurrentToken &&
1254         CurrentToken->isOneOf(Keywords.kw_mark, Keywords.kw_option)) {
1255       bool IsMark = CurrentToken->is(Keywords.kw_mark);
1256       next(); // Consume "mark".
1257       next(); // Consume first token (so we fix leading whitespace).
1258       while (CurrentToken) {
1259         if (IsMark || CurrentToken->Previous->is(TT_BinaryOperator))
1260           CurrentToken->setType(TT_ImplicitStringLiteral);
1261         next();
1262       }
1263     }
1264   }
1265 
1266   void parseHasInclude() {
1267     if (!CurrentToken || !CurrentToken->is(tok::l_paren))
1268       return;
1269     next(); // '('
1270     parseIncludeDirective();
1271     next(); // ')'
1272   }
1273 
1274   LineType parsePreprocessorDirective() {
1275     bool IsFirstToken = CurrentToken->IsFirst;
1276     LineType Type = LT_PreprocessorDirective;
1277     next();
1278     if (!CurrentToken)
1279       return Type;
1280 
1281     if (Style.isJavaScript() && IsFirstToken) {
1282       // JavaScript files can contain shebang lines of the form:
1283       // #!/usr/bin/env node
1284       // Treat these like C++ #include directives.
1285       while (CurrentToken) {
1286         // Tokens cannot be comments here.
1287         CurrentToken->setType(TT_ImplicitStringLiteral);
1288         next();
1289       }
1290       return LT_ImportStatement;
1291     }
1292 
1293     if (CurrentToken->is(tok::numeric_constant)) {
1294       CurrentToken->SpacesRequiredBefore = 1;
1295       return Type;
1296     }
1297     // Hashes in the middle of a line can lead to any strange token
1298     // sequence.
1299     if (!CurrentToken->Tok.getIdentifierInfo())
1300       return Type;
1301     switch (CurrentToken->Tok.getIdentifierInfo()->getPPKeywordID()) {
1302     case tok::pp_include:
1303     case tok::pp_include_next:
1304     case tok::pp_import:
1305       next();
1306       parseIncludeDirective();
1307       Type = LT_ImportStatement;
1308       break;
1309     case tok::pp_error:
1310     case tok::pp_warning:
1311       parseWarningOrError();
1312       break;
1313     case tok::pp_pragma:
1314       parsePragma();
1315       break;
1316     case tok::pp_if:
1317     case tok::pp_elif:
1318       Contexts.back().IsExpression = true;
1319       next();
1320       parseLine();
1321       break;
1322     default:
1323       break;
1324     }
1325     while (CurrentToken) {
1326       FormatToken *Tok = CurrentToken;
1327       next();
1328       if (Tok->is(tok::l_paren))
1329         parseParens();
1330       else if (Tok->isOneOf(Keywords.kw___has_include,
1331                             Keywords.kw___has_include_next))
1332         parseHasInclude();
1333     }
1334     return Type;
1335   }
1336 
1337 public:
1338   LineType parseLine() {
1339     if (!CurrentToken)
1340       return LT_Invalid;
1341     NonTemplateLess.clear();
1342     if (CurrentToken->is(tok::hash))
1343       return parsePreprocessorDirective();
1344 
1345     // Directly allow to 'import <string-literal>' to support protocol buffer
1346     // definitions (github.com/google/protobuf) or missing "#" (either way we
1347     // should not break the line).
1348     IdentifierInfo *Info = CurrentToken->Tok.getIdentifierInfo();
1349     if ((Style.Language == FormatStyle::LK_Java &&
1350          CurrentToken->is(Keywords.kw_package)) ||
1351         (Info && Info->getPPKeywordID() == tok::pp_import &&
1352          CurrentToken->Next &&
1353          CurrentToken->Next->isOneOf(tok::string_literal, tok::identifier,
1354                                      tok::kw_static))) {
1355       next();
1356       parseIncludeDirective();
1357       return LT_ImportStatement;
1358     }
1359 
1360     // If this line starts and ends in '<' and '>', respectively, it is likely
1361     // part of "#define <a/b.h>".
1362     if (CurrentToken->is(tok::less) && Line.Last->is(tok::greater)) {
1363       parseIncludeDirective();
1364       return LT_ImportStatement;
1365     }
1366 
1367     // In .proto files, top-level options and package statements are very
1368     // similar to import statements and should not be line-wrapped.
1369     if (Style.Language == FormatStyle::LK_Proto && Line.Level == 0 &&
1370         CurrentToken->isOneOf(Keywords.kw_option, Keywords.kw_package)) {
1371       next();
1372       if (CurrentToken && CurrentToken->is(tok::identifier)) {
1373         while (CurrentToken)
1374           next();
1375         return LT_ImportStatement;
1376       }
1377     }
1378 
1379     bool KeywordVirtualFound = false;
1380     bool ImportStatement = false;
1381 
1382     // import {...} from '...';
1383     if (Style.isJavaScript() && CurrentToken->is(Keywords.kw_import))
1384       ImportStatement = true;
1385 
1386     while (CurrentToken) {
1387       if (CurrentToken->is(tok::kw_virtual))
1388         KeywordVirtualFound = true;
1389       if (Style.isJavaScript()) {
1390         // export {...} from '...';
1391         // An export followed by "from 'some string';" is a re-export from
1392         // another module identified by a URI and is treated as a
1393         // LT_ImportStatement (i.e. prevent wraps on it for long URIs).
1394         // Just "export {...};" or "export class ..." should not be treated as
1395         // an import in this sense.
1396         if (Line.First->is(tok::kw_export) &&
1397             CurrentToken->is(Keywords.kw_from) && CurrentToken->Next &&
1398             CurrentToken->Next->isStringLiteral())
1399           ImportStatement = true;
1400         if (isClosureImportStatement(*CurrentToken))
1401           ImportStatement = true;
1402       }
1403       if (!consumeToken())
1404         return LT_Invalid;
1405     }
1406     if (KeywordVirtualFound)
1407       return LT_VirtualFunctionDecl;
1408     if (ImportStatement)
1409       return LT_ImportStatement;
1410 
1411     if (Line.startsWith(TT_ObjCMethodSpecifier)) {
1412       if (Contexts.back().FirstObjCSelectorName)
1413         Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
1414             Contexts.back().LongestObjCSelectorName;
1415       return LT_ObjCMethodDecl;
1416     }
1417 
1418     for (const auto &ctx : Contexts)
1419       if (ctx.ContextType == Context::StructArrayInitializer)
1420         return LT_ArrayOfStructInitializer;
1421 
1422     return LT_Other;
1423   }
1424 
1425 private:
1426   bool isClosureImportStatement(const FormatToken &Tok) {
1427     // FIXME: Closure-library specific stuff should not be hard-coded but be
1428     // configurable.
1429     return Tok.TokenText == "goog" && Tok.Next && Tok.Next->is(tok::period) &&
1430            Tok.Next->Next &&
1431            (Tok.Next->Next->TokenText == "module" ||
1432             Tok.Next->Next->TokenText == "provide" ||
1433             Tok.Next->Next->TokenText == "require" ||
1434             Tok.Next->Next->TokenText == "requireType" ||
1435             Tok.Next->Next->TokenText == "forwardDeclare") &&
1436            Tok.Next->Next->Next && Tok.Next->Next->Next->is(tok::l_paren);
1437   }
1438 
1439   void resetTokenMetadata() {
1440     if (!CurrentToken)
1441       return;
1442 
1443     // Reset token type in case we have already looked at it and then
1444     // recovered from an error (e.g. failure to find the matching >).
1445     if (!CurrentToken->isTypeFinalized() &&
1446         !CurrentToken->isOneOf(
1447             TT_LambdaLSquare, TT_LambdaLBrace, TT_AttributeMacro, TT_IfMacro,
1448             TT_ForEachMacro, TT_TypenameMacro, TT_FunctionLBrace,
1449             TT_ImplicitStringLiteral, TT_InlineASMBrace, TT_FatArrow,
1450             TT_LambdaArrow, TT_NamespaceMacro, TT_OverloadedOperator,
1451             TT_RegexLiteral, TT_TemplateString, TT_ObjCStringLiteral,
1452             TT_UntouchableMacroFunc, TT_StatementAttributeLikeMacro,
1453             TT_FunctionLikeOrFreestandingMacro, TT_ClassLBrace, TT_EnumLBrace,
1454             TT_RecordLBrace, TT_StructLBrace, TT_UnionLBrace, TT_RequiresClause,
1455             TT_RequiresClauseInARequiresExpression, TT_RequiresExpression,
1456             TT_RequiresExpressionLParen, TT_RequiresExpressionLBrace,
1457             TT_CompoundRequirementLBrace, TT_BracedListLBrace))
1458       CurrentToken->setType(TT_Unknown);
1459     CurrentToken->Role.reset();
1460     CurrentToken->MatchingParen = nullptr;
1461     CurrentToken->FakeLParens.clear();
1462     CurrentToken->FakeRParens = 0;
1463   }
1464 
1465   void next() {
1466     if (!CurrentToken)
1467       return;
1468 
1469     CurrentToken->NestingLevel = Contexts.size() - 1;
1470     CurrentToken->BindingStrength = Contexts.back().BindingStrength;
1471     modifyContext(*CurrentToken);
1472     determineTokenType(*CurrentToken);
1473     CurrentToken = CurrentToken->Next;
1474 
1475     resetTokenMetadata();
1476   }
1477 
1478   /// A struct to hold information valid in a specific context, e.g.
1479   /// a pair of parenthesis.
1480   struct Context {
1481     Context(tok::TokenKind ContextKind, unsigned BindingStrength,
1482             bool IsExpression)
1483         : ContextKind(ContextKind), BindingStrength(BindingStrength),
1484           IsExpression(IsExpression) {}
1485 
1486     tok::TokenKind ContextKind;
1487     unsigned BindingStrength;
1488     bool IsExpression;
1489     unsigned LongestObjCSelectorName = 0;
1490     bool ColonIsForRangeExpr = false;
1491     bool ColonIsDictLiteral = false;
1492     bool ColonIsObjCMethodExpr = false;
1493     FormatToken *FirstObjCSelectorName = nullptr;
1494     FormatToken *FirstStartOfName = nullptr;
1495     bool CanBeExpression = true;
1496     bool CaretFound = false;
1497     bool InCpp11AttributeSpecifier = false;
1498     bool InCSharpAttributeSpecifier = false;
1499     enum {
1500       Unknown,
1501       // Like the part after `:` in a constructor.
1502       //   Context(...) : IsExpression(IsExpression)
1503       CtorInitializer,
1504       // Like in the parentheses in a foreach.
1505       ForEachMacro,
1506       // Like the inheritance list in a class declaration.
1507       //   class Input : public IO
1508       InheritanceList,
1509       // Like in the braced list.
1510       //   int x[] = {};
1511       StructArrayInitializer,
1512       // Like in `static_cast<int>`.
1513       TemplateArgument,
1514     } ContextType = Unknown;
1515   };
1516 
1517   /// Puts a new \c Context onto the stack \c Contexts for the lifetime
1518   /// of each instance.
1519   struct ScopedContextCreator {
1520     AnnotatingParser &P;
1521 
1522     ScopedContextCreator(AnnotatingParser &P, tok::TokenKind ContextKind,
1523                          unsigned Increase)
1524         : P(P) {
1525       P.Contexts.push_back(Context(ContextKind,
1526                                    P.Contexts.back().BindingStrength + Increase,
1527                                    P.Contexts.back().IsExpression));
1528     }
1529 
1530     ~ScopedContextCreator() {
1531       if (P.Style.AlignArrayOfStructures != FormatStyle::AIAS_None) {
1532         if (P.Contexts.back().ContextType == Context::StructArrayInitializer) {
1533           P.Contexts.pop_back();
1534           P.Contexts.back().ContextType = Context::StructArrayInitializer;
1535           return;
1536         }
1537       }
1538       P.Contexts.pop_back();
1539     }
1540   };
1541 
1542   void modifyContext(const FormatToken &Current) {
1543     auto AssignmentStartsExpression = [&]() {
1544       if (Current.getPrecedence() != prec::Assignment)
1545         return false;
1546 
1547       if (Line.First->isOneOf(tok::kw_using, tok::kw_return))
1548         return false;
1549       if (Line.First->is(tok::kw_template)) {
1550         assert(Current.Previous);
1551         if (Current.Previous->is(tok::kw_operator)) {
1552           // `template ... operator=` cannot be an expression.
1553           return false;
1554         }
1555 
1556         // `template` keyword can start a variable template.
1557         const FormatToken *Tok = Line.First->getNextNonComment();
1558         assert(Tok); // Current token is on the same line.
1559         if (Tok->isNot(TT_TemplateOpener)) {
1560           // Explicit template instantiations do not have `<>`.
1561           return false;
1562         }
1563 
1564         Tok = Tok->MatchingParen;
1565         if (!Tok)
1566           return false;
1567         Tok = Tok->getNextNonComment();
1568         if (!Tok)
1569           return false;
1570 
1571         if (Tok->isOneOf(tok::kw_class, tok::kw_enum, tok::kw_concept,
1572                          tok::kw_struct, tok::kw_using))
1573           return false;
1574 
1575         return true;
1576       }
1577 
1578       // Type aliases use `type X = ...;` in TypeScript and can be exported
1579       // using `export type ...`.
1580       if (Style.isJavaScript() &&
1581           (Line.startsWith(Keywords.kw_type, tok::identifier) ||
1582            Line.startsWith(tok::kw_export, Keywords.kw_type, tok::identifier)))
1583         return false;
1584 
1585       return !Current.Previous || Current.Previous->isNot(tok::kw_operator);
1586     };
1587 
1588     if (AssignmentStartsExpression()) {
1589       Contexts.back().IsExpression = true;
1590       if (!Line.startsWith(TT_UnaryOperator)) {
1591         for (FormatToken *Previous = Current.Previous;
1592              Previous && Previous->Previous &&
1593              !Previous->Previous->isOneOf(tok::comma, tok::semi);
1594              Previous = Previous->Previous) {
1595           if (Previous->isOneOf(tok::r_square, tok::r_paren)) {
1596             Previous = Previous->MatchingParen;
1597             if (!Previous)
1598               break;
1599           }
1600           if (Previous->opensScope())
1601             break;
1602           if (Previous->isOneOf(TT_BinaryOperator, TT_UnaryOperator) &&
1603               Previous->isOneOf(tok::star, tok::amp, tok::ampamp) &&
1604               Previous->Previous && Previous->Previous->isNot(tok::equal))
1605             Previous->setType(TT_PointerOrReference);
1606         }
1607       }
1608     } else if (Current.is(tok::lessless) &&
1609                (!Current.Previous || !Current.Previous->is(tok::kw_operator))) {
1610       Contexts.back().IsExpression = true;
1611     } else if (Current.isOneOf(tok::kw_return, tok::kw_throw)) {
1612       Contexts.back().IsExpression = true;
1613     } else if (Current.is(TT_TrailingReturnArrow)) {
1614       Contexts.back().IsExpression = false;
1615     } else if (Current.is(TT_LambdaArrow) || Current.is(Keywords.kw_assert)) {
1616       Contexts.back().IsExpression = Style.Language == FormatStyle::LK_Java;
1617     } else if (Current.Previous &&
1618                Current.Previous->is(TT_CtorInitializerColon)) {
1619       Contexts.back().IsExpression = true;
1620       Contexts.back().ContextType = Context::CtorInitializer;
1621     } else if (Current.Previous && Current.Previous->is(TT_InheritanceColon)) {
1622       Contexts.back().ContextType = Context::InheritanceList;
1623     } else if (Current.isOneOf(tok::r_paren, tok::greater, tok::comma)) {
1624       for (FormatToken *Previous = Current.Previous;
1625            Previous && Previous->isOneOf(tok::star, tok::amp);
1626            Previous = Previous->Previous)
1627         Previous->setType(TT_PointerOrReference);
1628       if (Line.MustBeDeclaration &&
1629           Contexts.front().ContextType != Context::CtorInitializer)
1630         Contexts.back().IsExpression = false;
1631     } else if (Current.is(tok::kw_new)) {
1632       Contexts.back().CanBeExpression = false;
1633     } else if (Current.is(tok::semi) ||
1634                (Current.is(tok::exclaim) && Current.Previous &&
1635                 !Current.Previous->is(tok::kw_operator))) {
1636       // This should be the condition or increment in a for-loop.
1637       // But not operator !() (can't use TT_OverloadedOperator here as its not
1638       // been annotated yet).
1639       Contexts.back().IsExpression = true;
1640     }
1641   }
1642 
1643   static FormatToken *untilMatchingParen(FormatToken *Current) {
1644     // Used when `MatchingParen` is not yet established.
1645     int ParenLevel = 0;
1646     while (Current) {
1647       if (Current->is(tok::l_paren))
1648         ++ParenLevel;
1649       if (Current->is(tok::r_paren))
1650         --ParenLevel;
1651       if (ParenLevel < 1)
1652         break;
1653       Current = Current->Next;
1654     }
1655     return Current;
1656   }
1657 
1658   static bool isDeductionGuide(FormatToken &Current) {
1659     // Look for a deduction guide template<T> A(...) -> A<...>;
1660     if (Current.Previous && Current.Previous->is(tok::r_paren) &&
1661         Current.startsSequence(tok::arrow, tok::identifier, tok::less)) {
1662       // Find the TemplateCloser.
1663       FormatToken *TemplateCloser = Current.Next->Next;
1664       int NestingLevel = 0;
1665       while (TemplateCloser) {
1666         // Skip over an expressions in parens  A<(3 < 2)>;
1667         if (TemplateCloser->is(tok::l_paren)) {
1668           // No Matching Paren yet so skip to matching paren
1669           TemplateCloser = untilMatchingParen(TemplateCloser);
1670           if (!TemplateCloser)
1671             break;
1672         }
1673         if (TemplateCloser->is(tok::less))
1674           ++NestingLevel;
1675         if (TemplateCloser->is(tok::greater))
1676           --NestingLevel;
1677         if (NestingLevel < 1)
1678           break;
1679         TemplateCloser = TemplateCloser->Next;
1680       }
1681       // Assuming we have found the end of the template ensure its followed
1682       // with a semi-colon.
1683       if (TemplateCloser && TemplateCloser->Next &&
1684           TemplateCloser->Next->is(tok::semi) &&
1685           Current.Previous->MatchingParen) {
1686         // Determine if the identifier `A` prior to the A<..>; is the same as
1687         // prior to the A(..)
1688         FormatToken *LeadingIdentifier =
1689             Current.Previous->MatchingParen->Previous;
1690 
1691         // Differentiate a deduction guide by seeing the
1692         // > of the template prior to the leading identifier.
1693         if (LeadingIdentifier) {
1694           FormatToken *PriorLeadingIdentifier = LeadingIdentifier->Previous;
1695           // Skip back past explicit decoration
1696           if (PriorLeadingIdentifier &&
1697               PriorLeadingIdentifier->is(tok::kw_explicit))
1698             PriorLeadingIdentifier = PriorLeadingIdentifier->Previous;
1699 
1700           return PriorLeadingIdentifier &&
1701                  (PriorLeadingIdentifier->is(TT_TemplateCloser) ||
1702                   PriorLeadingIdentifier->ClosesRequiresClause) &&
1703                  LeadingIdentifier->TokenText == Current.Next->TokenText;
1704         }
1705       }
1706     }
1707     return false;
1708   }
1709 
1710   void determineTokenType(FormatToken &Current) {
1711     if (!Current.is(TT_Unknown))
1712       // The token type is already known.
1713       return;
1714 
1715     if ((Style.isJavaScript() || Style.isCSharp()) &&
1716         Current.is(tok::exclaim)) {
1717       if (Current.Previous) {
1718         bool IsIdentifier =
1719             Style.isJavaScript()
1720                 ? Keywords.IsJavaScriptIdentifier(
1721                       *Current.Previous, /* AcceptIdentifierName= */ true)
1722                 : Current.Previous->is(tok::identifier);
1723         if (IsIdentifier ||
1724             Current.Previous->isOneOf(
1725                 tok::kw_default, tok::kw_namespace, tok::r_paren, tok::r_square,
1726                 tok::r_brace, tok::kw_false, tok::kw_true, Keywords.kw_type,
1727                 Keywords.kw_get, Keywords.kw_init, Keywords.kw_set) ||
1728             Current.Previous->Tok.isLiteral()) {
1729           Current.setType(TT_NonNullAssertion);
1730           return;
1731         }
1732       }
1733       if (Current.Next &&
1734           Current.Next->isOneOf(TT_BinaryOperator, Keywords.kw_as)) {
1735         Current.setType(TT_NonNullAssertion);
1736         return;
1737       }
1738     }
1739 
1740     // Line.MightBeFunctionDecl can only be true after the parentheses of a
1741     // function declaration have been found. In this case, 'Current' is a
1742     // trailing token of this declaration and thus cannot be a name.
1743     if (Current.is(Keywords.kw_instanceof)) {
1744       Current.setType(TT_BinaryOperator);
1745     } else if (isStartOfName(Current) &&
1746                (!Line.MightBeFunctionDecl || Current.NestingLevel != 0)) {
1747       Contexts.back().FirstStartOfName = &Current;
1748       Current.setType(TT_StartOfName);
1749     } else if (Current.is(tok::semi)) {
1750       // Reset FirstStartOfName after finding a semicolon so that a for loop
1751       // with multiple increment statements is not confused with a for loop
1752       // having multiple variable declarations.
1753       Contexts.back().FirstStartOfName = nullptr;
1754     } else if (Current.isOneOf(tok::kw_auto, tok::kw___auto_type)) {
1755       AutoFound = true;
1756     } else if (Current.is(tok::arrow) &&
1757                Style.Language == FormatStyle::LK_Java) {
1758       Current.setType(TT_LambdaArrow);
1759     } else if (Current.is(tok::arrow) && AutoFound && Line.MustBeDeclaration &&
1760                Current.NestingLevel == 0 &&
1761                !Current.Previous->isOneOf(tok::kw_operator, tok::identifier)) {
1762       // not auto operator->() -> xxx;
1763       Current.setType(TT_TrailingReturnArrow);
1764     } else if (Current.is(tok::arrow) && Current.Previous &&
1765                Current.Previous->is(tok::r_brace)) {
1766       // Concept implicit conversion constraint needs to be treated like
1767       // a trailing return type  ... } -> <type>.
1768       Current.setType(TT_TrailingReturnArrow);
1769     } else if (isDeductionGuide(Current)) {
1770       // Deduction guides trailing arrow " A(...) -> A<T>;".
1771       Current.setType(TT_TrailingReturnArrow);
1772     } else if (Current.isOneOf(tok::star, tok::amp, tok::ampamp)) {
1773       Current.setType(determineStarAmpUsage(
1774           Current,
1775           Contexts.back().CanBeExpression && Contexts.back().IsExpression,
1776           Contexts.back().ContextType == Context::TemplateArgument));
1777     } else if (Current.isOneOf(tok::minus, tok::plus, tok::caret)) {
1778       Current.setType(determinePlusMinusCaretUsage(Current));
1779       if (Current.is(TT_UnaryOperator) && Current.is(tok::caret))
1780         Contexts.back().CaretFound = true;
1781     } else if (Current.isOneOf(tok::minusminus, tok::plusplus)) {
1782       Current.setType(determineIncrementUsage(Current));
1783     } else if (Current.isOneOf(tok::exclaim, tok::tilde)) {
1784       Current.setType(TT_UnaryOperator);
1785     } else if (Current.is(tok::question)) {
1786       if (Style.isJavaScript() && Line.MustBeDeclaration &&
1787           !Contexts.back().IsExpression) {
1788         // In JavaScript, `interface X { foo?(): bar; }` is an optional method
1789         // on the interface, not a ternary expression.
1790         Current.setType(TT_JsTypeOptionalQuestion);
1791       } else {
1792         Current.setType(TT_ConditionalExpr);
1793       }
1794     } else if (Current.isBinaryOperator() &&
1795                (!Current.Previous || Current.Previous->isNot(tok::l_square)) &&
1796                (!Current.is(tok::greater) &&
1797                 Style.Language != FormatStyle::LK_TextProto)) {
1798       Current.setType(TT_BinaryOperator);
1799     } else if (Current.is(tok::comment)) {
1800       if (Current.TokenText.startswith("/*"))
1801         if (Current.TokenText.endswith("*/"))
1802           Current.setType(TT_BlockComment);
1803         else
1804           // The lexer has for some reason determined a comment here. But we
1805           // cannot really handle it, if it isn't properly terminated.
1806           Current.Tok.setKind(tok::unknown);
1807       else
1808         Current.setType(TT_LineComment);
1809     } else if (Current.is(tok::l_paren)) {
1810       if (lParenStartsCppCast(Current))
1811         Current.setType(TT_CppCastLParen);
1812     } else if (Current.is(tok::r_paren)) {
1813       if (rParenEndsCast(Current))
1814         Current.setType(TT_CastRParen);
1815       if (Current.MatchingParen && Current.Next &&
1816           !Current.Next->isBinaryOperator() &&
1817           !Current.Next->isOneOf(tok::semi, tok::colon, tok::l_brace,
1818                                  tok::comma, tok::period, tok::arrow,
1819                                  tok::coloncolon))
1820         if (FormatToken *AfterParen = Current.MatchingParen->Next) {
1821           // Make sure this isn't the return type of an Obj-C block declaration
1822           if (AfterParen->isNot(tok::caret)) {
1823             if (FormatToken *BeforeParen = Current.MatchingParen->Previous)
1824               if (BeforeParen->is(tok::identifier) &&
1825                   !BeforeParen->is(TT_TypenameMacro) &&
1826                   BeforeParen->TokenText == BeforeParen->TokenText.upper() &&
1827                   (!BeforeParen->Previous ||
1828                    BeforeParen->Previous->ClosesTemplateDeclaration))
1829                 Current.setType(TT_FunctionAnnotationRParen);
1830           }
1831         }
1832     } else if (Current.is(tok::at) && Current.Next && !Style.isJavaScript() &&
1833                Style.Language != FormatStyle::LK_Java) {
1834       // In Java & JavaScript, "@..." is a decorator or annotation. In ObjC, it
1835       // marks declarations and properties that need special formatting.
1836       switch (Current.Next->Tok.getObjCKeywordID()) {
1837       case tok::objc_interface:
1838       case tok::objc_implementation:
1839       case tok::objc_protocol:
1840         Current.setType(TT_ObjCDecl);
1841         break;
1842       case tok::objc_property:
1843         Current.setType(TT_ObjCProperty);
1844         break;
1845       default:
1846         break;
1847       }
1848     } else if (Current.is(tok::period)) {
1849       FormatToken *PreviousNoComment = Current.getPreviousNonComment();
1850       if (PreviousNoComment &&
1851           PreviousNoComment->isOneOf(tok::comma, tok::l_brace))
1852         Current.setType(TT_DesignatedInitializerPeriod);
1853       else if (Style.Language == FormatStyle::LK_Java && Current.Previous &&
1854                Current.Previous->isOneOf(TT_JavaAnnotation,
1855                                          TT_LeadingJavaAnnotation))
1856         Current.setType(Current.Previous->getType());
1857     } else if (canBeObjCSelectorComponent(Current) &&
1858                // FIXME(bug 36976): ObjC return types shouldn't use
1859                // TT_CastRParen.
1860                Current.Previous && Current.Previous->is(TT_CastRParen) &&
1861                Current.Previous->MatchingParen &&
1862                Current.Previous->MatchingParen->Previous &&
1863                Current.Previous->MatchingParen->Previous->is(
1864                    TT_ObjCMethodSpecifier)) {
1865       // This is the first part of an Objective-C selector name. (If there's no
1866       // colon after this, this is the only place which annotates the identifier
1867       // as a selector.)
1868       Current.setType(TT_SelectorName);
1869     } else if (Current.isOneOf(tok::identifier, tok::kw_const, tok::kw_noexcept,
1870                                tok::kw_requires) &&
1871                Current.Previous &&
1872                !Current.Previous->isOneOf(tok::equal, tok::at) &&
1873                Line.MightBeFunctionDecl && Contexts.size() == 1) {
1874       // Line.MightBeFunctionDecl can only be true after the parentheses of a
1875       // function declaration have been found.
1876       Current.setType(TT_TrailingAnnotation);
1877     } else if ((Style.Language == FormatStyle::LK_Java ||
1878                 Style.isJavaScript()) &&
1879                Current.Previous) {
1880       if (Current.Previous->is(tok::at) &&
1881           Current.isNot(Keywords.kw_interface)) {
1882         const FormatToken &AtToken = *Current.Previous;
1883         const FormatToken *Previous = AtToken.getPreviousNonComment();
1884         if (!Previous || Previous->is(TT_LeadingJavaAnnotation))
1885           Current.setType(TT_LeadingJavaAnnotation);
1886         else
1887           Current.setType(TT_JavaAnnotation);
1888       } else if (Current.Previous->is(tok::period) &&
1889                  Current.Previous->isOneOf(TT_JavaAnnotation,
1890                                            TT_LeadingJavaAnnotation)) {
1891         Current.setType(Current.Previous->getType());
1892       }
1893     }
1894   }
1895 
1896   /// Take a guess at whether \p Tok starts a name of a function or
1897   /// variable declaration.
1898   ///
1899   /// This is a heuristic based on whether \p Tok is an identifier following
1900   /// something that is likely a type.
1901   bool isStartOfName(const FormatToken &Tok) {
1902     if (Tok.isNot(tok::identifier) || !Tok.Previous)
1903       return false;
1904 
1905     if (Tok.Previous->isOneOf(TT_LeadingJavaAnnotation, Keywords.kw_instanceof,
1906                               Keywords.kw_as))
1907       return false;
1908     if (Style.isJavaScript() && Tok.Previous->is(Keywords.kw_in))
1909       return false;
1910 
1911     // Skip "const" as it does not have an influence on whether this is a name.
1912     FormatToken *PreviousNotConst = Tok.getPreviousNonComment();
1913 
1914     // For javascript const can be like "let" or "var"
1915     if (!Style.isJavaScript())
1916       while (PreviousNotConst && PreviousNotConst->is(tok::kw_const))
1917         PreviousNotConst = PreviousNotConst->getPreviousNonComment();
1918 
1919     if (!PreviousNotConst)
1920       return false;
1921 
1922     if (PreviousNotConst->ClosesRequiresClause)
1923       return false;
1924 
1925     bool IsPPKeyword = PreviousNotConst->is(tok::identifier) &&
1926                        PreviousNotConst->Previous &&
1927                        PreviousNotConst->Previous->is(tok::hash);
1928 
1929     if (PreviousNotConst->is(TT_TemplateCloser))
1930       return PreviousNotConst && PreviousNotConst->MatchingParen &&
1931              PreviousNotConst->MatchingParen->Previous &&
1932              PreviousNotConst->MatchingParen->Previous->isNot(tok::period) &&
1933              PreviousNotConst->MatchingParen->Previous->isNot(tok::kw_template);
1934 
1935     if (PreviousNotConst->is(tok::r_paren) &&
1936         PreviousNotConst->is(TT_TypeDeclarationParen))
1937       return true;
1938 
1939     // If is a preprocess keyword like #define.
1940     if (IsPPKeyword)
1941       return false;
1942 
1943     // int a or auto a.
1944     if (PreviousNotConst->isOneOf(tok::identifier, tok::kw_auto))
1945       return true;
1946 
1947     // *a or &a or &&a.
1948     if (PreviousNotConst->is(TT_PointerOrReference))
1949       return true;
1950 
1951     // MyClass a;
1952     if (PreviousNotConst->isSimpleTypeSpecifier())
1953       return true;
1954 
1955     // const a = in JavaScript.
1956     return Style.isJavaScript() && PreviousNotConst->is(tok::kw_const);
1957   }
1958 
1959   /// Determine whether '(' is starting a C++ cast.
1960   bool lParenStartsCppCast(const FormatToken &Tok) {
1961     // C-style casts are only used in C++.
1962     if (!Style.isCpp())
1963       return false;
1964 
1965     FormatToken *LeftOfParens = Tok.getPreviousNonComment();
1966     if (LeftOfParens && LeftOfParens->is(TT_TemplateCloser) &&
1967         LeftOfParens->MatchingParen) {
1968       auto *Prev = LeftOfParens->MatchingParen->getPreviousNonComment();
1969       if (Prev && Prev->isOneOf(tok::kw_const_cast, tok::kw_dynamic_cast,
1970                                 tok::kw_reinterpret_cast, tok::kw_static_cast))
1971         // FIXME: Maybe we should handle identifiers ending with "_cast",
1972         // e.g. any_cast?
1973         return true;
1974     }
1975     return false;
1976   }
1977 
1978   /// Determine whether ')' is ending a cast.
1979   bool rParenEndsCast(const FormatToken &Tok) {
1980     // C-style casts are only used in C++, C# and Java.
1981     if (!Style.isCSharp() && !Style.isCpp() &&
1982         Style.Language != FormatStyle::LK_Java)
1983       return false;
1984 
1985     // Empty parens aren't casts and there are no casts at the end of the line.
1986     if (Tok.Previous == Tok.MatchingParen || !Tok.Next || !Tok.MatchingParen)
1987       return false;
1988 
1989     FormatToken *LeftOfParens = Tok.MatchingParen->getPreviousNonComment();
1990     if (LeftOfParens) {
1991       // If there is a closing parenthesis left of the current
1992       // parentheses, look past it as these might be chained casts.
1993       if (LeftOfParens->is(tok::r_paren) &&
1994           LeftOfParens->isNot(TT_CastRParen)) {
1995         if (!LeftOfParens->MatchingParen ||
1996             !LeftOfParens->MatchingParen->Previous)
1997           return false;
1998         LeftOfParens = LeftOfParens->MatchingParen->Previous;
1999       }
2000 
2001       if (LeftOfParens->is(tok::r_square)) {
2002         //   delete[] (void *)ptr;
2003         auto MayBeArrayDelete = [](FormatToken *Tok) -> FormatToken * {
2004           if (Tok->isNot(tok::r_square))
2005             return nullptr;
2006 
2007           Tok = Tok->getPreviousNonComment();
2008           if (!Tok || Tok->isNot(tok::l_square))
2009             return nullptr;
2010 
2011           Tok = Tok->getPreviousNonComment();
2012           if (!Tok || Tok->isNot(tok::kw_delete))
2013             return nullptr;
2014           return Tok;
2015         };
2016         if (FormatToken *MaybeDelete = MayBeArrayDelete(LeftOfParens))
2017           LeftOfParens = MaybeDelete;
2018       }
2019 
2020       // The Condition directly below this one will see the operator arguments
2021       // as a (void *foo) cast.
2022       //   void operator delete(void *foo) ATTRIB;
2023       if (LeftOfParens->Tok.getIdentifierInfo() && LeftOfParens->Previous &&
2024           LeftOfParens->Previous->is(tok::kw_operator))
2025         return false;
2026 
2027       // If there is an identifier (or with a few exceptions a keyword) right
2028       // before the parentheses, this is unlikely to be a cast.
2029       if (LeftOfParens->Tok.getIdentifierInfo() &&
2030           !LeftOfParens->isOneOf(Keywords.kw_in, tok::kw_return, tok::kw_case,
2031                                  tok::kw_delete))
2032         return false;
2033 
2034       // Certain other tokens right before the parentheses are also signals that
2035       // this cannot be a cast.
2036       if (LeftOfParens->isOneOf(tok::at, tok::r_square, TT_OverloadedOperator,
2037                                 TT_TemplateCloser, tok::ellipsis))
2038         return false;
2039     }
2040 
2041     if (Tok.Next->is(tok::question))
2042       return false;
2043 
2044     // `foreach((A a, B b) in someList)` should not be seen as a cast.
2045     if (Tok.Next->is(Keywords.kw_in) && Style.isCSharp())
2046       return false;
2047 
2048     // Functions which end with decorations like volatile, noexcept are unlikely
2049     // to be casts.
2050     if (Tok.Next->isOneOf(tok::kw_noexcept, tok::kw_volatile, tok::kw_const,
2051                           tok::kw_requires, tok::kw_throw, tok::arrow,
2052                           Keywords.kw_override, Keywords.kw_final) ||
2053         isCpp11AttributeSpecifier(*Tok.Next))
2054       return false;
2055 
2056     // As Java has no function types, a "(" after the ")" likely means that this
2057     // is a cast.
2058     if (Style.Language == FormatStyle::LK_Java && Tok.Next->is(tok::l_paren))
2059       return true;
2060 
2061     // If a (non-string) literal follows, this is likely a cast.
2062     if (Tok.Next->isNot(tok::string_literal) &&
2063         (Tok.Next->Tok.isLiteral() ||
2064          Tok.Next->isOneOf(tok::kw_sizeof, tok::kw_alignof)))
2065       return true;
2066 
2067     // Heuristically try to determine whether the parentheses contain a type.
2068     auto IsQualifiedPointerOrReference = [](FormatToken *T) {
2069       // This is used to handle cases such as x = (foo *const)&y;
2070       assert(!T->isSimpleTypeSpecifier() && "Should have already been checked");
2071       // Strip trailing qualifiers such as const or volatile when checking
2072       // whether the parens could be a cast to a pointer/reference type.
2073       while (T) {
2074         if (T->is(TT_AttributeParen)) {
2075           // Handle `x = (foo *__attribute__((foo)))&v;`:
2076           if (T->MatchingParen && T->MatchingParen->Previous &&
2077               T->MatchingParen->Previous->is(tok::kw___attribute)) {
2078             T = T->MatchingParen->Previous->Previous;
2079             continue;
2080           }
2081         } else if (T->is(TT_AttributeSquare)) {
2082           // Handle `x = (foo *[[clang::foo]])&v;`:
2083           if (T->MatchingParen && T->MatchingParen->Previous) {
2084             T = T->MatchingParen->Previous;
2085             continue;
2086           }
2087         } else if (T->canBePointerOrReferenceQualifier()) {
2088           T = T->Previous;
2089           continue;
2090         }
2091         break;
2092       }
2093       return T && T->is(TT_PointerOrReference);
2094     };
2095     bool ParensAreType =
2096         !Tok.Previous ||
2097         Tok.Previous->isOneOf(TT_TemplateCloser, TT_TypeDeclarationParen) ||
2098         Tok.Previous->isSimpleTypeSpecifier() ||
2099         IsQualifiedPointerOrReference(Tok.Previous);
2100     bool ParensCouldEndDecl =
2101         Tok.Next->isOneOf(tok::equal, tok::semi, tok::l_brace, tok::greater);
2102     if (ParensAreType && !ParensCouldEndDecl)
2103       return true;
2104 
2105     // At this point, we heuristically assume that there are no casts at the
2106     // start of the line. We assume that we have found most cases where there
2107     // are by the logic above, e.g. "(void)x;".
2108     if (!LeftOfParens)
2109       return false;
2110 
2111     // Certain token types inside the parentheses mean that this can't be a
2112     // cast.
2113     for (const FormatToken *Token = Tok.MatchingParen->Next; Token != &Tok;
2114          Token = Token->Next)
2115       if (Token->is(TT_BinaryOperator))
2116         return false;
2117 
2118     // If the following token is an identifier or 'this', this is a cast. All
2119     // cases where this can be something else are handled above.
2120     if (Tok.Next->isOneOf(tok::identifier, tok::kw_this))
2121       return true;
2122 
2123     // Look for a cast `( x ) (`.
2124     if (Tok.Next->is(tok::l_paren) && Tok.Previous && Tok.Previous->Previous) {
2125       if (Tok.Previous->is(tok::identifier) &&
2126           Tok.Previous->Previous->is(tok::l_paren))
2127         return true;
2128     }
2129 
2130     if (!Tok.Next->Next)
2131       return false;
2132 
2133     // If the next token after the parenthesis is a unary operator, assume
2134     // that this is cast, unless there are unexpected tokens inside the
2135     // parenthesis.
2136     bool NextIsUnary =
2137         Tok.Next->isUnaryOperator() || Tok.Next->isOneOf(tok::amp, tok::star);
2138     if (!NextIsUnary || Tok.Next->is(tok::plus) ||
2139         !Tok.Next->Next->isOneOf(tok::identifier, tok::numeric_constant))
2140       return false;
2141     // Search for unexpected tokens.
2142     for (FormatToken *Prev = Tok.Previous; Prev != Tok.MatchingParen;
2143          Prev = Prev->Previous)
2144       if (!Prev->isOneOf(tok::kw_const, tok::identifier, tok::coloncolon))
2145         return false;
2146     return true;
2147   }
2148 
2149   /// Return the type of the given token assuming it is * or &.
2150   TokenType determineStarAmpUsage(const FormatToken &Tok, bool IsExpression,
2151                                   bool InTemplateArgument) {
2152     if (Style.isJavaScript())
2153       return TT_BinaryOperator;
2154 
2155     // && in C# must be a binary operator.
2156     if (Style.isCSharp() && Tok.is(tok::ampamp))
2157       return TT_BinaryOperator;
2158 
2159     const FormatToken *PrevToken = Tok.getPreviousNonComment();
2160     if (!PrevToken)
2161       return TT_UnaryOperator;
2162 
2163     const FormatToken *NextToken = Tok.getNextNonComment();
2164 
2165     if (InTemplateArgument && NextToken && NextToken->is(tok::kw_noexcept))
2166       return TT_BinaryOperator;
2167 
2168     if (!NextToken ||
2169         NextToken->isOneOf(tok::arrow, tok::equal, tok::kw_noexcept) ||
2170         NextToken->canBePointerOrReferenceQualifier() ||
2171         (NextToken->is(tok::l_brace) && !NextToken->getNextNonComment()))
2172       return TT_PointerOrReference;
2173 
2174     if (PrevToken->is(tok::coloncolon))
2175       return TT_PointerOrReference;
2176 
2177     if (PrevToken->is(tok::r_paren) && PrevToken->is(TT_TypeDeclarationParen))
2178       return TT_PointerOrReference;
2179 
2180     if (PrevToken->isOneOf(tok::l_paren, tok::l_square, tok::l_brace,
2181                            tok::comma, tok::semi, tok::kw_return, tok::colon,
2182                            tok::kw_co_return, tok::kw_co_await,
2183                            tok::kw_co_yield, tok::equal, tok::kw_delete,
2184                            tok::kw_sizeof, tok::kw_throw, TT_BinaryOperator,
2185                            TT_ConditionalExpr, TT_UnaryOperator, TT_CastRParen))
2186       return TT_UnaryOperator;
2187 
2188     if (NextToken->is(tok::l_square) && NextToken->isNot(TT_LambdaLSquare))
2189       return TT_PointerOrReference;
2190     if (NextToken->is(tok::kw_operator) && !IsExpression)
2191       return TT_PointerOrReference;
2192     if (NextToken->isOneOf(tok::comma, tok::semi))
2193       return TT_PointerOrReference;
2194 
2195     if (PrevToken->Tok.isLiteral() ||
2196         PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::kw_true,
2197                            tok::kw_false, tok::r_brace))
2198       return TT_BinaryOperator;
2199 
2200     const FormatToken *NextNonParen = NextToken;
2201     while (NextNonParen && NextNonParen->is(tok::l_paren))
2202       NextNonParen = NextNonParen->getNextNonComment();
2203     if (NextNonParen && (NextNonParen->Tok.isLiteral() ||
2204                          NextNonParen->isOneOf(tok::kw_true, tok::kw_false) ||
2205                          NextNonParen->isUnaryOperator()))
2206       return TT_BinaryOperator;
2207 
2208     // If we know we're in a template argument, there are no named declarations.
2209     // Thus, having an identifier on the right-hand side indicates a binary
2210     // operator.
2211     if (InTemplateArgument && NextToken->Tok.isAnyIdentifier())
2212       return TT_BinaryOperator;
2213 
2214     // "&&(" is quite unlikely to be two successive unary "&".
2215     if (Tok.is(tok::ampamp) && NextToken->is(tok::l_paren))
2216       return TT_BinaryOperator;
2217 
2218     // This catches some cases where evaluation order is used as control flow:
2219     //   aaa && aaa->f();
2220     if (NextToken->Tok.isAnyIdentifier()) {
2221       const FormatToken *NextNextToken = NextToken->getNextNonComment();
2222       if (NextNextToken && NextNextToken->is(tok::arrow))
2223         return TT_BinaryOperator;
2224     }
2225 
2226     // It is very unlikely that we are going to find a pointer or reference type
2227     // definition on the RHS of an assignment.
2228     if (IsExpression && !Contexts.back().CaretFound)
2229       return TT_BinaryOperator;
2230 
2231     return TT_PointerOrReference;
2232   }
2233 
2234   TokenType determinePlusMinusCaretUsage(const FormatToken &Tok) {
2235     const FormatToken *PrevToken = Tok.getPreviousNonComment();
2236     if (!PrevToken)
2237       return TT_UnaryOperator;
2238 
2239     if (PrevToken->isOneOf(TT_CastRParen, TT_UnaryOperator))
2240       // This must be a sequence of leading unary operators.
2241       return TT_UnaryOperator;
2242 
2243     // Use heuristics to recognize unary operators.
2244     if (PrevToken->isOneOf(tok::equal, tok::l_paren, tok::comma, tok::l_square,
2245                            tok::question, tok::colon, tok::kw_return,
2246                            tok::kw_case, tok::at, tok::l_brace, tok::kw_throw,
2247                            tok::kw_co_return, tok::kw_co_yield))
2248       return TT_UnaryOperator;
2249 
2250     // There can't be two consecutive binary operators.
2251     if (PrevToken->is(TT_BinaryOperator))
2252       return TT_UnaryOperator;
2253 
2254     // Fall back to marking the token as binary operator.
2255     return TT_BinaryOperator;
2256   }
2257 
2258   /// Determine whether ++/-- are pre- or post-increments/-decrements.
2259   TokenType determineIncrementUsage(const FormatToken &Tok) {
2260     const FormatToken *PrevToken = Tok.getPreviousNonComment();
2261     if (!PrevToken || PrevToken->is(TT_CastRParen))
2262       return TT_UnaryOperator;
2263     if (PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::identifier))
2264       return TT_TrailingUnaryOperator;
2265 
2266     return TT_UnaryOperator;
2267   }
2268 
2269   SmallVector<Context, 8> Contexts;
2270 
2271   const FormatStyle &Style;
2272   AnnotatedLine &Line;
2273   FormatToken *CurrentToken;
2274   bool AutoFound;
2275   const AdditionalKeywords &Keywords;
2276 
2277   // Set of "<" tokens that do not open a template parameter list. If parseAngle
2278   // determines that a specific token can't be a template opener, it will make
2279   // same decision irrespective of the decisions for tokens leading up to it.
2280   // Store this information to prevent this from causing exponential runtime.
2281   llvm::SmallPtrSet<FormatToken *, 16> NonTemplateLess;
2282 };
2283 
2284 static const int PrecedenceUnaryOperator = prec::PointerToMember + 1;
2285 static const int PrecedenceArrowAndPeriod = prec::PointerToMember + 2;
2286 
2287 /// Parses binary expressions by inserting fake parenthesis based on
2288 /// operator precedence.
2289 class ExpressionParser {
2290 public:
2291   ExpressionParser(const FormatStyle &Style, const AdditionalKeywords &Keywords,
2292                    AnnotatedLine &Line)
2293       : Style(Style), Keywords(Keywords), Line(Line), Current(Line.First) {}
2294 
2295   /// Parse expressions with the given operator precedence.
2296   void parse(int Precedence = 0) {
2297     // Skip 'return' and ObjC selector colons as they are not part of a binary
2298     // expression.
2299     while (Current && (Current->is(tok::kw_return) ||
2300                        (Current->is(tok::colon) &&
2301                         Current->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral))))
2302       next();
2303 
2304     if (!Current || Precedence > PrecedenceArrowAndPeriod)
2305       return;
2306 
2307     // Conditional expressions need to be parsed separately for proper nesting.
2308     if (Precedence == prec::Conditional) {
2309       parseConditionalExpr();
2310       return;
2311     }
2312 
2313     // Parse unary operators, which all have a higher precedence than binary
2314     // operators.
2315     if (Precedence == PrecedenceUnaryOperator) {
2316       parseUnaryOperator();
2317       return;
2318     }
2319 
2320     FormatToken *Start = Current;
2321     FormatToken *LatestOperator = nullptr;
2322     unsigned OperatorIndex = 0;
2323 
2324     while (Current) {
2325       // Consume operators with higher precedence.
2326       parse(Precedence + 1);
2327 
2328       int CurrentPrecedence = getCurrentPrecedence();
2329 
2330       if (Precedence == CurrentPrecedence && Current &&
2331           Current->is(TT_SelectorName)) {
2332         if (LatestOperator)
2333           addFakeParenthesis(Start, prec::Level(Precedence));
2334         Start = Current;
2335       }
2336 
2337       // At the end of the line or when an operator with higher precedence is
2338       // found, insert fake parenthesis and return.
2339       if (!Current ||
2340           (Current->closesScope() &&
2341            (Current->MatchingParen || Current->is(TT_TemplateString))) ||
2342           (CurrentPrecedence != -1 && CurrentPrecedence < Precedence) ||
2343           (CurrentPrecedence == prec::Conditional &&
2344            Precedence == prec::Assignment && Current->is(tok::colon)))
2345         break;
2346 
2347       // Consume scopes: (), [], <> and {}
2348       // In addition to that we handle require clauses as scope, so that the
2349       // constraints in that are correctly indented.
2350       if (Current->opensScope() ||
2351           Current->isOneOf(TT_RequiresClause,
2352                            TT_RequiresClauseInARequiresExpression)) {
2353         // In fragment of a JavaScript template string can look like '}..${' and
2354         // thus close a scope and open a new one at the same time.
2355         while (Current && (!Current->closesScope() || Current->opensScope())) {
2356           next();
2357           parse();
2358         }
2359         next();
2360       } else {
2361         // Operator found.
2362         if (CurrentPrecedence == Precedence) {
2363           if (LatestOperator)
2364             LatestOperator->NextOperator = Current;
2365           LatestOperator = Current;
2366           Current->OperatorIndex = OperatorIndex;
2367           ++OperatorIndex;
2368         }
2369         next(/*SkipPastLeadingComments=*/Precedence > 0);
2370       }
2371     }
2372 
2373     if (LatestOperator && (Current || Precedence > 0)) {
2374       // The requires clauses do not neccessarily end in a semicolon or a brace,
2375       // but just go over to struct/class or a function declaration, we need to
2376       // intervene so that the fake right paren is inserted correctly.
2377       auto End =
2378           (Start->Previous &&
2379            Start->Previous->isOneOf(TT_RequiresClause,
2380                                     TT_RequiresClauseInARequiresExpression))
2381               ? [this](){
2382                   auto Ret = Current ? Current : Line.Last;
2383                   while (!Ret->ClosesRequiresClause && Ret->Previous)
2384                     Ret = Ret->Previous;
2385                   return Ret;
2386                 }()
2387               : nullptr;
2388 
2389       if (Precedence == PrecedenceArrowAndPeriod) {
2390         // Call expressions don't have a binary operator precedence.
2391         addFakeParenthesis(Start, prec::Unknown, End);
2392       } else {
2393         addFakeParenthesis(Start, prec::Level(Precedence), End);
2394       }
2395     }
2396   }
2397 
2398 private:
2399   /// Gets the precedence (+1) of the given token for binary operators
2400   /// and other tokens that we treat like binary operators.
2401   int getCurrentPrecedence() {
2402     if (Current) {
2403       const FormatToken *NextNonComment = Current->getNextNonComment();
2404       if (Current->is(TT_ConditionalExpr))
2405         return prec::Conditional;
2406       if (NextNonComment && Current->is(TT_SelectorName) &&
2407           (NextNonComment->isOneOf(TT_DictLiteral, TT_JsTypeColon) ||
2408            ((Style.Language == FormatStyle::LK_Proto ||
2409              Style.Language == FormatStyle::LK_TextProto) &&
2410             NextNonComment->is(tok::less))))
2411         return prec::Assignment;
2412       if (Current->is(TT_JsComputedPropertyName))
2413         return prec::Assignment;
2414       if (Current->is(TT_LambdaArrow))
2415         return prec::Comma;
2416       if (Current->is(TT_FatArrow))
2417         return prec::Assignment;
2418       if (Current->isOneOf(tok::semi, TT_InlineASMColon, TT_SelectorName) ||
2419           (Current->is(tok::comment) && NextNonComment &&
2420            NextNonComment->is(TT_SelectorName)))
2421         return 0;
2422       if (Current->is(TT_RangeBasedForLoopColon))
2423         return prec::Comma;
2424       if ((Style.Language == FormatStyle::LK_Java || Style.isJavaScript()) &&
2425           Current->is(Keywords.kw_instanceof))
2426         return prec::Relational;
2427       if (Style.isJavaScript() &&
2428           Current->isOneOf(Keywords.kw_in, Keywords.kw_as))
2429         return prec::Relational;
2430       if (Current->is(TT_BinaryOperator) || Current->is(tok::comma))
2431         return Current->getPrecedence();
2432       if (Current->isOneOf(tok::period, tok::arrow))
2433         return PrecedenceArrowAndPeriod;
2434       if ((Style.Language == FormatStyle::LK_Java || Style.isJavaScript()) &&
2435           Current->isOneOf(Keywords.kw_extends, Keywords.kw_implements,
2436                            Keywords.kw_throws))
2437         return 0;
2438     }
2439     return -1;
2440   }
2441 
2442   void addFakeParenthesis(FormatToken *Start, prec::Level Precedence,
2443                           FormatToken *End = nullptr) {
2444     Start->FakeLParens.push_back(Precedence);
2445     if (Precedence > prec::Unknown)
2446       Start->StartsBinaryExpression = true;
2447     if (!End && Current)
2448       End = Current->getPreviousNonComment();
2449     if (End) {
2450       ++End->FakeRParens;
2451       if (Precedence > prec::Unknown)
2452         End->EndsBinaryExpression = true;
2453     }
2454   }
2455 
2456   /// Parse unary operator expressions and surround them with fake
2457   /// parentheses if appropriate.
2458   void parseUnaryOperator() {
2459     llvm::SmallVector<FormatToken *, 2> Tokens;
2460     while (Current && Current->is(TT_UnaryOperator)) {
2461       Tokens.push_back(Current);
2462       next();
2463     }
2464     parse(PrecedenceArrowAndPeriod);
2465     for (FormatToken *Token : llvm::reverse(Tokens))
2466       // The actual precedence doesn't matter.
2467       addFakeParenthesis(Token, prec::Unknown);
2468   }
2469 
2470   void parseConditionalExpr() {
2471     while (Current && Current->isTrailingComment())
2472       next();
2473     FormatToken *Start = Current;
2474     parse(prec::LogicalOr);
2475     if (!Current || !Current->is(tok::question))
2476       return;
2477     next();
2478     parse(prec::Assignment);
2479     if (!Current || Current->isNot(TT_ConditionalExpr))
2480       return;
2481     next();
2482     parse(prec::Assignment);
2483     addFakeParenthesis(Start, prec::Conditional);
2484   }
2485 
2486   void next(bool SkipPastLeadingComments = true) {
2487     if (Current)
2488       Current = Current->Next;
2489     while (Current &&
2490            (Current->NewlinesBefore == 0 || SkipPastLeadingComments) &&
2491            Current->isTrailingComment())
2492       Current = Current->Next;
2493   }
2494 
2495   const FormatStyle &Style;
2496   const AdditionalKeywords &Keywords;
2497   const AnnotatedLine &Line;
2498   FormatToken *Current;
2499 };
2500 
2501 } // end anonymous namespace
2502 
2503 void TokenAnnotator::setCommentLineLevels(
2504     SmallVectorImpl<AnnotatedLine *> &Lines) {
2505   const AnnotatedLine *NextNonCommentLine = nullptr;
2506   for (AnnotatedLine *Line : llvm::reverse(Lines)) {
2507     assert(Line->First);
2508 
2509     // If the comment is currently aligned with the line immediately following
2510     // it, that's probably intentional and we should keep it.
2511     if (NextNonCommentLine && Line->isComment() &&
2512         NextNonCommentLine->First->NewlinesBefore <= 1 &&
2513         NextNonCommentLine->First->OriginalColumn ==
2514             Line->First->OriginalColumn) {
2515       // Align comments for preprocessor lines with the # in column 0 if
2516       // preprocessor lines are not indented. Otherwise, align with the next
2517       // line.
2518       Line->Level =
2519           (Style.IndentPPDirectives != FormatStyle::PPDIS_BeforeHash &&
2520            (NextNonCommentLine->Type == LT_PreprocessorDirective ||
2521             NextNonCommentLine->Type == LT_ImportStatement))
2522               ? 0
2523               : NextNonCommentLine->Level;
2524     } else {
2525       NextNonCommentLine = Line->First->isNot(tok::r_brace) ? Line : nullptr;
2526     }
2527 
2528     setCommentLineLevels(Line->Children);
2529   }
2530 }
2531 
2532 static unsigned maxNestingDepth(const AnnotatedLine &Line) {
2533   unsigned Result = 0;
2534   for (const auto *Tok = Line.First; Tok != nullptr; Tok = Tok->Next)
2535     Result = std::max(Result, Tok->NestingLevel);
2536   return Result;
2537 }
2538 
2539 void TokenAnnotator::annotate(AnnotatedLine &Line) {
2540   for (auto &Child : Line.Children)
2541     annotate(*Child);
2542 
2543   AnnotatingParser Parser(Style, Line, Keywords);
2544   Line.Type = Parser.parseLine();
2545 
2546   // With very deep nesting, ExpressionParser uses lots of stack and the
2547   // formatting algorithm is very slow. We're not going to do a good job here
2548   // anyway - it's probably generated code being formatted by mistake.
2549   // Just skip the whole line.
2550   if (maxNestingDepth(Line) > 50)
2551     Line.Type = LT_Invalid;
2552 
2553   if (Line.Type == LT_Invalid)
2554     return;
2555 
2556   ExpressionParser ExprParser(Style, Keywords, Line);
2557   ExprParser.parse();
2558 
2559   if (Line.startsWith(TT_ObjCMethodSpecifier))
2560     Line.Type = LT_ObjCMethodDecl;
2561   else if (Line.startsWith(TT_ObjCDecl))
2562     Line.Type = LT_ObjCDecl;
2563   else if (Line.startsWith(TT_ObjCProperty))
2564     Line.Type = LT_ObjCProperty;
2565 
2566   Line.First->SpacesRequiredBefore = 1;
2567   Line.First->CanBreakBefore = Line.First->MustBreakBefore;
2568 }
2569 
2570 // This function heuristically determines whether 'Current' starts the name of a
2571 // function declaration.
2572 static bool isFunctionDeclarationName(bool IsCpp, const FormatToken &Current,
2573                                       const AnnotatedLine &Line) {
2574   auto skipOperatorName = [](const FormatToken *Next) -> const FormatToken * {
2575     for (; Next; Next = Next->Next) {
2576       if (Next->is(TT_OverloadedOperatorLParen))
2577         return Next;
2578       if (Next->is(TT_OverloadedOperator))
2579         continue;
2580       if (Next->isOneOf(tok::kw_new, tok::kw_delete)) {
2581         // For 'new[]' and 'delete[]'.
2582         if (Next->Next &&
2583             Next->Next->startsSequence(tok::l_square, tok::r_square))
2584           Next = Next->Next->Next;
2585         continue;
2586       }
2587       if (Next->startsSequence(tok::l_square, tok::r_square)) {
2588         // For operator[]().
2589         Next = Next->Next;
2590         continue;
2591       }
2592       if ((Next->isSimpleTypeSpecifier() || Next->is(tok::identifier)) &&
2593           Next->Next && Next->Next->isOneOf(tok::star, tok::amp, tok::ampamp)) {
2594         // For operator void*(), operator char*(), operator Foo*().
2595         Next = Next->Next;
2596         continue;
2597       }
2598       if (Next->is(TT_TemplateOpener) && Next->MatchingParen) {
2599         Next = Next->MatchingParen;
2600         continue;
2601       }
2602 
2603       break;
2604     }
2605     return nullptr;
2606   };
2607 
2608   // Find parentheses of parameter list.
2609   const FormatToken *Next = Current.Next;
2610   if (Current.is(tok::kw_operator)) {
2611     if (Current.Previous && Current.Previous->is(tok::coloncolon))
2612       return false;
2613     Next = skipOperatorName(Next);
2614   } else {
2615     if (!Current.is(TT_StartOfName) || Current.NestingLevel != 0)
2616       return false;
2617     for (; Next; Next = Next->Next) {
2618       if (Next->is(TT_TemplateOpener)) {
2619         Next = Next->MatchingParen;
2620       } else if (Next->is(tok::coloncolon)) {
2621         Next = Next->Next;
2622         if (!Next)
2623           return false;
2624         if (Next->is(tok::kw_operator)) {
2625           Next = skipOperatorName(Next->Next);
2626           break;
2627         }
2628         if (!Next->is(tok::identifier))
2629           return false;
2630       } else if (Next->is(tok::l_paren)) {
2631         break;
2632       } else {
2633         return false;
2634       }
2635     }
2636   }
2637 
2638   // Check whether parameter list can belong to a function declaration.
2639   if (!Next || !Next->is(tok::l_paren) || !Next->MatchingParen)
2640     return false;
2641   // If the lines ends with "{", this is likely a function definition.
2642   if (Line.Last->is(tok::l_brace))
2643     return true;
2644   if (Next->Next == Next->MatchingParen)
2645     return true; // Empty parentheses.
2646   // If there is an &/&& after the r_paren, this is likely a function.
2647   if (Next->MatchingParen->Next &&
2648       Next->MatchingParen->Next->is(TT_PointerOrReference))
2649     return true;
2650 
2651   // Check for K&R C function definitions (and C++ function definitions with
2652   // unnamed parameters), e.g.:
2653   //   int f(i)
2654   //   {
2655   //     return i + 1;
2656   //   }
2657   //   bool g(size_t = 0, bool b = false)
2658   //   {
2659   //     return !b;
2660   //   }
2661   if (IsCpp && Next->Next && Next->Next->is(tok::identifier) &&
2662       !Line.endsWith(tok::semi))
2663     return true;
2664 
2665   for (const FormatToken *Tok = Next->Next; Tok && Tok != Next->MatchingParen;
2666        Tok = Tok->Next) {
2667     if (Tok->is(TT_TypeDeclarationParen))
2668       return true;
2669     if (Tok->isOneOf(tok::l_paren, TT_TemplateOpener) && Tok->MatchingParen) {
2670       Tok = Tok->MatchingParen;
2671       continue;
2672     }
2673     if (Tok->is(tok::kw_const) || Tok->isSimpleTypeSpecifier() ||
2674         Tok->isOneOf(TT_PointerOrReference, TT_StartOfName, tok::ellipsis))
2675       return true;
2676     if (Tok->isOneOf(tok::l_brace, tok::string_literal, TT_ObjCMethodExpr) ||
2677         Tok->Tok.isLiteral())
2678       return false;
2679   }
2680   return false;
2681 }
2682 
2683 bool TokenAnnotator::mustBreakForReturnType(const AnnotatedLine &Line) const {
2684   assert(Line.MightBeFunctionDecl);
2685 
2686   if ((Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_TopLevel ||
2687        Style.AlwaysBreakAfterReturnType ==
2688            FormatStyle::RTBS_TopLevelDefinitions) &&
2689       Line.Level > 0)
2690     return false;
2691 
2692   switch (Style.AlwaysBreakAfterReturnType) {
2693   case FormatStyle::RTBS_None:
2694     return false;
2695   case FormatStyle::RTBS_All:
2696   case FormatStyle::RTBS_TopLevel:
2697     return true;
2698   case FormatStyle::RTBS_AllDefinitions:
2699   case FormatStyle::RTBS_TopLevelDefinitions:
2700     return Line.mightBeFunctionDefinition();
2701   }
2702 
2703   return false;
2704 }
2705 
2706 void TokenAnnotator::calculateFormattingInformation(AnnotatedLine &Line) {
2707   for (AnnotatedLine *ChildLine : Line.Children)
2708     calculateFormattingInformation(*ChildLine);
2709 
2710   Line.First->TotalLength =
2711       Line.First->IsMultiline ? Style.ColumnLimit
2712                               : Line.FirstStartColumn + Line.First->ColumnWidth;
2713   FormatToken *Current = Line.First->Next;
2714   bool InFunctionDecl = Line.MightBeFunctionDecl;
2715   bool AlignArrayOfStructures =
2716       (Style.AlignArrayOfStructures != FormatStyle::AIAS_None &&
2717        Line.Type == LT_ArrayOfStructInitializer);
2718   if (AlignArrayOfStructures)
2719     calculateArrayInitializerColumnList(Line);
2720 
2721   while (Current) {
2722     if (isFunctionDeclarationName(Style.isCpp(), *Current, Line))
2723       Current->setType(TT_FunctionDeclarationName);
2724     const FormatToken *Prev = Current->Previous;
2725     if (Current->is(TT_LineComment)) {
2726       if (Prev->is(BK_BracedInit) && Prev->opensScope())
2727         Current->SpacesRequiredBefore =
2728             (Style.Cpp11BracedListStyle && !Style.SpacesInParentheses) ? 0 : 1;
2729       else
2730         Current->SpacesRequiredBefore = Style.SpacesBeforeTrailingComments;
2731 
2732       // If we find a trailing comment, iterate backwards to determine whether
2733       // it seems to relate to a specific parameter. If so, break before that
2734       // parameter to avoid changing the comment's meaning. E.g. don't move 'b'
2735       // to the previous line in:
2736       //   SomeFunction(a,
2737       //                b, // comment
2738       //                c);
2739       if (!Current->HasUnescapedNewline) {
2740         for (FormatToken *Parameter = Current->Previous; Parameter;
2741              Parameter = Parameter->Previous) {
2742           if (Parameter->isOneOf(tok::comment, tok::r_brace))
2743             break;
2744           if (Parameter->Previous && Parameter->Previous->is(tok::comma)) {
2745             if (!Parameter->Previous->is(TT_CtorInitializerComma) &&
2746                 Parameter->HasUnescapedNewline)
2747               Parameter->MustBreakBefore = true;
2748             break;
2749           }
2750         }
2751       }
2752     } else if (Current->SpacesRequiredBefore == 0 &&
2753                spaceRequiredBefore(Line, *Current)) {
2754       Current->SpacesRequiredBefore = 1;
2755     }
2756 
2757     const auto &Children = Prev->Children;
2758     if (!Children.empty() && Children.back()->Last->is(TT_LineComment)) {
2759       Current->MustBreakBefore = true;
2760     } else {
2761       Current->MustBreakBefore =
2762           Current->MustBreakBefore || mustBreakBefore(Line, *Current);
2763       if (!Current->MustBreakBefore && InFunctionDecl &&
2764           Current->is(TT_FunctionDeclarationName))
2765         Current->MustBreakBefore = mustBreakForReturnType(Line);
2766     }
2767 
2768     Current->CanBreakBefore =
2769         Current->MustBreakBefore || canBreakBefore(Line, *Current);
2770     unsigned ChildSize = 0;
2771     if (Prev->Children.size() == 1) {
2772       FormatToken &LastOfChild = *Prev->Children[0]->Last;
2773       ChildSize = LastOfChild.isTrailingComment() ? Style.ColumnLimit
2774                                                   : LastOfChild.TotalLength + 1;
2775     }
2776     if (Current->MustBreakBefore || Prev->Children.size() > 1 ||
2777         (Prev->Children.size() == 1 &&
2778          Prev->Children[0]->First->MustBreakBefore) ||
2779         Current->IsMultiline)
2780       Current->TotalLength = Prev->TotalLength + Style.ColumnLimit;
2781     else
2782       Current->TotalLength = Prev->TotalLength + Current->ColumnWidth +
2783                              ChildSize + Current->SpacesRequiredBefore;
2784 
2785     if (Current->is(TT_CtorInitializerColon))
2786       InFunctionDecl = false;
2787 
2788     // FIXME: Only calculate this if CanBreakBefore is true once static
2789     // initializers etc. are sorted out.
2790     // FIXME: Move magic numbers to a better place.
2791 
2792     // Reduce penalty for aligning ObjC method arguments using the colon
2793     // alignment as this is the canonical way (still prefer fitting everything
2794     // into one line if possible). Trying to fit a whole expression into one
2795     // line should not force other line breaks (e.g. when ObjC method
2796     // expression is a part of other expression).
2797     Current->SplitPenalty = splitPenalty(Line, *Current, InFunctionDecl);
2798     if (Style.Language == FormatStyle::LK_ObjC &&
2799         Current->is(TT_SelectorName) && Current->ParameterIndex > 0) {
2800       if (Current->ParameterIndex == 1)
2801         Current->SplitPenalty += 5 * Current->BindingStrength;
2802     } else {
2803       Current->SplitPenalty += 20 * Current->BindingStrength;
2804     }
2805 
2806     Current = Current->Next;
2807   }
2808 
2809   calculateUnbreakableTailLengths(Line);
2810   unsigned IndentLevel = Line.Level;
2811   for (Current = Line.First; Current != nullptr; Current = Current->Next) {
2812     if (Current->Role)
2813       Current->Role->precomputeFormattingInfos(Current);
2814     if (Current->MatchingParen &&
2815         Current->MatchingParen->opensBlockOrBlockTypeList(Style) &&
2816         IndentLevel > 0)
2817       --IndentLevel;
2818     Current->IndentLevel = IndentLevel;
2819     if (Current->opensBlockOrBlockTypeList(Style))
2820       ++IndentLevel;
2821   }
2822 
2823   LLVM_DEBUG({ printDebugInfo(Line); });
2824 }
2825 
2826 void TokenAnnotator::calculateUnbreakableTailLengths(AnnotatedLine &Line) {
2827   unsigned UnbreakableTailLength = 0;
2828   FormatToken *Current = Line.Last;
2829   while (Current) {
2830     Current->UnbreakableTailLength = UnbreakableTailLength;
2831     if (Current->CanBreakBefore ||
2832         Current->isOneOf(tok::comment, tok::string_literal)) {
2833       UnbreakableTailLength = 0;
2834     } else {
2835       UnbreakableTailLength +=
2836           Current->ColumnWidth + Current->SpacesRequiredBefore;
2837     }
2838     Current = Current->Previous;
2839   }
2840 }
2841 
2842 void TokenAnnotator::calculateArrayInitializerColumnList(AnnotatedLine &Line) {
2843   if (Line.First == Line.Last)
2844     return;
2845   auto *CurrentToken = Line.First;
2846   CurrentToken->ArrayInitializerLineStart = true;
2847   unsigned Depth = 0;
2848   while (CurrentToken != nullptr && CurrentToken != Line.Last) {
2849     if (CurrentToken->is(tok::l_brace)) {
2850       CurrentToken->IsArrayInitializer = true;
2851       if (CurrentToken->Next != nullptr)
2852         CurrentToken->Next->MustBreakBefore = true;
2853       CurrentToken =
2854           calculateInitializerColumnList(Line, CurrentToken->Next, Depth + 1);
2855     } else {
2856       CurrentToken = CurrentToken->Next;
2857     }
2858   }
2859 }
2860 
2861 FormatToken *TokenAnnotator::calculateInitializerColumnList(
2862     AnnotatedLine &Line, FormatToken *CurrentToken, unsigned Depth) {
2863   while (CurrentToken != nullptr && CurrentToken != Line.Last) {
2864     if (CurrentToken->is(tok::l_brace))
2865       ++Depth;
2866     else if (CurrentToken->is(tok::r_brace))
2867       --Depth;
2868     if (Depth == 2 && CurrentToken->isOneOf(tok::l_brace, tok::comma)) {
2869       CurrentToken = CurrentToken->Next;
2870       if (CurrentToken == nullptr)
2871         break;
2872       CurrentToken->StartsColumn = true;
2873       CurrentToken = CurrentToken->Previous;
2874     }
2875     CurrentToken = CurrentToken->Next;
2876   }
2877   return CurrentToken;
2878 }
2879 
2880 unsigned TokenAnnotator::splitPenalty(const AnnotatedLine &Line,
2881                                       const FormatToken &Tok,
2882                                       bool InFunctionDecl) {
2883   const FormatToken &Left = *Tok.Previous;
2884   const FormatToken &Right = Tok;
2885 
2886   if (Left.is(tok::semi))
2887     return 0;
2888 
2889   if (Style.Language == FormatStyle::LK_Java) {
2890     if (Right.isOneOf(Keywords.kw_extends, Keywords.kw_throws))
2891       return 1;
2892     if (Right.is(Keywords.kw_implements))
2893       return 2;
2894     if (Left.is(tok::comma) && Left.NestingLevel == 0)
2895       return 3;
2896   } else if (Style.isJavaScript()) {
2897     if (Right.is(Keywords.kw_function) && Left.isNot(tok::comma))
2898       return 100;
2899     if (Left.is(TT_JsTypeColon))
2900       return 35;
2901     if ((Left.is(TT_TemplateString) && Left.TokenText.endswith("${")) ||
2902         (Right.is(TT_TemplateString) && Right.TokenText.startswith("}")))
2903       return 100;
2904     // Prefer breaking call chains (".foo") over empty "{}", "[]" or "()".
2905     if (Left.opensScope() && Right.closesScope())
2906       return 200;
2907   }
2908 
2909   if (Right.is(tok::identifier) && Right.Next && Right.Next->is(TT_DictLiteral))
2910     return 1;
2911   if (Right.is(tok::l_square)) {
2912     if (Style.Language == FormatStyle::LK_Proto)
2913       return 1;
2914     if (Left.is(tok::r_square))
2915       return 200;
2916     // Slightly prefer formatting local lambda definitions like functions.
2917     if (Right.is(TT_LambdaLSquare) && Left.is(tok::equal))
2918       return 35;
2919     if (!Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare,
2920                        TT_ArrayInitializerLSquare,
2921                        TT_DesignatedInitializerLSquare, TT_AttributeSquare))
2922       return 500;
2923   }
2924 
2925   if (Left.is(tok::coloncolon) ||
2926       (Right.is(tok::period) && Style.Language == FormatStyle::LK_Proto))
2927     return 500;
2928   if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
2929       Right.is(tok::kw_operator)) {
2930     if (Line.startsWith(tok::kw_for) && Right.PartOfMultiVariableDeclStmt)
2931       return 3;
2932     if (Left.is(TT_StartOfName))
2933       return 110;
2934     if (InFunctionDecl && Right.NestingLevel == 0)
2935       return Style.PenaltyReturnTypeOnItsOwnLine;
2936     return 200;
2937   }
2938   if (Right.is(TT_PointerOrReference))
2939     return 190;
2940   if (Right.is(TT_LambdaArrow))
2941     return 110;
2942   if (Left.is(tok::equal) && Right.is(tok::l_brace))
2943     return 160;
2944   if (Left.is(TT_CastRParen))
2945     return 100;
2946   if (Left.isOneOf(tok::kw_class, tok::kw_struct))
2947     return 5000;
2948   if (Left.is(tok::comment))
2949     return 1000;
2950 
2951   if (Left.isOneOf(TT_RangeBasedForLoopColon, TT_InheritanceColon,
2952                    TT_CtorInitializerColon))
2953     return 2;
2954 
2955   if (Right.isMemberAccess()) {
2956     // Breaking before the "./->" of a chained call/member access is reasonably
2957     // cheap, as formatting those with one call per line is generally
2958     // desirable. In particular, it should be cheaper to break before the call
2959     // than it is to break inside a call's parameters, which could lead to weird
2960     // "hanging" indents. The exception is the very last "./->" to support this
2961     // frequent pattern:
2962     //
2963     //   aaaaaaaa.aaaaaaaa.bbbbbbb().ccccccccccccccccccccc(
2964     //       dddddddd);
2965     //
2966     // which might otherwise be blown up onto many lines. Here, clang-format
2967     // won't produce "hanging" indents anyway as there is no other trailing
2968     // call.
2969     //
2970     // Also apply higher penalty is not a call as that might lead to a wrapping
2971     // like:
2972     //
2973     //   aaaaaaa
2974     //       .aaaaaaaaa.bbbbbbbb(cccccccc);
2975     return !Right.NextOperator || !Right.NextOperator->Previous->closesScope()
2976                ? 150
2977                : 35;
2978   }
2979 
2980   if (Right.is(TT_TrailingAnnotation) &&
2981       (!Right.Next || Right.Next->isNot(tok::l_paren))) {
2982     // Moving trailing annotations to the next line is fine for ObjC method
2983     // declarations.
2984     if (Line.startsWith(TT_ObjCMethodSpecifier))
2985       return 10;
2986     // Generally, breaking before a trailing annotation is bad unless it is
2987     // function-like. It seems to be especially preferable to keep standard
2988     // annotations (i.e. "const", "final" and "override") on the same line.
2989     // Use a slightly higher penalty after ")" so that annotations like
2990     // "const override" are kept together.
2991     bool is_short_annotation = Right.TokenText.size() < 10;
2992     return (Left.is(tok::r_paren) ? 100 : 120) + (is_short_annotation ? 50 : 0);
2993   }
2994 
2995   // In for-loops, prefer breaking at ',' and ';'.
2996   if (Line.startsWith(tok::kw_for) && Left.is(tok::equal))
2997     return 4;
2998 
2999   // In Objective-C method expressions, prefer breaking before "param:" over
3000   // breaking after it.
3001   if (Right.is(TT_SelectorName))
3002     return 0;
3003   if (Left.is(tok::colon) && Left.is(TT_ObjCMethodExpr))
3004     return Line.MightBeFunctionDecl ? 50 : 500;
3005 
3006   // In Objective-C type declarations, avoid breaking after the category's
3007   // open paren (we'll prefer breaking after the protocol list's opening
3008   // angle bracket, if present).
3009   if (Line.Type == LT_ObjCDecl && Left.is(tok::l_paren) && Left.Previous &&
3010       Left.Previous->isOneOf(tok::identifier, tok::greater))
3011     return 500;
3012 
3013   if (Left.is(tok::l_paren) && Style.PenaltyBreakOpenParenthesis != 0)
3014     return Style.PenaltyBreakOpenParenthesis;
3015   if (Left.is(tok::l_paren) && InFunctionDecl &&
3016       Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign)
3017     return 100;
3018   if (Left.is(tok::l_paren) && Left.Previous &&
3019       (Left.Previous->is(tok::kw_for) || Left.Previous->isIf()))
3020     return 1000;
3021   if (Left.is(tok::equal) && InFunctionDecl)
3022     return 110;
3023   if (Right.is(tok::r_brace))
3024     return 1;
3025   if (Left.is(TT_TemplateOpener))
3026     return 100;
3027   if (Left.opensScope()) {
3028     // If we aren't aligning after opening parens/braces we can always break
3029     // here unless the style does not want us to place all arguments on the
3030     // next line.
3031     if (Style.AlignAfterOpenBracket == FormatStyle::BAS_DontAlign &&
3032         (Left.ParameterCount <= 1 || Style.AllowAllArgumentsOnNextLine))
3033       return 0;
3034     if (Left.is(tok::l_brace) && !Style.Cpp11BracedListStyle)
3035       return 19;
3036     return Left.ParameterCount > 1 ? Style.PenaltyBreakBeforeFirstCallParameter
3037                                    : 19;
3038   }
3039   if (Left.is(TT_JavaAnnotation))
3040     return 50;
3041 
3042   if (Left.is(TT_UnaryOperator))
3043     return 60;
3044   if (Left.isOneOf(tok::plus, tok::comma) && Left.Previous &&
3045       Left.Previous->isLabelString() &&
3046       (Left.NextOperator || Left.OperatorIndex != 0))
3047     return 50;
3048   if (Right.is(tok::plus) && Left.isLabelString() &&
3049       (Right.NextOperator || Right.OperatorIndex != 0))
3050     return 25;
3051   if (Left.is(tok::comma))
3052     return 1;
3053   if (Right.is(tok::lessless) && Left.isLabelString() &&
3054       (Right.NextOperator || Right.OperatorIndex != 1))
3055     return 25;
3056   if (Right.is(tok::lessless)) {
3057     // Breaking at a << is really cheap.
3058     if (!Left.is(tok::r_paren) || Right.OperatorIndex > 0)
3059       // Slightly prefer to break before the first one in log-like statements.
3060       return 2;
3061     return 1;
3062   }
3063   if (Left.ClosesTemplateDeclaration)
3064     return Style.PenaltyBreakTemplateDeclaration;
3065   if (Left.ClosesRequiresClause)
3066     return 0;
3067   if (Left.is(TT_ConditionalExpr))
3068     return prec::Conditional;
3069   prec::Level Level = Left.getPrecedence();
3070   if (Level == prec::Unknown)
3071     Level = Right.getPrecedence();
3072   if (Level == prec::Assignment)
3073     return Style.PenaltyBreakAssignment;
3074   if (Level != prec::Unknown)
3075     return Level;
3076 
3077   return 3;
3078 }
3079 
3080 bool TokenAnnotator::spaceRequiredBeforeParens(const FormatToken &Right) const {
3081   if (Style.SpaceBeforeParens == FormatStyle::SBPO_Always)
3082     return true;
3083   if (Right.is(TT_OverloadedOperatorLParen) &&
3084       Style.SpaceBeforeParensOptions.AfterOverloadedOperator)
3085     return true;
3086   if (Style.SpaceBeforeParensOptions.BeforeNonEmptyParentheses &&
3087       Right.ParameterCount > 0)
3088     return true;
3089   return false;
3090 }
3091 
3092 bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
3093                                           const FormatToken &Left,
3094                                           const FormatToken &Right) {
3095   if (Left.is(tok::kw_return) &&
3096       !Right.isOneOf(tok::semi, tok::r_paren, tok::hashhash))
3097     return true;
3098   if (Style.isJson() && Left.is(tok::string_literal) && Right.is(tok::colon))
3099     return false;
3100   if (Left.is(Keywords.kw_assert) && Style.Language == FormatStyle::LK_Java)
3101     return true;
3102   if (Style.ObjCSpaceAfterProperty && Line.Type == LT_ObjCProperty &&
3103       Left.Tok.getObjCKeywordID() == tok::objc_property)
3104     return true;
3105   if (Right.is(tok::hashhash))
3106     return Left.is(tok::hash);
3107   if (Left.isOneOf(tok::hashhash, tok::hash))
3108     return Right.is(tok::hash);
3109   if ((Left.is(tok::l_paren) && Right.is(tok::r_paren)) ||
3110       (Left.is(tok::l_brace) && Left.isNot(BK_Block) &&
3111        Right.is(tok::r_brace) && Right.isNot(BK_Block)))
3112     return Style.SpaceInEmptyParentheses;
3113   if (Style.SpacesInConditionalStatement) {
3114     const FormatToken *LeftParen = nullptr;
3115     if (Left.is(tok::l_paren))
3116       LeftParen = &Left;
3117     else if (Right.is(tok::r_paren) && Right.MatchingParen)
3118       LeftParen = Right.MatchingParen;
3119     if (LeftParen && LeftParen->Previous &&
3120         isKeywordWithCondition(*LeftParen->Previous))
3121       return true;
3122   }
3123 
3124   // auto{x} auto(x)
3125   if (Left.is(tok::kw_auto) && Right.isOneOf(tok::l_paren, tok::l_brace))
3126     return false;
3127 
3128   // operator co_await(x)
3129   if (Right.is(tok::l_paren) && Left.is(tok::kw_co_await) && Left.Previous &&
3130       Left.Previous->is(tok::kw_operator))
3131     return false;
3132   // co_await (x), co_yield (x), co_return (x)
3133   if (Left.isOneOf(tok::kw_co_await, tok::kw_co_yield, tok::kw_co_return) &&
3134       !Right.isOneOf(tok::semi, tok::r_paren))
3135     return true;
3136 
3137   if (Left.is(tok::l_paren) || Right.is(tok::r_paren))
3138     return (Right.is(TT_CastRParen) ||
3139             (Left.MatchingParen && Left.MatchingParen->is(TT_CastRParen)))
3140                ? Style.SpacesInCStyleCastParentheses
3141                : Style.SpacesInParentheses;
3142   if (Right.isOneOf(tok::semi, tok::comma))
3143     return false;
3144   if (Right.is(tok::less) && Line.Type == LT_ObjCDecl) {
3145     bool IsLightweightGeneric = Right.MatchingParen &&
3146                                 Right.MatchingParen->Next &&
3147                                 Right.MatchingParen->Next->is(tok::colon);
3148     return !IsLightweightGeneric && Style.ObjCSpaceBeforeProtocolList;
3149   }
3150   if (Right.is(tok::less) && Left.is(tok::kw_template))
3151     return Style.SpaceAfterTemplateKeyword;
3152   if (Left.isOneOf(tok::exclaim, tok::tilde))
3153     return false;
3154   if (Left.is(tok::at) &&
3155       Right.isOneOf(tok::identifier, tok::string_literal, tok::char_constant,
3156                     tok::numeric_constant, tok::l_paren, tok::l_brace,
3157                     tok::kw_true, tok::kw_false))
3158     return false;
3159   if (Left.is(tok::colon))
3160     return !Left.is(TT_ObjCMethodExpr);
3161   if (Left.is(tok::coloncolon))
3162     return false;
3163   if (Left.is(tok::less) || Right.isOneOf(tok::greater, tok::less)) {
3164     if (Style.Language == FormatStyle::LK_TextProto ||
3165         (Style.Language == FormatStyle::LK_Proto &&
3166          (Left.is(TT_DictLiteral) || Right.is(TT_DictLiteral)))) {
3167       // Format empty list as `<>`.
3168       if (Left.is(tok::less) && Right.is(tok::greater))
3169         return false;
3170       return !Style.Cpp11BracedListStyle;
3171     }
3172     return false;
3173   }
3174   if (Right.is(tok::ellipsis))
3175     return Left.Tok.isLiteral() || (Left.is(tok::identifier) && Left.Previous &&
3176                                     Left.Previous->is(tok::kw_case));
3177   if (Left.is(tok::l_square) && Right.is(tok::amp))
3178     return Style.SpacesInSquareBrackets;
3179   if (Right.is(TT_PointerOrReference)) {
3180     if (Left.is(tok::r_paren) && Line.MightBeFunctionDecl) {
3181       if (!Left.MatchingParen)
3182         return true;
3183       FormatToken *TokenBeforeMatchingParen =
3184           Left.MatchingParen->getPreviousNonComment();
3185       if (!TokenBeforeMatchingParen || !Left.is(TT_TypeDeclarationParen))
3186         return true;
3187     }
3188     // Add a space if the previous token is a pointer qualifier or the closing
3189     // parenthesis of __attribute__(()) expression and the style requires spaces
3190     // after pointer qualifiers.
3191     if ((Style.SpaceAroundPointerQualifiers == FormatStyle::SAPQ_After ||
3192          Style.SpaceAroundPointerQualifiers == FormatStyle::SAPQ_Both) &&
3193         (Left.is(TT_AttributeParen) || Left.canBePointerOrReferenceQualifier()))
3194       return true;
3195     if (Left.Tok.isLiteral())
3196       return true;
3197     // for (auto a = 0, b = 0; const auto & c : {1, 2, 3})
3198     if (Left.isTypeOrIdentifier() && Right.Next && Right.Next->Next &&
3199         Right.Next->Next->is(TT_RangeBasedForLoopColon))
3200       return getTokenPointerOrReferenceAlignment(Right) !=
3201              FormatStyle::PAS_Left;
3202     return !Left.isOneOf(TT_PointerOrReference, tok::l_paren) &&
3203            (getTokenPointerOrReferenceAlignment(Right) !=
3204                 FormatStyle::PAS_Left ||
3205             (Line.IsMultiVariableDeclStmt &&
3206              (Left.NestingLevel == 0 ||
3207               (Left.NestingLevel == 1 && startsWithInitStatement(Line)))));
3208   }
3209   if (Right.is(TT_FunctionTypeLParen) && Left.isNot(tok::l_paren) &&
3210       (!Left.is(TT_PointerOrReference) ||
3211        (getTokenPointerOrReferenceAlignment(Left) != FormatStyle::PAS_Right &&
3212         !Line.IsMultiVariableDeclStmt)))
3213     return true;
3214   if (Left.is(TT_PointerOrReference)) {
3215     // Add a space if the next token is a pointer qualifier and the style
3216     // requires spaces before pointer qualifiers.
3217     if ((Style.SpaceAroundPointerQualifiers == FormatStyle::SAPQ_Before ||
3218          Style.SpaceAroundPointerQualifiers == FormatStyle::SAPQ_Both) &&
3219         Right.canBePointerOrReferenceQualifier())
3220       return true;
3221     // & 1
3222     if (Right.Tok.isLiteral())
3223       return true;
3224     // & /* comment
3225     if (Right.is(TT_BlockComment))
3226       return true;
3227     // foo() -> const Bar * override/final
3228     if (Right.isOneOf(Keywords.kw_override, Keywords.kw_final) &&
3229         !Right.is(TT_StartOfName))
3230       return true;
3231     // & {
3232     if (Right.is(tok::l_brace) && Right.is(BK_Block))
3233       return true;
3234     // for (auto a = 0, b = 0; const auto& c : {1, 2, 3})
3235     if (Left.Previous && Left.Previous->isTypeOrIdentifier() && Right.Next &&
3236         Right.Next->is(TT_RangeBasedForLoopColon))
3237       return getTokenPointerOrReferenceAlignment(Left) !=
3238              FormatStyle::PAS_Right;
3239     if (Right.isOneOf(TT_PointerOrReference, TT_ArraySubscriptLSquare,
3240                       tok::l_paren))
3241       return false;
3242     if (getTokenPointerOrReferenceAlignment(Left) == FormatStyle::PAS_Right)
3243       return false;
3244     // FIXME: Setting IsMultiVariableDeclStmt for the whole line is error-prone,
3245     // because it does not take into account nested scopes like lambdas.
3246     // In multi-variable declaration statements, attach */& to the variable
3247     // independently of the style. However, avoid doing it if we are in a nested
3248     // scope, e.g. lambda. We still need to special-case statements with
3249     // initializers.
3250     if (Line.IsMultiVariableDeclStmt &&
3251         (Left.NestingLevel == Line.First->NestingLevel ||
3252          ((Left.NestingLevel == Line.First->NestingLevel + 1) &&
3253           startsWithInitStatement(Line))))
3254       return false;
3255     return Left.Previous && !Left.Previous->isOneOf(
3256                                 tok::l_paren, tok::coloncolon, tok::l_square);
3257   }
3258   // Ensure right pointer alignment with ellipsis e.g. int *...P
3259   if (Left.is(tok::ellipsis) && Left.Previous &&
3260       Left.Previous->isOneOf(tok::star, tok::amp, tok::ampamp))
3261     return Style.PointerAlignment != FormatStyle::PAS_Right;
3262 
3263   if (Right.is(tok::star) && Left.is(tok::l_paren))
3264     return false;
3265   if (Left.is(tok::star) && Right.isOneOf(tok::star, tok::amp, tok::ampamp))
3266     return false;
3267   if (Right.isOneOf(tok::star, tok::amp, tok::ampamp)) {
3268     const FormatToken *Previous = &Left;
3269     while (Previous && !Previous->is(tok::kw_operator)) {
3270       if (Previous->is(tok::identifier) || Previous->isSimpleTypeSpecifier()) {
3271         Previous = Previous->getPreviousNonComment();
3272         continue;
3273       }
3274       if (Previous->is(TT_TemplateCloser) && Previous->MatchingParen) {
3275         Previous = Previous->MatchingParen->getPreviousNonComment();
3276         continue;
3277       }
3278       if (Previous->is(tok::coloncolon)) {
3279         Previous = Previous->getPreviousNonComment();
3280         continue;
3281       }
3282       break;
3283     }
3284     // Space between the type and the * in:
3285     //   operator void*()
3286     //   operator char*()
3287     //   operator void const*()
3288     //   operator void volatile*()
3289     //   operator /*comment*/ const char*()
3290     //   operator volatile /*comment*/ char*()
3291     //   operator Foo*()
3292     //   operator C<T>*()
3293     //   operator std::Foo*()
3294     //   operator C<T>::D<U>*()
3295     // dependent on PointerAlignment style.
3296     if (Previous) {
3297       if (Previous->endsSequence(tok::kw_operator))
3298         return Style.PointerAlignment != FormatStyle::PAS_Left;
3299       if (Previous->is(tok::kw_const) || Previous->is(tok::kw_volatile))
3300         return (Style.PointerAlignment != FormatStyle::PAS_Left) ||
3301                (Style.SpaceAroundPointerQualifiers ==
3302                 FormatStyle::SAPQ_After) ||
3303                (Style.SpaceAroundPointerQualifiers == FormatStyle::SAPQ_Both);
3304     }
3305   }
3306   const auto SpaceRequiredForArrayInitializerLSquare =
3307       [](const FormatToken &LSquareTok, const FormatStyle &Style) {
3308         return Style.SpacesInContainerLiterals ||
3309                ((Style.Language == FormatStyle::LK_Proto ||
3310                  Style.Language == FormatStyle::LK_TextProto) &&
3311                 !Style.Cpp11BracedListStyle &&
3312                 LSquareTok.endsSequence(tok::l_square, tok::colon,
3313                                         TT_SelectorName));
3314       };
3315   if (Left.is(tok::l_square))
3316     return (Left.is(TT_ArrayInitializerLSquare) && Right.isNot(tok::r_square) &&
3317             SpaceRequiredForArrayInitializerLSquare(Left, Style)) ||
3318            (Left.isOneOf(TT_ArraySubscriptLSquare, TT_StructuredBindingLSquare,
3319                          TT_LambdaLSquare) &&
3320             Style.SpacesInSquareBrackets && Right.isNot(tok::r_square));
3321   if (Right.is(tok::r_square))
3322     return Right.MatchingParen &&
3323            ((Right.MatchingParen->is(TT_ArrayInitializerLSquare) &&
3324              SpaceRequiredForArrayInitializerLSquare(*Right.MatchingParen,
3325                                                      Style)) ||
3326             (Style.SpacesInSquareBrackets &&
3327              Right.MatchingParen->isOneOf(TT_ArraySubscriptLSquare,
3328                                           TT_StructuredBindingLSquare,
3329                                           TT_LambdaLSquare)) ||
3330             Right.MatchingParen->is(TT_AttributeParen));
3331   if (Right.is(tok::l_square) &&
3332       !Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare,
3333                      TT_DesignatedInitializerLSquare,
3334                      TT_StructuredBindingLSquare, TT_AttributeSquare) &&
3335       !Left.isOneOf(tok::numeric_constant, TT_DictLiteral) &&
3336       !(!Left.is(tok::r_square) && Style.SpaceBeforeSquareBrackets &&
3337         Right.is(TT_ArraySubscriptLSquare)))
3338     return false;
3339   if (Left.is(tok::l_brace) && Right.is(tok::r_brace))
3340     return !Left.Children.empty(); // No spaces in "{}".
3341   if ((Left.is(tok::l_brace) && Left.isNot(BK_Block)) ||
3342       (Right.is(tok::r_brace) && Right.MatchingParen &&
3343        Right.MatchingParen->isNot(BK_Block)))
3344     return Style.Cpp11BracedListStyle ? Style.SpacesInParentheses : true;
3345   if (Left.is(TT_BlockComment))
3346     // No whitespace in x(/*foo=*/1), except for JavaScript.
3347     return Style.isJavaScript() || !Left.TokenText.endswith("=*/");
3348 
3349   // Space between template and attribute.
3350   // e.g. template <typename T> [[nodiscard]] ...
3351   if (Left.is(TT_TemplateCloser) && Right.is(TT_AttributeSquare))
3352     return true;
3353   // Space before parentheses common for all languages
3354   if (Right.is(tok::l_paren)) {
3355     if (Left.is(TT_TemplateCloser) && Right.isNot(TT_FunctionTypeLParen))
3356       return spaceRequiredBeforeParens(Right);
3357     if (Left.isOneOf(TT_RequiresClause, TT_RequiresClauseInARequiresExpression))
3358       return Style.SpaceBeforeParensOptions.AfterRequiresInClause ||
3359              spaceRequiredBeforeParens(Right);
3360     if (Left.is(TT_RequiresExpression))
3361       return Style.SpaceBeforeParensOptions.AfterRequiresInExpression ||
3362              spaceRequiredBeforeParens(Right);
3363     if ((Left.is(tok::r_paren) && Left.is(TT_AttributeParen)) ||
3364         (Left.is(tok::r_square) && Left.is(TT_AttributeSquare)))
3365       return true;
3366     if (Left.is(TT_ForEachMacro))
3367       return Style.SpaceBeforeParensOptions.AfterForeachMacros ||
3368              spaceRequiredBeforeParens(Right);
3369     if (Left.is(TT_IfMacro))
3370       return Style.SpaceBeforeParensOptions.AfterIfMacros ||
3371              spaceRequiredBeforeParens(Right);
3372     if (Line.Type == LT_ObjCDecl)
3373       return true;
3374     if (Left.is(tok::semi))
3375       return true;
3376     if (Left.isOneOf(tok::pp_elif, tok::kw_for, tok::kw_while, tok::kw_switch,
3377                      tok::kw_case, TT_ForEachMacro, TT_ObjCForIn) ||
3378         Left.isIf(Line.Type != LT_PreprocessorDirective))
3379       return Style.SpaceBeforeParensOptions.AfterControlStatements ||
3380              spaceRequiredBeforeParens(Right);
3381 
3382     // TODO add Operator overloading specific Options to
3383     // SpaceBeforeParensOptions
3384     if (Right.is(TT_OverloadedOperatorLParen))
3385       return spaceRequiredBeforeParens(Right);
3386     // Function declaration or definition
3387     if (Line.MightBeFunctionDecl && (Left.is(TT_FunctionDeclarationName))) {
3388       if (Line.mightBeFunctionDefinition())
3389         return Style.SpaceBeforeParensOptions.AfterFunctionDefinitionName ||
3390                spaceRequiredBeforeParens(Right);
3391       else
3392         return Style.SpaceBeforeParensOptions.AfterFunctionDeclarationName ||
3393                spaceRequiredBeforeParens(Right);
3394     }
3395     // Lambda
3396     if (Line.Type != LT_PreprocessorDirective && Left.is(tok::r_square) &&
3397         Left.MatchingParen && Left.MatchingParen->is(TT_LambdaLSquare))
3398       return Style.SpaceBeforeParensOptions.AfterFunctionDefinitionName ||
3399              spaceRequiredBeforeParens(Right);
3400     if (!Left.Previous || Left.Previous->isNot(tok::period)) {
3401       if (Left.isOneOf(tok::kw_try, Keywords.kw___except, tok::kw_catch))
3402         return Style.SpaceBeforeParensOptions.AfterControlStatements ||
3403                spaceRequiredBeforeParens(Right);
3404       if (Left.isOneOf(tok::kw_new, tok::kw_delete))
3405         return ((!Line.MightBeFunctionDecl || !Left.Previous) &&
3406                 Style.SpaceBeforeParens != FormatStyle::SBPO_Never) ||
3407                spaceRequiredBeforeParens(Right);
3408 
3409       if (Left.is(tok::r_square) && Left.MatchingParen &&
3410           Left.MatchingParen->Previous &&
3411           Left.MatchingParen->Previous->is(tok::kw_delete))
3412         return (Style.SpaceBeforeParens != FormatStyle::SBPO_Never) ||
3413                spaceRequiredBeforeParens(Right);
3414     }
3415     if (Line.Type != LT_PreprocessorDirective &&
3416         (Left.is(tok::identifier) || Left.isFunctionLikeKeyword() ||
3417          Left.is(tok::r_paren) || Left.isSimpleTypeSpecifier()))
3418       return spaceRequiredBeforeParens(Right);
3419     return false;
3420   }
3421   if (Left.is(tok::at) && Right.Tok.getObjCKeywordID() != tok::objc_not_keyword)
3422     return false;
3423   if (Right.is(TT_UnaryOperator))
3424     return !Left.isOneOf(tok::l_paren, tok::l_square, tok::at) &&
3425            (Left.isNot(tok::colon) || Left.isNot(TT_ObjCMethodExpr));
3426   if ((Left.isOneOf(tok::identifier, tok::greater, tok::r_square,
3427                     tok::r_paren) ||
3428        Left.isSimpleTypeSpecifier()) &&
3429       Right.is(tok::l_brace) && Right.getNextNonComment() &&
3430       Right.isNot(BK_Block))
3431     return false;
3432   if (Left.is(tok::period) || Right.is(tok::period))
3433     return false;
3434   // u#str, U#str, L#str, u8#str
3435   // uR#str, UR#str, LR#str, u8R#str
3436   if (Right.is(tok::hash) && Left.is(tok::identifier) &&
3437       (Left.TokenText == "L" || Left.TokenText == "u" ||
3438        Left.TokenText == "U" || Left.TokenText == "u8" ||
3439        Left.TokenText == "LR" || Left.TokenText == "uR" ||
3440        Left.TokenText == "UR" || Left.TokenText == "u8R"))
3441     return false;
3442   if (Left.is(TT_TemplateCloser) && Left.MatchingParen &&
3443       Left.MatchingParen->Previous &&
3444       (Left.MatchingParen->Previous->is(tok::period) ||
3445        Left.MatchingParen->Previous->is(tok::coloncolon)))
3446     // Java call to generic function with explicit type:
3447     // A.<B<C<...>>>DoSomething();
3448     // A::<B<C<...>>>DoSomething();  // With a Java 8 method reference.
3449     return false;
3450   if (Left.is(TT_TemplateCloser) && Right.is(tok::l_square))
3451     return false;
3452   if (Left.is(tok::l_brace) && Left.endsSequence(TT_DictLiteral, tok::at))
3453     // Objective-C dictionary literal -> no space after opening brace.
3454     return false;
3455   if (Right.is(tok::r_brace) && Right.MatchingParen &&
3456       Right.MatchingParen->endsSequence(TT_DictLiteral, tok::at))
3457     // Objective-C dictionary literal -> no space before closing brace.
3458     return false;
3459   if (Right.getType() == TT_TrailingAnnotation &&
3460       Right.isOneOf(tok::amp, tok::ampamp) &&
3461       Left.isOneOf(tok::kw_const, tok::kw_volatile) &&
3462       (!Right.Next || Right.Next->is(tok::semi)))
3463     // Match const and volatile ref-qualifiers without any additional
3464     // qualifiers such as
3465     // void Fn() const &;
3466     return getTokenReferenceAlignment(Right) != FormatStyle::PAS_Left;
3467 
3468   return true;
3469 }
3470 
3471 bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
3472                                          const FormatToken &Right) {
3473   const FormatToken &Left = *Right.Previous;
3474 
3475   // If the token is finalized don't touch it (as it could be in a
3476   // clang-format-off section).
3477   if (Left.Finalized)
3478     return Right.hasWhitespaceBefore();
3479 
3480   if (Right.Tok.getIdentifierInfo() && Left.Tok.getIdentifierInfo())
3481     return true; // Never ever merge two identifiers.
3482 
3483   // Leave a space between * and /* to avoid C4138 `comment end` found outside
3484   // of comment.
3485   if (Left.is(tok::star) && Right.is(tok::comment))
3486     return true;
3487 
3488   if (Style.isCpp()) {
3489     // Space between import <iostream>.
3490     // or import .....;
3491     if (Left.is(Keywords.kw_import) && Right.isOneOf(tok::less, tok::ellipsis))
3492       return true;
3493     // Space between `module :` and `import :`.
3494     if (Left.isOneOf(Keywords.kw_module, Keywords.kw_import) &&
3495         Right.is(TT_ModulePartitionColon))
3496       return true;
3497     // No space between import foo:bar but keep a space between import :bar;
3498     if (Left.is(tok::identifier) && Right.is(TT_ModulePartitionColon))
3499       return false;
3500     // No space between :bar;
3501     if (Left.is(TT_ModulePartitionColon) &&
3502         Right.isOneOf(tok::identifier, tok::kw_private))
3503       return false;
3504     if (Left.is(tok::ellipsis) && Right.is(tok::identifier) &&
3505         Line.First->is(Keywords.kw_import))
3506       return false;
3507     // Space in __attribute__((attr)) ::type.
3508     if (Left.is(TT_AttributeParen) && Right.is(tok::coloncolon))
3509       return true;
3510 
3511     if (Left.is(tok::kw_operator))
3512       return Right.is(tok::coloncolon);
3513     if (Right.is(tok::l_brace) && Right.is(BK_BracedInit) &&
3514         !Left.opensScope() && Style.SpaceBeforeCpp11BracedList)
3515       return true;
3516     if (Left.is(tok::less) && Left.is(TT_OverloadedOperator) &&
3517         Right.is(TT_TemplateOpener))
3518       return true;
3519   } else if (Style.Language == FormatStyle::LK_Proto ||
3520              Style.Language == FormatStyle::LK_TextProto) {
3521     if (Right.is(tok::period) &&
3522         Left.isOneOf(Keywords.kw_optional, Keywords.kw_required,
3523                      Keywords.kw_repeated, Keywords.kw_extend))
3524       return true;
3525     if (Right.is(tok::l_paren) &&
3526         Left.isOneOf(Keywords.kw_returns, Keywords.kw_option))
3527       return true;
3528     if (Right.isOneOf(tok::l_brace, tok::less) && Left.is(TT_SelectorName))
3529       return true;
3530     // Slashes occur in text protocol extension syntax: [type/type] { ... }.
3531     if (Left.is(tok::slash) || Right.is(tok::slash))
3532       return false;
3533     if (Left.MatchingParen &&
3534         Left.MatchingParen->is(TT_ProtoExtensionLSquare) &&
3535         Right.isOneOf(tok::l_brace, tok::less))
3536       return !Style.Cpp11BracedListStyle;
3537     // A percent is probably part of a formatting specification, such as %lld.
3538     if (Left.is(tok::percent))
3539       return false;
3540     // Preserve the existence of a space before a percent for cases like 0x%04x
3541     // and "%d %d"
3542     if (Left.is(tok::numeric_constant) && Right.is(tok::percent))
3543       return Right.hasWhitespaceBefore();
3544   } else if (Style.isJson()) {
3545     if (Right.is(tok::colon))
3546       return false;
3547   } else if (Style.isCSharp()) {
3548     // Require spaces around '{' and  before '}' unless they appear in
3549     // interpolated strings. Interpolated strings are merged into a single token
3550     // so cannot have spaces inserted by this function.
3551 
3552     // No space between 'this' and '['
3553     if (Left.is(tok::kw_this) && Right.is(tok::l_square))
3554       return false;
3555 
3556     // No space between 'new' and '('
3557     if (Left.is(tok::kw_new) && Right.is(tok::l_paren))
3558       return false;
3559 
3560     // Space before { (including space within '{ {').
3561     if (Right.is(tok::l_brace))
3562       return true;
3563 
3564     // Spaces inside braces.
3565     if (Left.is(tok::l_brace) && Right.isNot(tok::r_brace))
3566       return true;
3567 
3568     if (Left.isNot(tok::l_brace) && Right.is(tok::r_brace))
3569       return true;
3570 
3571     // Spaces around '=>'.
3572     if (Left.is(TT_FatArrow) || Right.is(TT_FatArrow))
3573       return true;
3574 
3575     // No spaces around attribute target colons
3576     if (Left.is(TT_AttributeColon) || Right.is(TT_AttributeColon))
3577       return false;
3578 
3579     // space between type and variable e.g. Dictionary<string,string> foo;
3580     if (Left.is(TT_TemplateCloser) && Right.is(TT_StartOfName))
3581       return true;
3582 
3583     // spaces inside square brackets.
3584     if (Left.is(tok::l_square) || Right.is(tok::r_square))
3585       return Style.SpacesInSquareBrackets;
3586 
3587     // No space before ? in nullable types.
3588     if (Right.is(TT_CSharpNullable))
3589       return false;
3590 
3591     // No space before null forgiving '!'.
3592     if (Right.is(TT_NonNullAssertion))
3593       return false;
3594 
3595     // No space between consecutive commas '[,,]'.
3596     if (Left.is(tok::comma) && Right.is(tok::comma))
3597       return false;
3598 
3599     // space after var in `var (key, value)`
3600     if (Left.is(Keywords.kw_var) && Right.is(tok::l_paren))
3601       return true;
3602 
3603     // space between keywords and paren e.g. "using ("
3604     if (Right.is(tok::l_paren))
3605       if (Left.isOneOf(tok::kw_using, Keywords.kw_async, Keywords.kw_when,
3606                        Keywords.kw_lock))
3607         return Style.SpaceBeforeParensOptions.AfterControlStatements ||
3608                spaceRequiredBeforeParens(Right);
3609 
3610     // space between method modifier and opening parenthesis of a tuple return
3611     // type
3612     if (Left.isOneOf(tok::kw_public, tok::kw_private, tok::kw_protected,
3613                      tok::kw_virtual, tok::kw_extern, tok::kw_static,
3614                      Keywords.kw_internal, Keywords.kw_abstract,
3615                      Keywords.kw_sealed, Keywords.kw_override,
3616                      Keywords.kw_async, Keywords.kw_unsafe) &&
3617         Right.is(tok::l_paren))
3618       return true;
3619   } else if (Style.isJavaScript()) {
3620     if (Left.is(TT_FatArrow))
3621       return true;
3622     // for await ( ...
3623     if (Right.is(tok::l_paren) && Left.is(Keywords.kw_await) && Left.Previous &&
3624         Left.Previous->is(tok::kw_for))
3625       return true;
3626     if (Left.is(Keywords.kw_async) && Right.is(tok::l_paren) &&
3627         Right.MatchingParen) {
3628       const FormatToken *Next = Right.MatchingParen->getNextNonComment();
3629       // An async arrow function, for example: `x = async () => foo();`,
3630       // as opposed to calling a function called async: `x = async();`
3631       if (Next && Next->is(TT_FatArrow))
3632         return true;
3633     }
3634     if ((Left.is(TT_TemplateString) && Left.TokenText.endswith("${")) ||
3635         (Right.is(TT_TemplateString) && Right.TokenText.startswith("}")))
3636       return false;
3637     // In tagged template literals ("html`bar baz`"), there is no space between
3638     // the tag identifier and the template string.
3639     if (Keywords.IsJavaScriptIdentifier(Left,
3640                                         /* AcceptIdentifierName= */ false) &&
3641         Right.is(TT_TemplateString))
3642       return false;
3643     if (Right.is(tok::star) &&
3644         Left.isOneOf(Keywords.kw_function, Keywords.kw_yield))
3645       return false;
3646     if (Right.isOneOf(tok::l_brace, tok::l_square) &&
3647         Left.isOneOf(Keywords.kw_function, Keywords.kw_yield,
3648                      Keywords.kw_extends, Keywords.kw_implements))
3649       return true;
3650     if (Right.is(tok::l_paren)) {
3651       // JS methods can use some keywords as names (e.g. `delete()`).
3652       if (Line.MustBeDeclaration && Left.Tok.getIdentifierInfo())
3653         return false;
3654       // Valid JS method names can include keywords, e.g. `foo.delete()` or
3655       // `bar.instanceof()`. Recognize call positions by preceding period.
3656       if (Left.Previous && Left.Previous->is(tok::period) &&
3657           Left.Tok.getIdentifierInfo())
3658         return false;
3659       // Additional unary JavaScript operators that need a space after.
3660       if (Left.isOneOf(tok::kw_throw, Keywords.kw_await, Keywords.kw_typeof,
3661                        tok::kw_void))
3662         return true;
3663     }
3664     // `foo as const;` casts into a const type.
3665     if (Left.endsSequence(tok::kw_const, Keywords.kw_as))
3666       return false;
3667     if ((Left.isOneOf(Keywords.kw_let, Keywords.kw_var, Keywords.kw_in,
3668                       tok::kw_const) ||
3669          // "of" is only a keyword if it appears after another identifier
3670          // (e.g. as "const x of y" in a for loop), or after a destructuring
3671          // operation (const [x, y] of z, const {a, b} of c).
3672          (Left.is(Keywords.kw_of) && Left.Previous &&
3673           (Left.Previous->is(tok::identifier) ||
3674            Left.Previous->isOneOf(tok::r_square, tok::r_brace)))) &&
3675         (!Left.Previous || !Left.Previous->is(tok::period)))
3676       return true;
3677     if (Left.isOneOf(tok::kw_for, Keywords.kw_as) && Left.Previous &&
3678         Left.Previous->is(tok::period) && Right.is(tok::l_paren))
3679       return false;
3680     if (Left.is(Keywords.kw_as) &&
3681         Right.isOneOf(tok::l_square, tok::l_brace, tok::l_paren))
3682       return true;
3683     if (Left.is(tok::kw_default) && Left.Previous &&
3684         Left.Previous->is(tok::kw_export))
3685       return true;
3686     if (Left.is(Keywords.kw_is) && Right.is(tok::l_brace))
3687       return true;
3688     if (Right.isOneOf(TT_JsTypeColon, TT_JsTypeOptionalQuestion))
3689       return false;
3690     if (Left.is(TT_JsTypeOperator) || Right.is(TT_JsTypeOperator))
3691       return false;
3692     if ((Left.is(tok::l_brace) || Right.is(tok::r_brace)) &&
3693         Line.First->isOneOf(Keywords.kw_import, tok::kw_export))
3694       return false;
3695     if (Left.is(tok::ellipsis))
3696       return false;
3697     if (Left.is(TT_TemplateCloser) &&
3698         !Right.isOneOf(tok::equal, tok::l_brace, tok::comma, tok::l_square,
3699                        Keywords.kw_implements, Keywords.kw_extends))
3700       // Type assertions ('<type>expr') are not followed by whitespace. Other
3701       // locations that should have whitespace following are identified by the
3702       // above set of follower tokens.
3703       return false;
3704     if (Right.is(TT_NonNullAssertion))
3705       return false;
3706     if (Left.is(TT_NonNullAssertion) &&
3707         Right.isOneOf(Keywords.kw_as, Keywords.kw_in))
3708       return true; // "x! as string", "x! in y"
3709   } else if (Style.Language == FormatStyle::LK_Java) {
3710     if (Left.is(tok::r_square) && Right.is(tok::l_brace))
3711       return true;
3712     if (Left.is(Keywords.kw_synchronized) && Right.is(tok::l_paren))
3713       return Style.SpaceBeforeParensOptions.AfterControlStatements ||
3714              spaceRequiredBeforeParens(Right);
3715     if ((Left.isOneOf(tok::kw_static, tok::kw_public, tok::kw_private,
3716                       tok::kw_protected) ||
3717          Left.isOneOf(Keywords.kw_final, Keywords.kw_abstract,
3718                       Keywords.kw_native)) &&
3719         Right.is(TT_TemplateOpener))
3720       return true;
3721   }
3722   if (Left.is(TT_ImplicitStringLiteral))
3723     return Right.hasWhitespaceBefore();
3724   if (Line.Type == LT_ObjCMethodDecl) {
3725     if (Left.is(TT_ObjCMethodSpecifier))
3726       return true;
3727     if (Left.is(tok::r_paren) && canBeObjCSelectorComponent(Right))
3728       // Don't space between ')' and <id> or ')' and 'new'. 'new' is not a
3729       // keyword in Objective-C, and '+ (instancetype)new;' is a standard class
3730       // method declaration.
3731       return false;
3732   }
3733   if (Line.Type == LT_ObjCProperty &&
3734       (Right.is(tok::equal) || Left.is(tok::equal)))
3735     return false;
3736 
3737   if (Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow) ||
3738       Left.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow))
3739     return true;
3740   if (Left.is(tok::comma) && !Right.is(TT_OverloadedOperatorLParen))
3741     return true;
3742   if (Right.is(tok::comma))
3743     return false;
3744   if (Right.is(TT_ObjCBlockLParen))
3745     return true;
3746   if (Right.is(TT_CtorInitializerColon))
3747     return Style.SpaceBeforeCtorInitializerColon;
3748   if (Right.is(TT_InheritanceColon) && !Style.SpaceBeforeInheritanceColon)
3749     return false;
3750   if (Right.is(TT_RangeBasedForLoopColon) &&
3751       !Style.SpaceBeforeRangeBasedForLoopColon)
3752     return false;
3753   if (Left.is(TT_BitFieldColon))
3754     return Style.BitFieldColonSpacing == FormatStyle::BFCS_Both ||
3755            Style.BitFieldColonSpacing == FormatStyle::BFCS_After;
3756   if (Right.is(tok::colon)) {
3757     if (Line.First->isOneOf(tok::kw_default, tok::kw_case))
3758       return Style.SpaceBeforeCaseColon;
3759     const FormatToken *Next = Right.getNextNonComment();
3760     if (!Next || Next->is(tok::semi))
3761       return false;
3762     if (Right.is(TT_ObjCMethodExpr))
3763       return false;
3764     if (Left.is(tok::question))
3765       return false;
3766     if (Right.is(TT_InlineASMColon) && Left.is(tok::coloncolon))
3767       return false;
3768     if (Right.is(TT_DictLiteral))
3769       return Style.SpacesInContainerLiterals;
3770     if (Right.is(TT_AttributeColon))
3771       return false;
3772     if (Right.is(TT_CSharpNamedArgumentColon))
3773       return false;
3774     if (Right.is(TT_BitFieldColon))
3775       return Style.BitFieldColonSpacing == FormatStyle::BFCS_Both ||
3776              Style.BitFieldColonSpacing == FormatStyle::BFCS_Before;
3777     return true;
3778   }
3779   // Do not merge "- -" into "--".
3780   if ((Left.isOneOf(tok::minus, tok::minusminus) &&
3781        Right.isOneOf(tok::minus, tok::minusminus)) ||
3782       (Left.isOneOf(tok::plus, tok::plusplus) &&
3783        Right.isOneOf(tok::plus, tok::plusplus)))
3784     return true;
3785   if (Left.is(TT_UnaryOperator)) {
3786     if (!Right.is(tok::l_paren)) {
3787       // The alternative operators for ~ and ! are "compl" and "not".
3788       // If they are used instead, we do not want to combine them with
3789       // the token to the right, unless that is a left paren.
3790       if (Left.is(tok::exclaim) && Left.TokenText == "not")
3791         return true;
3792       if (Left.is(tok::tilde) && Left.TokenText == "compl")
3793         return true;
3794       // Lambda captures allow for a lone &, so "&]" needs to be properly
3795       // handled.
3796       if (Left.is(tok::amp) && Right.is(tok::r_square))
3797         return Style.SpacesInSquareBrackets;
3798     }
3799     return (Style.SpaceAfterLogicalNot && Left.is(tok::exclaim)) ||
3800            Right.is(TT_BinaryOperator);
3801   }
3802 
3803   // If the next token is a binary operator or a selector name, we have
3804   // incorrectly classified the parenthesis as a cast. FIXME: Detect correctly.
3805   if (Left.is(TT_CastRParen))
3806     return Style.SpaceAfterCStyleCast ||
3807            Right.isOneOf(TT_BinaryOperator, TT_SelectorName);
3808 
3809   auto ShouldAddSpacesInAngles = [this, &Right]() {
3810     if (this->Style.SpacesInAngles == FormatStyle::SIAS_Always)
3811       return true;
3812     if (this->Style.SpacesInAngles == FormatStyle::SIAS_Leave)
3813       return Right.hasWhitespaceBefore();
3814     return false;
3815   };
3816 
3817   if (Left.is(tok::greater) && Right.is(tok::greater)) {
3818     if (Style.Language == FormatStyle::LK_TextProto ||
3819         (Style.Language == FormatStyle::LK_Proto && Left.is(TT_DictLiteral)))
3820       return !Style.Cpp11BracedListStyle;
3821     return Right.is(TT_TemplateCloser) && Left.is(TT_TemplateCloser) &&
3822            ((Style.Standard < FormatStyle::LS_Cpp11) ||
3823             ShouldAddSpacesInAngles());
3824   }
3825   if (Right.isOneOf(tok::arrow, tok::arrowstar, tok::periodstar) ||
3826       Left.isOneOf(tok::arrow, tok::period, tok::arrowstar, tok::periodstar) ||
3827       (Right.is(tok::period) && Right.isNot(TT_DesignatedInitializerPeriod)))
3828     return false;
3829   if (!Style.SpaceBeforeAssignmentOperators && Left.isNot(TT_TemplateCloser) &&
3830       Right.getPrecedence() == prec::Assignment)
3831     return false;
3832   if (Style.Language == FormatStyle::LK_Java && Right.is(tok::coloncolon) &&
3833       (Left.is(tok::identifier) || Left.is(tok::kw_this)))
3834     return false;
3835   if (Right.is(tok::coloncolon) && Left.is(tok::identifier))
3836     // Generally don't remove existing spaces between an identifier and "::".
3837     // The identifier might actually be a macro name such as ALWAYS_INLINE. If
3838     // this turns out to be too lenient, add analysis of the identifier itself.
3839     return Right.hasWhitespaceBefore();
3840   if (Right.is(tok::coloncolon) &&
3841       !Left.isOneOf(tok::l_brace, tok::comment, tok::l_paren))
3842     // Put a space between < and :: in vector< ::std::string >
3843     return (Left.is(TT_TemplateOpener) &&
3844             ((Style.Standard < FormatStyle::LS_Cpp11) ||
3845              ShouldAddSpacesInAngles())) ||
3846            !(Left.isOneOf(tok::l_paren, tok::r_paren, tok::l_square,
3847                           tok::kw___super, TT_TemplateOpener,
3848                           TT_TemplateCloser)) ||
3849            (Left.is(tok::l_paren) && Style.SpacesInParentheses);
3850   if ((Left.is(TT_TemplateOpener)) != (Right.is(TT_TemplateCloser)))
3851     return ShouldAddSpacesInAngles();
3852   // Space before TT_StructuredBindingLSquare.
3853   if (Right.is(TT_StructuredBindingLSquare))
3854     return !Left.isOneOf(tok::amp, tok::ampamp) ||
3855            getTokenReferenceAlignment(Left) != FormatStyle::PAS_Right;
3856   // Space before & or && following a TT_StructuredBindingLSquare.
3857   if (Right.Next && Right.Next->is(TT_StructuredBindingLSquare) &&
3858       Right.isOneOf(tok::amp, tok::ampamp))
3859     return getTokenReferenceAlignment(Right) != FormatStyle::PAS_Left;
3860   if ((Right.is(TT_BinaryOperator) && !Left.is(tok::l_paren)) ||
3861       (Left.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) &&
3862        !Right.is(tok::r_paren)))
3863     return true;
3864   if (Right.is(TT_TemplateOpener) && Left.is(tok::r_paren) &&
3865       Left.MatchingParen && Left.MatchingParen->is(TT_OverloadedOperatorLParen))
3866     return false;
3867   if (Right.is(tok::less) && Left.isNot(tok::l_paren) &&
3868       Line.startsWith(tok::hash))
3869     return true;
3870   if (Right.is(TT_TrailingUnaryOperator))
3871     return false;
3872   if (Left.is(TT_RegexLiteral))
3873     return false;
3874   return spaceRequiredBetween(Line, Left, Right);
3875 }
3876 
3877 // Returns 'true' if 'Tok' is a brace we'd want to break before in Allman style.
3878 static bool isAllmanBrace(const FormatToken &Tok) {
3879   return Tok.is(tok::l_brace) && Tok.is(BK_Block) &&
3880          !Tok.isOneOf(TT_ObjCBlockLBrace, TT_LambdaLBrace, TT_DictLiteral);
3881 }
3882 
3883 // Returns 'true' if 'Tok' is a function argument.
3884 static bool IsFunctionArgument(const FormatToken &Tok) {
3885   return Tok.MatchingParen && Tok.MatchingParen->Next &&
3886          Tok.MatchingParen->Next->isOneOf(tok::comma, tok::r_paren);
3887 }
3888 
3889 static bool
3890 isItAnEmptyLambdaAllowed(const FormatToken &Tok,
3891                          FormatStyle::ShortLambdaStyle ShortLambdaOption) {
3892   return Tok.Children.empty() && ShortLambdaOption != FormatStyle::SLS_None;
3893 }
3894 
3895 static bool isAllmanLambdaBrace(const FormatToken &Tok) {
3896   return Tok.is(tok::l_brace) && Tok.is(BK_Block) &&
3897          !Tok.isOneOf(TT_ObjCBlockLBrace, TT_DictLiteral);
3898 }
3899 
3900 // Returns the first token on the line that is not a comment.
3901 static const FormatToken *getFirstNonComment(const AnnotatedLine &Line) {
3902   const FormatToken *Next = Line.First;
3903   if (!Next)
3904     return Next;
3905   if (Next->is(tok::comment))
3906     Next = Next->getNextNonComment();
3907   return Next;
3908 }
3909 
3910 bool TokenAnnotator::mustBreakBefore(const AnnotatedLine &Line,
3911                                      const FormatToken &Right) {
3912   const FormatToken &Left = *Right.Previous;
3913   if (Right.NewlinesBefore > 1 && Style.MaxEmptyLinesToKeep > 0)
3914     return true;
3915 
3916   if (Style.isCSharp()) {
3917     if (Left.is(TT_FatArrow) && Right.is(tok::l_brace) &&
3918         Style.BraceWrapping.AfterFunction)
3919       return true;
3920     if (Right.is(TT_CSharpNamedArgumentColon) ||
3921         Left.is(TT_CSharpNamedArgumentColon))
3922       return false;
3923     if (Right.is(TT_CSharpGenericTypeConstraint))
3924       return true;
3925     if (Right.Next && Right.Next->is(TT_FatArrow) &&
3926         (Right.is(tok::numeric_constant) ||
3927          (Right.is(tok::identifier) && Right.TokenText == "_")))
3928       return true;
3929 
3930     // Break after C# [...] and before public/protected/private/internal.
3931     if (Left.is(TT_AttributeSquare) && Left.is(tok::r_square) &&
3932         (Right.isAccessSpecifier(/*ColonRequired=*/false) ||
3933          Right.is(Keywords.kw_internal)))
3934       return true;
3935     // Break between ] and [ but only when there are really 2 attributes.
3936     if (Left.is(TT_AttributeSquare) && Right.is(TT_AttributeSquare) &&
3937         Left.is(tok::r_square) && Right.is(tok::l_square))
3938       return true;
3939 
3940   } else if (Style.isJavaScript()) {
3941     // FIXME: This might apply to other languages and token kinds.
3942     if (Right.is(tok::string_literal) && Left.is(tok::plus) && Left.Previous &&
3943         Left.Previous->is(tok::string_literal))
3944       return true;
3945     if (Left.is(TT_DictLiteral) && Left.is(tok::l_brace) && Line.Level == 0 &&
3946         Left.Previous && Left.Previous->is(tok::equal) &&
3947         Line.First->isOneOf(tok::identifier, Keywords.kw_import, tok::kw_export,
3948                             tok::kw_const) &&
3949         // kw_var/kw_let are pseudo-tokens that are tok::identifier, so match
3950         // above.
3951         !Line.First->isOneOf(Keywords.kw_var, Keywords.kw_let))
3952       // Object literals on the top level of a file are treated as "enum-style".
3953       // Each key/value pair is put on a separate line, instead of bin-packing.
3954       return true;
3955     if (Left.is(tok::l_brace) && Line.Level == 0 &&
3956         (Line.startsWith(tok::kw_enum) ||
3957          Line.startsWith(tok::kw_const, tok::kw_enum) ||
3958          Line.startsWith(tok::kw_export, tok::kw_enum) ||
3959          Line.startsWith(tok::kw_export, tok::kw_const, tok::kw_enum)))
3960       // JavaScript top-level enum key/value pairs are put on separate lines
3961       // instead of bin-packing.
3962       return true;
3963     if (Right.is(tok::r_brace) && Left.is(tok::l_brace) && Left.Previous &&
3964         Left.Previous->is(TT_FatArrow)) {
3965       // JS arrow function (=> {...}).
3966       switch (Style.AllowShortLambdasOnASingleLine) {
3967       case FormatStyle::SLS_All:
3968         return false;
3969       case FormatStyle::SLS_None:
3970         return true;
3971       case FormatStyle::SLS_Empty:
3972         return !Left.Children.empty();
3973       case FormatStyle::SLS_Inline:
3974         // allow one-lining inline (e.g. in function call args) and empty arrow
3975         // functions.
3976         return (Left.NestingLevel == 0 && Line.Level == 0) &&
3977                !Left.Children.empty();
3978       }
3979       llvm_unreachable("Unknown FormatStyle::ShortLambdaStyle enum");
3980     }
3981 
3982     if (Right.is(tok::r_brace) && Left.is(tok::l_brace) &&
3983         !Left.Children.empty())
3984       // Support AllowShortFunctionsOnASingleLine for JavaScript.
3985       return Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_None ||
3986              Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_Empty ||
3987              (Left.NestingLevel == 0 && Line.Level == 0 &&
3988               Style.AllowShortFunctionsOnASingleLine &
3989                   FormatStyle::SFS_InlineOnly);
3990   } else if (Style.Language == FormatStyle::LK_Java) {
3991     if (Right.is(tok::plus) && Left.is(tok::string_literal) && Right.Next &&
3992         Right.Next->is(tok::string_literal))
3993       return true;
3994   } else if (Style.Language == FormatStyle::LK_Cpp ||
3995              Style.Language == FormatStyle::LK_ObjC ||
3996              Style.Language == FormatStyle::LK_Proto ||
3997              Style.Language == FormatStyle::LK_TableGen ||
3998              Style.Language == FormatStyle::LK_TextProto) {
3999     if (Left.isStringLiteral() && Right.isStringLiteral())
4000       return true;
4001   }
4002 
4003   // Basic JSON newline processing.
4004   if (Style.isJson()) {
4005     // Always break after a JSON record opener.
4006     // {
4007     // }
4008     if (Left.is(TT_DictLiteral) && Left.is(tok::l_brace))
4009       return true;
4010     // Always break after a JSON array opener.
4011     // [
4012     // ]
4013     if (Left.is(TT_ArrayInitializerLSquare) && Left.is(tok::l_square) &&
4014         !Right.is(tok::r_square))
4015       return true;
4016     // Always break after successive entries.
4017     // 1,
4018     // 2
4019     if (Left.is(tok::comma))
4020       return true;
4021   }
4022 
4023   // If the last token before a '}', ']', or ')' is a comma or a trailing
4024   // comment, the intention is to insert a line break after it in order to make
4025   // shuffling around entries easier. Import statements, especially in
4026   // JavaScript, can be an exception to this rule.
4027   if (Style.JavaScriptWrapImports || Line.Type != LT_ImportStatement) {
4028     const FormatToken *BeforeClosingBrace = nullptr;
4029     if ((Left.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) ||
4030          (Style.isJavaScript() && Left.is(tok::l_paren))) &&
4031         Left.isNot(BK_Block) && Left.MatchingParen)
4032       BeforeClosingBrace = Left.MatchingParen->Previous;
4033     else if (Right.MatchingParen &&
4034              (Right.MatchingParen->isOneOf(tok::l_brace,
4035                                            TT_ArrayInitializerLSquare) ||
4036               (Style.isJavaScript() && Right.MatchingParen->is(tok::l_paren))))
4037       BeforeClosingBrace = &Left;
4038     if (BeforeClosingBrace && (BeforeClosingBrace->is(tok::comma) ||
4039                                BeforeClosingBrace->isTrailingComment()))
4040       return true;
4041   }
4042 
4043   if (Right.is(tok::comment))
4044     return Left.isNot(BK_BracedInit) && Left.isNot(TT_CtorInitializerColon) &&
4045            (Right.NewlinesBefore > 0 && Right.HasUnescapedNewline);
4046   if (Left.isTrailingComment())
4047     return true;
4048   if (Left.IsUnterminatedLiteral)
4049     return true;
4050   if (Right.is(tok::lessless) && Right.Next && Left.is(tok::string_literal) &&
4051       Right.Next->is(tok::string_literal))
4052     return true;
4053   if (Right.is(TT_RequiresClause)) {
4054     switch (Style.RequiresClausePosition) {
4055     case FormatStyle::RCPS_OwnLine:
4056     case FormatStyle::RCPS_WithFollowing:
4057       return true;
4058     default:
4059       break;
4060     }
4061   }
4062   // Can break after template<> declaration
4063   if (Left.ClosesTemplateDeclaration && Left.MatchingParen &&
4064       Left.MatchingParen->NestingLevel == 0) {
4065     // Put concepts on the next line e.g.
4066     // template<typename T>
4067     // concept ...
4068     if (Right.is(tok::kw_concept))
4069       return Style.BreakBeforeConceptDeclarations == FormatStyle::BBCDS_Always;
4070     return Style.AlwaysBreakTemplateDeclarations == FormatStyle::BTDS_Yes;
4071   }
4072   if (Left.ClosesRequiresClause && Right.isNot(tok::semi)) {
4073     switch (Style.RequiresClausePosition) {
4074     case FormatStyle::RCPS_OwnLine:
4075     case FormatStyle::RCPS_WithPreceding:
4076       return true;
4077     default:
4078       break;
4079     }
4080   }
4081   if (Style.PackConstructorInitializers == FormatStyle::PCIS_Never) {
4082     if (Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeColon &&
4083         (Left.is(TT_CtorInitializerComma) || Right.is(TT_CtorInitializerColon)))
4084       return true;
4085 
4086     if (Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon &&
4087         Left.isOneOf(TT_CtorInitializerColon, TT_CtorInitializerComma))
4088       return true;
4089   }
4090   if (Style.PackConstructorInitializers < FormatStyle::PCIS_CurrentLine &&
4091       Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma &&
4092       Right.isOneOf(TT_CtorInitializerComma, TT_CtorInitializerColon))
4093     return true;
4094   // Break only if we have multiple inheritance.
4095   if (Style.BreakInheritanceList == FormatStyle::BILS_BeforeComma &&
4096       Right.is(TT_InheritanceComma))
4097     return true;
4098   if (Style.BreakInheritanceList == FormatStyle::BILS_AfterComma &&
4099       Left.is(TT_InheritanceComma))
4100     return true;
4101   if (Right.is(tok::string_literal) && Right.TokenText.startswith("R\""))
4102     // Multiline raw string literals are special wrt. line breaks. The author
4103     // has made a deliberate choice and might have aligned the contents of the
4104     // string literal accordingly. Thus, we try keep existing line breaks.
4105     return Right.IsMultiline && Right.NewlinesBefore > 0;
4106   if ((Left.is(tok::l_brace) || (Left.is(tok::less) && Left.Previous &&
4107                                  Left.Previous->is(tok::equal))) &&
4108       Right.NestingLevel == 1 && Style.Language == FormatStyle::LK_Proto) {
4109     // Don't put enums or option definitions onto single lines in protocol
4110     // buffers.
4111     return true;
4112   }
4113   if (Right.is(TT_InlineASMBrace))
4114     return Right.HasUnescapedNewline;
4115 
4116   if (isAllmanBrace(Left) || isAllmanBrace(Right)) {
4117     auto FirstNonComment = getFirstNonComment(Line);
4118     bool AccessSpecifier =
4119         FirstNonComment &&
4120         FirstNonComment->isOneOf(Keywords.kw_internal, tok::kw_public,
4121                                  tok::kw_private, tok::kw_protected);
4122 
4123     if (Style.BraceWrapping.AfterEnum) {
4124       if (Line.startsWith(tok::kw_enum) ||
4125           Line.startsWith(tok::kw_typedef, tok::kw_enum))
4126         return true;
4127       // Ensure BraceWrapping for `public enum A {`.
4128       if (AccessSpecifier && FirstNonComment->Next &&
4129           FirstNonComment->Next->is(tok::kw_enum))
4130         return true;
4131     }
4132 
4133     // Ensure BraceWrapping for `public interface A {`.
4134     if (Style.BraceWrapping.AfterClass &&
4135         ((AccessSpecifier && FirstNonComment->Next &&
4136           FirstNonComment->Next->is(Keywords.kw_interface)) ||
4137          Line.startsWith(Keywords.kw_interface)))
4138       return true;
4139 
4140     return (Line.startsWith(tok::kw_class) && Style.BraceWrapping.AfterClass) ||
4141            (Line.startsWith(tok::kw_struct) && Style.BraceWrapping.AfterStruct);
4142   }
4143 
4144   if (Left.is(TT_ObjCBlockLBrace) &&
4145       Style.AllowShortBlocksOnASingleLine == FormatStyle::SBS_Never)
4146     return true;
4147 
4148   // Ensure wrapping after __attribute__((XX)) and @interface etc.
4149   if (Left.is(TT_AttributeParen) && Right.is(TT_ObjCDecl))
4150     return true;
4151 
4152   if (Left.is(TT_LambdaLBrace)) {
4153     if (IsFunctionArgument(Left) &&
4154         Style.AllowShortLambdasOnASingleLine == FormatStyle::SLS_Inline)
4155       return false;
4156 
4157     if (Style.AllowShortLambdasOnASingleLine == FormatStyle::SLS_None ||
4158         Style.AllowShortLambdasOnASingleLine == FormatStyle::SLS_Inline ||
4159         (!Left.Children.empty() &&
4160          Style.AllowShortLambdasOnASingleLine == FormatStyle::SLS_Empty))
4161       return true;
4162   }
4163 
4164   if (Style.BraceWrapping.BeforeLambdaBody && Right.is(TT_LambdaLBrace) &&
4165       Left.isOneOf(tok::star, tok::amp, tok::ampamp, TT_TemplateCloser))
4166     return true;
4167 
4168   // Put multiple Java annotation on a new line.
4169   if ((Style.Language == FormatStyle::LK_Java || Style.isJavaScript()) &&
4170       Left.is(TT_LeadingJavaAnnotation) &&
4171       Right.isNot(TT_LeadingJavaAnnotation) && Right.isNot(tok::l_paren) &&
4172       (Line.Last->is(tok::l_brace) || Style.BreakAfterJavaFieldAnnotations))
4173     return true;
4174 
4175   if (Right.is(TT_ProtoExtensionLSquare))
4176     return true;
4177 
4178   // In text proto instances if a submessage contains at least 2 entries and at
4179   // least one of them is a submessage, like A { ... B { ... } ... },
4180   // put all of the entries of A on separate lines by forcing the selector of
4181   // the submessage B to be put on a newline.
4182   //
4183   // Example: these can stay on one line:
4184   // a { scalar_1: 1 scalar_2: 2 }
4185   // a { b { key: value } }
4186   //
4187   // and these entries need to be on a new line even if putting them all in one
4188   // line is under the column limit:
4189   // a {
4190   //   scalar: 1
4191   //   b { key: value }
4192   // }
4193   //
4194   // We enforce this by breaking before a submessage field that has previous
4195   // siblings, *and* breaking before a field that follows a submessage field.
4196   //
4197   // Be careful to exclude the case  [proto.ext] { ... } since the `]` is
4198   // the TT_SelectorName there, but we don't want to break inside the brackets.
4199   //
4200   // Another edge case is @submessage { key: value }, which is a common
4201   // substitution placeholder. In this case we want to keep `@` and `submessage`
4202   // together.
4203   //
4204   // We ensure elsewhere that extensions are always on their own line.
4205   if ((Style.Language == FormatStyle::LK_Proto ||
4206        Style.Language == FormatStyle::LK_TextProto) &&
4207       Right.is(TT_SelectorName) && !Right.is(tok::r_square) && Right.Next) {
4208     // Keep `@submessage` together in:
4209     // @submessage { key: value }
4210     if (Left.is(tok::at))
4211       return false;
4212     // Look for the scope opener after selector in cases like:
4213     // selector { ...
4214     // selector: { ...
4215     // selector: @base { ...
4216     FormatToken *LBrace = Right.Next;
4217     if (LBrace && LBrace->is(tok::colon)) {
4218       LBrace = LBrace->Next;
4219       if (LBrace && LBrace->is(tok::at)) {
4220         LBrace = LBrace->Next;
4221         if (LBrace)
4222           LBrace = LBrace->Next;
4223       }
4224     }
4225     if (LBrace &&
4226         // The scope opener is one of {, [, <:
4227         // selector { ... }
4228         // selector [ ... ]
4229         // selector < ... >
4230         //
4231         // In case of selector { ... }, the l_brace is TT_DictLiteral.
4232         // In case of an empty selector {}, the l_brace is not TT_DictLiteral,
4233         // so we check for immediately following r_brace.
4234         ((LBrace->is(tok::l_brace) &&
4235           (LBrace->is(TT_DictLiteral) ||
4236            (LBrace->Next && LBrace->Next->is(tok::r_brace)))) ||
4237          LBrace->is(TT_ArrayInitializerLSquare) || LBrace->is(tok::less))) {
4238       // If Left.ParameterCount is 0, then this submessage entry is not the
4239       // first in its parent submessage, and we want to break before this entry.
4240       // If Left.ParameterCount is greater than 0, then its parent submessage
4241       // might contain 1 or more entries and we want to break before this entry
4242       // if it contains at least 2 entries. We deal with this case later by
4243       // detecting and breaking before the next entry in the parent submessage.
4244       if (Left.ParameterCount == 0)
4245         return true;
4246       // However, if this submessage is the first entry in its parent
4247       // submessage, Left.ParameterCount might be 1 in some cases.
4248       // We deal with this case later by detecting an entry
4249       // following a closing paren of this submessage.
4250     }
4251 
4252     // If this is an entry immediately following a submessage, it will be
4253     // preceded by a closing paren of that submessage, like in:
4254     //     left---.  .---right
4255     //            v  v
4256     // sub: { ... } key: value
4257     // If there was a comment between `}` an `key` above, then `key` would be
4258     // put on a new line anyways.
4259     if (Left.isOneOf(tok::r_brace, tok::greater, tok::r_square))
4260       return true;
4261   }
4262 
4263   // Deal with lambda arguments in C++ - we want consistent line breaks whether
4264   // they happen to be at arg0, arg1 or argN. The selection is a bit nuanced
4265   // as aggressive line breaks are placed when the lambda is not the last arg.
4266   if ((Style.Language == FormatStyle::LK_Cpp ||
4267        Style.Language == FormatStyle::LK_ObjC) &&
4268       Left.is(tok::l_paren) && Left.BlockParameterCount > 0 &&
4269       !Right.isOneOf(tok::l_paren, TT_LambdaLSquare)) {
4270     // Multiple lambdas in the same function call force line breaks.
4271     if (Left.BlockParameterCount > 1)
4272       return true;
4273 
4274     // A lambda followed by another arg forces a line break.
4275     if (!Left.Role)
4276       return false;
4277     auto Comma = Left.Role->lastComma();
4278     if (!Comma)
4279       return false;
4280     auto Next = Comma->getNextNonComment();
4281     if (!Next)
4282       return false;
4283     if (!Next->isOneOf(TT_LambdaLSquare, tok::l_brace, tok::caret))
4284       return true;
4285   }
4286 
4287   return false;
4288 }
4289 
4290 bool TokenAnnotator::canBreakBefore(const AnnotatedLine &Line,
4291                                     const FormatToken &Right) {
4292   const FormatToken &Left = *Right.Previous;
4293   // Language-specific stuff.
4294   if (Style.isCSharp()) {
4295     if (Left.isOneOf(TT_CSharpNamedArgumentColon, TT_AttributeColon) ||
4296         Right.isOneOf(TT_CSharpNamedArgumentColon, TT_AttributeColon))
4297       return false;
4298     // Only break after commas for generic type constraints.
4299     if (Line.First->is(TT_CSharpGenericTypeConstraint))
4300       return Left.is(TT_CSharpGenericTypeConstraintComma);
4301     // Keep nullable operators attached to their identifiers.
4302     if (Right.is(TT_CSharpNullable))
4303       return false;
4304   } else if (Style.Language == FormatStyle::LK_Java) {
4305     if (Left.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
4306                      Keywords.kw_implements))
4307       return false;
4308     if (Right.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
4309                       Keywords.kw_implements))
4310       return true;
4311   } else if (Style.isJavaScript()) {
4312     const FormatToken *NonComment = Right.getPreviousNonComment();
4313     if (NonComment &&
4314         NonComment->isOneOf(
4315             tok::kw_return, Keywords.kw_yield, tok::kw_continue, tok::kw_break,
4316             tok::kw_throw, Keywords.kw_interface, Keywords.kw_type,
4317             tok::kw_static, tok::kw_public, tok::kw_private, tok::kw_protected,
4318             Keywords.kw_readonly, Keywords.kw_override, Keywords.kw_abstract,
4319             Keywords.kw_get, Keywords.kw_set, Keywords.kw_async,
4320             Keywords.kw_await))
4321       return false; // Otherwise automatic semicolon insertion would trigger.
4322     if (Right.NestingLevel == 0 &&
4323         (Left.Tok.getIdentifierInfo() ||
4324          Left.isOneOf(tok::r_square, tok::r_paren)) &&
4325         Right.isOneOf(tok::l_square, tok::l_paren))
4326       return false; // Otherwise automatic semicolon insertion would trigger.
4327     if (NonComment && NonComment->is(tok::identifier) &&
4328         NonComment->TokenText == "asserts")
4329       return false;
4330     if (Left.is(TT_FatArrow) && Right.is(tok::l_brace))
4331       return false;
4332     if (Left.is(TT_JsTypeColon))
4333       return true;
4334     // Don't wrap between ":" and "!" of a strict prop init ("field!: type;").
4335     if (Left.is(tok::exclaim) && Right.is(tok::colon))
4336       return false;
4337     // Look for is type annotations like:
4338     // function f(): a is B { ... }
4339     // Do not break before is in these cases.
4340     if (Right.is(Keywords.kw_is)) {
4341       const FormatToken *Next = Right.getNextNonComment();
4342       // If `is` is followed by a colon, it's likely that it's a dict key, so
4343       // ignore it for this check.
4344       // For example this is common in Polymer:
4345       // Polymer({
4346       //   is: 'name',
4347       //   ...
4348       // });
4349       if (!Next || !Next->is(tok::colon))
4350         return false;
4351     }
4352     if (Left.is(Keywords.kw_in))
4353       return Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None;
4354     if (Right.is(Keywords.kw_in))
4355       return Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None;
4356     if (Right.is(Keywords.kw_as))
4357       return false; // must not break before as in 'x as type' casts
4358     if (Right.isOneOf(Keywords.kw_extends, Keywords.kw_infer)) {
4359       // extends and infer can appear as keywords in conditional types:
4360       //   https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#conditional-types
4361       // do not break before them, as the expressions are subject to ASI.
4362       return false;
4363     }
4364     if (Left.is(Keywords.kw_as))
4365       return true;
4366     if (Left.is(TT_NonNullAssertion))
4367       return true;
4368     if (Left.is(Keywords.kw_declare) &&
4369         Right.isOneOf(Keywords.kw_module, tok::kw_namespace,
4370                       Keywords.kw_function, tok::kw_class, tok::kw_enum,
4371                       Keywords.kw_interface, Keywords.kw_type, Keywords.kw_var,
4372                       Keywords.kw_let, tok::kw_const))
4373       // See grammar for 'declare' statements at:
4374       // https://github.com/Microsoft/TypeScript/blob/main/doc/spec-ARCHIVED.md#A.10
4375       return false;
4376     if (Left.isOneOf(Keywords.kw_module, tok::kw_namespace) &&
4377         Right.isOneOf(tok::identifier, tok::string_literal))
4378       return false; // must not break in "module foo { ...}"
4379     if (Right.is(TT_TemplateString) && Right.closesScope())
4380       return false;
4381     // Don't split tagged template literal so there is a break between the tag
4382     // identifier and template string.
4383     if (Left.is(tok::identifier) && Right.is(TT_TemplateString))
4384       return false;
4385     if (Left.is(TT_TemplateString) && Left.opensScope())
4386       return true;
4387   }
4388 
4389   if (Left.is(tok::at))
4390     return false;
4391   if (Left.Tok.getObjCKeywordID() == tok::objc_interface)
4392     return false;
4393   if (Left.isOneOf(TT_JavaAnnotation, TT_LeadingJavaAnnotation))
4394     return !Right.is(tok::l_paren);
4395   if (Right.is(TT_PointerOrReference))
4396     return Line.IsMultiVariableDeclStmt ||
4397            (getTokenPointerOrReferenceAlignment(Right) ==
4398                 FormatStyle::PAS_Right &&
4399             (!Right.Next || Right.Next->isNot(TT_FunctionDeclarationName)));
4400   if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
4401       Right.is(tok::kw_operator))
4402     return true;
4403   if (Left.is(TT_PointerOrReference))
4404     return false;
4405   if (Right.isTrailingComment())
4406     // We rely on MustBreakBefore being set correctly here as we should not
4407     // change the "binding" behavior of a comment.
4408     // The first comment in a braced lists is always interpreted as belonging to
4409     // the first list element. Otherwise, it should be placed outside of the
4410     // list.
4411     return Left.is(BK_BracedInit) ||
4412            (Left.is(TT_CtorInitializerColon) &&
4413             Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon);
4414   if (Left.is(tok::question) && Right.is(tok::colon))
4415     return false;
4416   if (Right.is(TT_ConditionalExpr) || Right.is(tok::question))
4417     return Style.BreakBeforeTernaryOperators;
4418   if (Left.is(TT_ConditionalExpr) || Left.is(tok::question))
4419     return !Style.BreakBeforeTernaryOperators;
4420   if (Left.is(TT_InheritanceColon))
4421     return Style.BreakInheritanceList == FormatStyle::BILS_AfterColon;
4422   if (Right.is(TT_InheritanceColon))
4423     return Style.BreakInheritanceList != FormatStyle::BILS_AfterColon;
4424   if (Right.is(TT_ObjCMethodExpr) && !Right.is(tok::r_square) &&
4425       Left.isNot(TT_SelectorName))
4426     return true;
4427 
4428   if (Right.is(tok::colon) &&
4429       !Right.isOneOf(TT_CtorInitializerColon, TT_InlineASMColon))
4430     return false;
4431   if (Left.is(tok::colon) && Left.isOneOf(TT_DictLiteral, TT_ObjCMethodExpr)) {
4432     if (Style.Language == FormatStyle::LK_Proto ||
4433         Style.Language == FormatStyle::LK_TextProto) {
4434       if (!Style.AlwaysBreakBeforeMultilineStrings && Right.isStringLiteral())
4435         return false;
4436       // Prevent cases like:
4437       //
4438       // submessage:
4439       //     { key: valueeeeeeeeeeee }
4440       //
4441       // when the snippet does not fit into one line.
4442       // Prefer:
4443       //
4444       // submessage: {
4445       //   key: valueeeeeeeeeeee
4446       // }
4447       //
4448       // instead, even if it is longer by one line.
4449       //
4450       // Note that this allows allows the "{" to go over the column limit
4451       // when the column limit is just between ":" and "{", but that does
4452       // not happen too often and alternative formattings in this case are
4453       // not much better.
4454       //
4455       // The code covers the cases:
4456       //
4457       // submessage: { ... }
4458       // submessage: < ... >
4459       // repeated: [ ... ]
4460       if (((Right.is(tok::l_brace) || Right.is(tok::less)) &&
4461            Right.is(TT_DictLiteral)) ||
4462           Right.is(TT_ArrayInitializerLSquare))
4463         return false;
4464     }
4465     return true;
4466   }
4467   if (Right.is(tok::r_square) && Right.MatchingParen &&
4468       Right.MatchingParen->is(TT_ProtoExtensionLSquare))
4469     return false;
4470   if (Right.is(TT_SelectorName) || (Right.is(tok::identifier) && Right.Next &&
4471                                     Right.Next->is(TT_ObjCMethodExpr)))
4472     return Left.isNot(tok::period); // FIXME: Properly parse ObjC calls.
4473   if (Left.is(tok::r_paren) && Line.Type == LT_ObjCProperty)
4474     return true;
4475   if (Right.is(tok::kw_concept))
4476     return Style.BreakBeforeConceptDeclarations != FormatStyle::BBCDS_Never;
4477   if (Right.is(TT_RequiresClause))
4478     return true;
4479   if (Left.ClosesTemplateDeclaration || Left.is(TT_FunctionAnnotationRParen))
4480     return true;
4481   if (Left.ClosesRequiresClause)
4482     return true;
4483   if (Right.isOneOf(TT_RangeBasedForLoopColon, TT_OverloadedOperatorLParen,
4484                     TT_OverloadedOperator))
4485     return false;
4486   if (Left.is(TT_RangeBasedForLoopColon))
4487     return true;
4488   if (Right.is(TT_RangeBasedForLoopColon))
4489     return false;
4490   if (Left.is(TT_TemplateCloser) && Right.is(TT_TemplateOpener))
4491     return true;
4492   if ((Left.is(tok::greater) && Right.is(tok::greater)) ||
4493       (Left.is(tok::less) && Right.is(tok::less)))
4494     return false;
4495   if (Right.is(TT_BinaryOperator) &&
4496       Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None &&
4497       (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_All ||
4498        Right.getPrecedence() != prec::Assignment))
4499     return true;
4500   if (Left.isOneOf(TT_TemplateCloser, TT_UnaryOperator) ||
4501       Left.is(tok::kw_operator))
4502     return false;
4503   if (Left.is(tok::equal) && !Right.isOneOf(tok::kw_default, tok::kw_delete) &&
4504       Line.Type == LT_VirtualFunctionDecl && Left.NestingLevel == 0)
4505     return false;
4506   if (Left.is(tok::equal) && Right.is(tok::l_brace) &&
4507       !Style.Cpp11BracedListStyle)
4508     return false;
4509   if (Left.is(tok::l_paren) &&
4510       Left.isOneOf(TT_AttributeParen, TT_TypeDeclarationParen))
4511     return false;
4512   if (Left.is(tok::l_paren) && Left.Previous &&
4513       (Left.Previous->isOneOf(TT_BinaryOperator, TT_CastRParen)))
4514     return false;
4515   if (Right.is(TT_ImplicitStringLiteral))
4516     return false;
4517 
4518   if (Right.is(TT_TemplateCloser))
4519     return false;
4520   if (Right.is(tok::r_square) && Right.MatchingParen &&
4521       Right.MatchingParen->is(TT_LambdaLSquare))
4522     return false;
4523 
4524   // We only break before r_brace if there was a corresponding break before
4525   // the l_brace, which is tracked by BreakBeforeClosingBrace.
4526   if (Right.is(tok::r_brace))
4527     return Right.MatchingParen && Right.MatchingParen->is(BK_Block);
4528 
4529   // We only break before r_paren if we're in a block indented context.
4530   if (Right.is(tok::r_paren)) {
4531     if (Style.AlignAfterOpenBracket != FormatStyle::BAS_BlockIndent ||
4532         !Right.MatchingParen)
4533       return false;
4534     const FormatToken *Previous = Right.MatchingParen->Previous;
4535     return !(Previous && (Previous->is(tok::kw_for) || Previous->isIf()));
4536   }
4537 
4538   // Allow breaking after a trailing annotation, e.g. after a method
4539   // declaration.
4540   if (Left.is(TT_TrailingAnnotation))
4541     return !Right.isOneOf(tok::l_brace, tok::semi, tok::equal, tok::l_paren,
4542                           tok::less, tok::coloncolon);
4543 
4544   if (Right.is(tok::kw___attribute) ||
4545       (Right.is(tok::l_square) && Right.is(TT_AttributeSquare)))
4546     return !Left.is(TT_AttributeSquare);
4547 
4548   if (Left.is(tok::identifier) && Right.is(tok::string_literal))
4549     return true;
4550 
4551   if (Right.is(tok::identifier) && Right.Next && Right.Next->is(TT_DictLiteral))
4552     return true;
4553 
4554   if (Left.is(TT_CtorInitializerColon))
4555     return Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon;
4556   if (Right.is(TT_CtorInitializerColon))
4557     return Style.BreakConstructorInitializers != FormatStyle::BCIS_AfterColon;
4558   if (Left.is(TT_CtorInitializerComma) &&
4559       Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma)
4560     return false;
4561   if (Right.is(TT_CtorInitializerComma) &&
4562       Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma)
4563     return true;
4564   if (Left.is(TT_InheritanceComma) &&
4565       Style.BreakInheritanceList == FormatStyle::BILS_BeforeComma)
4566     return false;
4567   if (Right.is(TT_InheritanceComma) &&
4568       Style.BreakInheritanceList == FormatStyle::BILS_BeforeComma)
4569     return true;
4570   if (Left.is(TT_ArrayInitializerLSquare))
4571     return true;
4572   if (Right.is(tok::kw_typename) && Left.isNot(tok::kw_const))
4573     return true;
4574   if ((Left.isBinaryOperator() || Left.is(TT_BinaryOperator)) &&
4575       !Left.isOneOf(tok::arrowstar, tok::lessless) &&
4576       Style.BreakBeforeBinaryOperators != FormatStyle::BOS_All &&
4577       (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None ||
4578        Left.getPrecedence() == prec::Assignment))
4579     return true;
4580   if ((Left.is(TT_AttributeSquare) && Right.is(tok::l_square)) ||
4581       (Left.is(tok::r_square) && Right.is(TT_AttributeSquare)))
4582     return false;
4583 
4584   auto ShortLambdaOption = Style.AllowShortLambdasOnASingleLine;
4585   if (Style.BraceWrapping.BeforeLambdaBody && Right.is(TT_LambdaLBrace)) {
4586     if (isAllmanLambdaBrace(Left))
4587       return !isItAnEmptyLambdaAllowed(Left, ShortLambdaOption);
4588     if (isAllmanLambdaBrace(Right))
4589       return !isItAnEmptyLambdaAllowed(Right, ShortLambdaOption);
4590   }
4591 
4592   return Left.isOneOf(tok::comma, tok::coloncolon, tok::semi, tok::l_brace,
4593                       tok::kw_class, tok::kw_struct, tok::comment) ||
4594          Right.isMemberAccess() ||
4595          Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow, tok::lessless,
4596                        tok::colon, tok::l_square, tok::at) ||
4597          (Left.is(tok::r_paren) &&
4598           Right.isOneOf(tok::identifier, tok::kw_const)) ||
4599          (Left.is(tok::l_paren) && !Right.is(tok::r_paren)) ||
4600          (Left.is(TT_TemplateOpener) && !Right.is(TT_TemplateCloser));
4601 }
4602 
4603 void TokenAnnotator::printDebugInfo(const AnnotatedLine &Line) {
4604   llvm::errs() << "AnnotatedTokens(L=" << Line.Level << "):\n";
4605   const FormatToken *Tok = Line.First;
4606   while (Tok) {
4607     llvm::errs() << " M=" << Tok->MustBreakBefore
4608                  << " C=" << Tok->CanBreakBefore
4609                  << " T=" << getTokenTypeName(Tok->getType())
4610                  << " S=" << Tok->SpacesRequiredBefore
4611                  << " F=" << Tok->Finalized << " B=" << Tok->BlockParameterCount
4612                  << " BK=" << Tok->getBlockKind() << " P=" << Tok->SplitPenalty
4613                  << " Name=" << Tok->Tok.getName() << " L=" << Tok->TotalLength
4614                  << " PPK=" << Tok->getPackingKind() << " FakeLParens=";
4615     for (prec::Level LParen : Tok->FakeLParens)
4616       llvm::errs() << LParen << "/";
4617     llvm::errs() << " FakeRParens=" << Tok->FakeRParens;
4618     llvm::errs() << " II=" << Tok->Tok.getIdentifierInfo();
4619     llvm::errs() << " Text='" << Tok->TokenText << "'\n";
4620     if (!Tok->Next)
4621       assert(Tok == Line.Last);
4622     Tok = Tok->Next;
4623   }
4624   llvm::errs() << "----\n";
4625 }
4626 
4627 FormatStyle::PointerAlignmentStyle
4628 TokenAnnotator::getTokenReferenceAlignment(const FormatToken &Reference) {
4629   assert(Reference.isOneOf(tok::amp, tok::ampamp));
4630   switch (Style.ReferenceAlignment) {
4631   case FormatStyle::RAS_Pointer:
4632     return Style.PointerAlignment;
4633   case FormatStyle::RAS_Left:
4634     return FormatStyle::PAS_Left;
4635   case FormatStyle::RAS_Right:
4636     return FormatStyle::PAS_Right;
4637   case FormatStyle::RAS_Middle:
4638     return FormatStyle::PAS_Middle;
4639   }
4640   assert(0); //"Unhandled value of ReferenceAlignment"
4641   return Style.PointerAlignment;
4642 }
4643 
4644 FormatStyle::PointerAlignmentStyle
4645 TokenAnnotator::getTokenPointerOrReferenceAlignment(
4646     const FormatToken &PointerOrReference) {
4647   if (PointerOrReference.isOneOf(tok::amp, tok::ampamp)) {
4648     switch (Style.ReferenceAlignment) {
4649     case FormatStyle::RAS_Pointer:
4650       return Style.PointerAlignment;
4651     case FormatStyle::RAS_Left:
4652       return FormatStyle::PAS_Left;
4653     case FormatStyle::RAS_Right:
4654       return FormatStyle::PAS_Right;
4655     case FormatStyle::RAS_Middle:
4656       return FormatStyle::PAS_Middle;
4657     }
4658   }
4659   assert(PointerOrReference.is(tok::star));
4660   return Style.PointerAlignment;
4661 }
4662 
4663 } // namespace format
4664 } // namespace clang
4665