granicus.if.org Git - clang/blob - lib/Format/TokenAnnotator.cpp

   1 //===--- TokenAnnotator.cpp - Format C++ code -----------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 ///
  10 /// \file
  11 /// \brief This file implements a token annotator, i.e. creates
  12 /// \c AnnotatedTokens out of \c FormatTokens with required extra information.
  13 ///
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "TokenAnnotator.h"
  17 #include "clang/Basic/SourceManager.h"
  18 #include "llvm/ADT/SmallPtrSet.h"
  19 #include "llvm/Support/Debug.h"
  20
  21 #define DEBUG_TYPE "format-token-annotator"
  22
  23 namespace clang {
  24 namespace format {
  25
  26 namespace {
  27
  28 /// \brief A parser that gathers additional information about tokens.
  29 ///
  30 /// The \c TokenAnnotator tries to match parenthesis and square brakets and
  31 /// store a parenthesis levels. It also tries to resolve matching "<" and ">"
  32 /// into template parameter lists.
  33 class AnnotatingParser {
  34 public:
  35   AnnotatingParser(const FormatStyle &Style, AnnotatedLine &Line,
  36                    const AdditionalKeywords &Keywords)
  37       : Style(Style), Line(Line), CurrentToken(Line.First), AutoFound(false),
  38         Keywords(Keywords) {
  39     Contexts.push_back(Context(tok::unknown, 1, /*IsExpression=*/false));
  40     resetTokenMetadata(CurrentToken);
  41   }
  42
  43 private:
  44   bool parseAngle() {
  45     if (!CurrentToken || !CurrentToken->Previous)
  46       return false;
  47     if (NonTemplateLess.count(CurrentToken->Previous))
  48       return false;
  49
  50     const FormatToken& Previous = *CurrentToken->Previous;
  51     if (Previous.Previous) {
  52       if (Previous.Previous->Tok.isLiteral())
  53         return false;
  54       if (Previous.Previous->is(tok::r_paren) && Contexts.size() > 1 &&
  55           (!Previous.Previous->MatchingParen ||
  56            !Previous.Previous->MatchingParen->is(TT_OverloadedOperatorLParen)))
  57         return false;
  58     }
  59
  60     FormatToken *Left = CurrentToken->Previous;
  61     Left->ParentBracket = Contexts.back().ContextKind;
  62     ScopedContextCreator ContextCreator(*this, tok::less, 12);
  63
  64     // If this angle is in the context of an expression, we need to be more
  65     // hesitant to detect it as opening template parameters.
  66     bool InExprContext = Contexts.back().IsExpression;
  67
  68     Contexts.back().IsExpression = false;
  69     // If there's a template keyword before the opening angle bracket, this is a
  70     // template parameter, not an argument.
  71     Contexts.back().InTemplateArgument =
  72         Left->Previous && Left->Previous->Tok.isNot(tok::kw_template);
  73
  74     if (Style.Language == FormatStyle::LK_Java &&
  75         CurrentToken->is(tok::question))
  76       next();
  77
  78     while (CurrentToken) {
  79       if (CurrentToken->is(tok::greater)) {
  80         Left->MatchingParen = CurrentToken;
  81         CurrentToken->MatchingParen = Left;
  82         CurrentToken->Type = TT_TemplateCloser;
  83         next();
  84         return true;
  85       }
  86       if (CurrentToken->is(tok::question) &&
  87           Style.Language == FormatStyle::LK_Java) {
  88         next();
  89         continue;
  90       }
  91       if (CurrentToken->isOneOf(tok::r_paren, tok::r_square, tok::r_brace) ||
  92           (CurrentToken->isOneOf(tok::colon, tok::question) && InExprContext))
  93         return false;
  94       // If a && or || is found and interpreted as a binary operator, this set
  95       // of angles is likely part of something like "a < b && c > d". If the
  96       // angles are inside an expression, the ||/&& might also be a binary
  97       // operator that was misinterpreted because we are parsing template
  98       // parameters.
  99       // FIXME: This is getting out of hand, write a decent parser.
 100       if (CurrentToken->Previous->isOneOf(tok::pipepipe, tok::ampamp) &&
 101           CurrentToken->Previous->is(TT_BinaryOperator) &&
 102           Contexts[Contexts.size() - 2].IsExpression &&
 103           !Line.startsWith(tok::kw_template))
 104         return false;
 105       updateParameterCount(Left, CurrentToken);
 106       if (!consumeToken())
 107         return false;
 108     }
 109     return false;
 110   }
 111
 112   bool parseParens(bool LookForDecls = false) {
 113     if (!CurrentToken)
 114       return false;
 115     FormatToken *Left = CurrentToken->Previous;
 116     Left->ParentBracket = Contexts.back().ContextKind;
 117     ScopedContextCreator ContextCreator(*this, tok::l_paren, 1);
 118
 119     // FIXME: This is a bit of a hack. Do better.
 120     Contexts.back().ColonIsForRangeExpr =
 121         Contexts.size() == 2 && Contexts[0].ColonIsForRangeExpr;
 122
 123     bool StartsObjCMethodExpr = false;
 124     if (CurrentToken->is(tok::caret)) {
 125       // (^ can start a block type.
 126       Left->Type = TT_ObjCBlockLParen;
 127     } else if (FormatToken *MaybeSel = Left->Previous) {
 128       // @selector( starts a selector.
 129       if (MaybeSel->isObjCAtKeyword(tok::objc_selector) && MaybeSel->Previous &&
 130           MaybeSel->Previous->is(tok::at)) {
 131         StartsObjCMethodExpr = true;
 132       }
 133     }
 134
 135     if (Left->is(TT_OverloadedOperatorLParen)) {
 136       Contexts.back().IsExpression = false;
 137     } else if (Style.Language == FormatStyle::LK_JavaScript &&
 138                Line.startsWith(Keywords.kw_type, tok::identifier)) {
 139       // type X = (...);
 140       Contexts.back().IsExpression = false;
 141     } else if (Left->Previous &&
 142         (Left->Previous->isOneOf(tok::kw_static_assert, tok::kw_decltype,
 143                                  tok::kw_if, tok::kw_while, tok::l_paren,
 144                                  tok::comma) ||
 145          Left->Previous->is(TT_BinaryOperator))) {
 146       // static_assert, if and while usually contain expressions.
 147       Contexts.back().IsExpression = true;
 148     } else if (Style.Language == FormatStyle::LK_JavaScript && Left->Previous &&
 149                (Left->Previous->is(Keywords.kw_function) ||
 150                 (Left->Previous->endsSequence(tok::identifier,
 151                                               Keywords.kw_function)))) {
 152       // function(...) or function f(...)
 153       Contexts.back().IsExpression = false;
 154     } else if (Style.Language == FormatStyle::LK_JavaScript && Left->Previous &&
 155                Left->Previous->is(TT_JsTypeColon)) {
 156       // let x: (SomeType);
 157       Contexts.back().IsExpression = false;
 158     } else if (Left->Previous && Left->Previous->is(tok::r_square) &&
 159                Left->Previous->MatchingParen &&
 160                Left->Previous->MatchingParen->is(TT_LambdaLSquare)) {
 161       // This is a parameter list of a lambda expression.
 162       Contexts.back().IsExpression = false;
 163     } else if (Line.InPPDirective &&
 164                (!Left->Previous || !Left->Previous->is(tok::identifier))) {
 165       Contexts.back().IsExpression = true;
 166     } else if (Contexts[Contexts.size() - 2].CaretFound) {
 167       // This is the parameter list of an ObjC block.
 168       Contexts.back().IsExpression = false;
 169     } else if (Left->Previous && Left->Previous->is(tok::kw___attribute)) {
 170       Left->Type = TT_AttributeParen;
 171     } else if (Left->Previous && Left->Previous->is(TT_ForEachMacro)) {
 172       // The first argument to a foreach macro is a declaration.
 173       Contexts.back().IsForEachMacro = true;
 174       Contexts.back().IsExpression = false;
 175     } else if (Left->Previous && Left->Previous->MatchingParen &&
 176                Left->Previous->MatchingParen->is(TT_ObjCBlockLParen)) {
 177       Contexts.back().IsExpression = false;
 178     } else if (!Line.MustBeDeclaration && !Line.InPPDirective) {
 179       bool IsForOrCatch =
 180           Left->Previous && Left->Previous->isOneOf(tok::kw_for, tok::kw_catch);
 181       Contexts.back().IsExpression = !IsForOrCatch;
 182     }
 183
 184     if (StartsObjCMethodExpr) {
 185       Contexts.back().ColonIsObjCMethodExpr = true;
 186       Left->Type = TT_ObjCMethodExpr;
 187     }
 188
 189     bool MightBeFunctionType = !Contexts[Contexts.size() - 2].IsExpression;
 190     bool ProbablyFunctionType = CurrentToken->isOneOf(tok::star, tok::amp);
 191     bool HasMultipleLines = false;
 192     bool HasMultipleParametersOnALine = false;
 193     bool MightBeObjCForRangeLoop =
 194         Left->Previous && Left->Previous->is(tok::kw_for);
 195     while (CurrentToken) {
 196       // LookForDecls is set when "if (" has been seen. Check for
 197       // 'identifier' '*' 'identifier' followed by not '=' -- this
 198       // '*' has to be a binary operator but determineStarAmpUsage() will
 199       // categorize it as an unary operator, so set the right type here.
 200       if (LookForDecls && CurrentToken->Next) {
 201         FormatToken *Prev = CurrentToken->getPreviousNonComment();
 202         if (Prev) {
 203           FormatToken *PrevPrev = Prev->getPreviousNonComment();
 204           FormatToken *Next = CurrentToken->Next;
 205           if (PrevPrev && PrevPrev->is(tok::identifier) &&
 206               Prev->isOneOf(tok::star, tok::amp, tok::ampamp) &&
 207               CurrentToken->is(tok::identifier) && Next->isNot(tok::equal)) {
 208             Prev->Type = TT_BinaryOperator;
 209             LookForDecls = false;
 210           }
 211         }
 212       }
 213
 214       if (CurrentToken->Previous->is(TT_PointerOrReference) &&
 215           CurrentToken->Previous->Previous->isOneOf(tok::l_paren,
 216                                                     tok::coloncolon))
 217         ProbablyFunctionType = true;
 218       if (CurrentToken->is(tok::comma))
 219         MightBeFunctionType = false;
 220       if (CurrentToken->Previous->is(TT_BinaryOperator))
 221         Contexts.back().IsExpression = true;
 222       if (CurrentToken->is(tok::r_paren)) {
 223         if (MightBeFunctionType && ProbablyFunctionType && CurrentToken->Next &&
 224             (CurrentToken->Next->is(tok::l_paren) ||
 225              (CurrentToken->Next->is(tok::l_square) && Line.MustBeDeclaration)))
 226           Left->Type = TT_FunctionTypeLParen;
 227         Left->MatchingParen = CurrentToken;
 228         CurrentToken->MatchingParen = Left;
 229
 230         if (CurrentToken->Next && CurrentToken->Next->is(tok::l_brace) &&
 231             Left->Previous && Left->Previous->is(tok::l_paren)) {
 232           // Detect the case where macros are used to generate lambdas or
 233           // function bodies, e.g.:
 234           //   auto my_lambda = MARCO((Type *type, int i) { .. body .. });
 235           for (FormatToken *Tok = Left; Tok != CurrentToken; Tok = Tok->Next) {
 236             if (Tok->is(TT_BinaryOperator) &&
 237                 Tok->isOneOf(tok::star, tok::amp, tok::ampamp))
 238               Tok->Type = TT_PointerOrReference;
 239           }
 240         }
 241
 242         if (StartsObjCMethodExpr) {
 243           CurrentToken->Type = TT_ObjCMethodExpr;
 244           if (Contexts.back().FirstObjCSelectorName) {
 245             Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
 246                 Contexts.back().LongestObjCSelectorName;
 247           }
 248         }
 249
 250         if (Left->is(TT_AttributeParen))
 251           CurrentToken->Type = TT_AttributeParen;
 252         if (Left->Previous && Left->Previous->is(TT_JavaAnnotation))
 253           CurrentToken->Type = TT_JavaAnnotation;
 254         if (Left->Previous && Left->Previous->is(TT_LeadingJavaAnnotation))
 255           CurrentToken->Type = TT_LeadingJavaAnnotation;
 256
 257         if (!HasMultipleLines)
 258           Left->PackingKind = PPK_Inconclusive;
 259         else if (HasMultipleParametersOnALine)
 260           Left->PackingKind = PPK_BinPacked;
 261         else
 262           Left->PackingKind = PPK_OnePerLine;
 263
 264         next();
 265         return true;
 266       }
 267       if (CurrentToken->isOneOf(tok::r_square, tok::r_brace))
 268         return false;
 269
 270       if (CurrentToken->is(tok::l_brace))
 271         Left->Type = TT_Unknown; // Not TT_ObjCBlockLParen
 272       if (CurrentToken->is(tok::comma) && CurrentToken->Next &&
 273           !CurrentToken->Next->HasUnescapedNewline &&
 274           !CurrentToken->Next->isTrailingComment())
 275         HasMultipleParametersOnALine = true;
 276       if ((CurrentToken->Previous->isOneOf(tok::kw_const, tok::kw_auto) ||
 277            CurrentToken->Previous->isSimpleTypeSpecifier()) &&
 278           !CurrentToken->is(tok::l_brace))
 279         Contexts.back().IsExpression = false;
 280       if (CurrentToken->isOneOf(tok::semi, tok::colon))
 281         MightBeObjCForRangeLoop = false;
 282       if (MightBeObjCForRangeLoop && CurrentToken->is(Keywords.kw_in))
 283         CurrentToken->Type = TT_ObjCForIn;
 284       // When we discover a 'new', we set CanBeExpression to 'false' in order to
 285       // parse the type correctly. Reset that after a comma.
 286       if (CurrentToken->is(tok::comma))
 287         Contexts.back().CanBeExpression = true;
 288
 289       FormatToken *Tok = CurrentToken;
 290       if (!consumeToken())
 291         return false;
 292       updateParameterCount(Left, Tok);
 293       if (CurrentToken && CurrentToken->HasUnescapedNewline)
 294         HasMultipleLines = true;
 295     }
 296     return false;
 297   }
 298
 299   bool parseSquare() {
 300     if (!CurrentToken)
 301       return false;
 302
 303     // A '[' could be an index subscript (after an identifier or after
 304     // ')' or ']'), it could be the start of an Objective-C method
 305     // expression, or it could the start of an Objective-C array literal.
 306     FormatToken *Left = CurrentToken->Previous;
 307     Left->ParentBracket = Contexts.back().ContextKind;
 308     FormatToken *Parent = Left->getPreviousNonComment();
 309
 310     // Cases where '>' is followed by '['.
 311     // In C++, this can happen either in array of templates (foo<int>[10])
 312     // or when array is a nested template type (unique_ptr<type1<type2>[]>).
 313     bool CppArrayTemplates =
 314         Style.IsCpp() && Parent &&
 315         Parent->is(TT_TemplateCloser) &&
 316         (Contexts.back().CanBeExpression || Contexts.back().IsExpression ||
 317          Contexts.back().InTemplateArgument);
 318
 319     bool StartsObjCMethodExpr =
 320         !CppArrayTemplates && Style.IsCpp() &&
 321         Contexts.back().CanBeExpression && Left->isNot(TT_LambdaLSquare) &&
 322         CurrentToken->isNot(tok::l_brace) &&
 323         (!Parent ||
 324          Parent->isOneOf(tok::colon, tok::l_square, tok::l_paren,
 325                          tok::kw_return, tok::kw_throw) ||
 326          Parent->isUnaryOperator() ||
 327          Parent->isOneOf(TT_ObjCForIn, TT_CastRParen) ||
 328          getBinOpPrecedence(Parent->Tok.getKind(), true, true) > prec::Unknown);
 329     bool ColonFound = false;
 330
 331     unsigned BindingIncrease = 1;
 332     if (Left->is(TT_Unknown)) {
 333       if (StartsObjCMethodExpr) {
 334         Left->Type = TT_ObjCMethodExpr;
 335       } else if (Style.Language == FormatStyle::LK_JavaScript && Parent &&
 336                  Contexts.back().ContextKind == tok::l_brace &&
 337                  Parent->isOneOf(tok::l_brace, tok::comma)) {
 338         Left->Type = TT_JsComputedPropertyName;
 339       } else if (CurrentToken->is(tok::r_square) && Parent &&
 340                  Parent->is(TT_TemplateCloser)) {
 341         Left->Type = TT_ArraySubscriptLSquare;
 342       } else if (Style.Language == FormatStyle::LK_Proto ||
 343                  (!CppArrayTemplates && Parent &&
 344                   Parent->isOneOf(TT_BinaryOperator, TT_TemplateCloser, tok::at,
 345                                   tok::comma, tok::l_paren, tok::l_square,
 346                                   tok::question, tok::colon, tok::kw_return,
 347                                   // Should only be relevant to JavaScript:
 348                                   tok::kw_default))) {
 349         Left->Type = TT_ArrayInitializerLSquare;
 350       } else {
 351         BindingIncrease = 10;
 352         Left->Type = TT_ArraySubscriptLSquare;
 353       }
 354     }
 355
 356     ScopedContextCreator ContextCreator(*this, tok::l_square, BindingIncrease);
 357     Contexts.back().IsExpression = true;
 358     Contexts.back().ColonIsObjCMethodExpr = StartsObjCMethodExpr;
 359
 360     while (CurrentToken) {
 361       if (CurrentToken->is(tok::r_square)) {
 362         if (CurrentToken->Next && CurrentToken->Next->is(tok::l_paren) &&
 363             Left->is(TT_ObjCMethodExpr)) {
 364           // An ObjC method call is rarely followed by an open parenthesis.
 365           // FIXME: Do we incorrectly label ":" with this?
 366           StartsObjCMethodExpr = false;
 367           Left->Type = TT_Unknown;
 368         }
 369         if (StartsObjCMethodExpr && CurrentToken->Previous != Left) {
 370           CurrentToken->Type = TT_ObjCMethodExpr;
 371           // determineStarAmpUsage() thinks that '*' '[' is allocating an
 372           // array of pointers, but if '[' starts a selector then '*' is a
 373           // binary operator.
 374           if (Parent && Parent->is(TT_PointerOrReference))
 375             Parent->Type = TT_BinaryOperator;
 376         }
 377         Left->MatchingParen = CurrentToken;
 378         CurrentToken->MatchingParen = Left;
 379         if (Contexts.back().FirstObjCSelectorName) {
 380           Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
 381               Contexts.back().LongestObjCSelectorName;
 382           if (Left->BlockParameterCount > 1)
 383             Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName = 0;
 384         }
 385         next();
 386         return true;
 387       }
 388       if (CurrentToken->isOneOf(tok::r_paren, tok::r_brace))
 389         return false;
 390       if (CurrentToken->is(tok::colon)) {
 391         if (Left->is(TT_ArraySubscriptLSquare)) {
 392           Left->Type = TT_ObjCMethodExpr;
 393           StartsObjCMethodExpr = true;
 394           Contexts.back().ColonIsObjCMethodExpr = true;
 395           if (Parent && Parent->is(tok::r_paren))
 396             Parent->Type = TT_CastRParen;
 397         }
 398         ColonFound = true;
 399       }
 400       if (CurrentToken->is(tok::comma) && Left->is(TT_ObjCMethodExpr) &&
 401           !ColonFound)
 402         Left->Type = TT_ArrayInitializerLSquare;
 403       FormatToken *Tok = CurrentToken;
 404       if (!consumeToken())
 405         return false;
 406       updateParameterCount(Left, Tok);
 407     }
 408     return false;
 409   }
 410
 411   bool parseBrace() {
 412     if (CurrentToken) {
 413       FormatToken *Left = CurrentToken->Previous;
 414       Left->ParentBracket = Contexts.back().ContextKind;
 415
 416       if (Contexts.back().CaretFound)
 417         Left->Type = TT_ObjCBlockLBrace;
 418       Contexts.back().CaretFound = false;
 419
 420       ScopedContextCreator ContextCreator(*this, tok::l_brace, 1);
 421       Contexts.back().ColonIsDictLiteral = true;
 422       if (Left->BlockKind == BK_BracedInit)
 423         Contexts.back().IsExpression = true;
 424
 425       while (CurrentToken) {
 426         if (CurrentToken->is(tok::r_brace)) {
 427           Left->MatchingParen = CurrentToken;
 428           CurrentToken->MatchingParen = Left;
 429           next();
 430           return true;
 431         }
 432         if (CurrentToken->isOneOf(tok::r_paren, tok::r_square))
 433           return false;
 434         updateParameterCount(Left, CurrentToken);
 435         if (CurrentToken->isOneOf(tok::colon, tok::l_brace)) {
 436           FormatToken *Previous = CurrentToken->getPreviousNonComment();
 437           if (((CurrentToken->is(tok::colon) &&
 438                 (!Contexts.back().ColonIsDictLiteral || !Style.IsCpp())) ||
 439                Style.Language == FormatStyle::LK_Proto) &&
 440               (Previous->Tok.getIdentifierInfo() ||
 441                Previous->is(tok::string_literal)))
 442             Previous->Type = TT_SelectorName;
 443           if (CurrentToken->is(tok::colon) ||
 444               Style.Language == FormatStyle::LK_JavaScript)
 445             Left->Type = TT_DictLiteral;
 446         }
 447         if (CurrentToken->is(tok::comma) &&
 448             Style.Language == FormatStyle::LK_JavaScript)
 449           Left->Type = TT_DictLiteral;
 450         if (!consumeToken())
 451           return false;
 452       }
 453     }
 454     return true;
 455   }
 456
 457   void updateParameterCount(FormatToken *Left, FormatToken *Current) {
 458     if (Current->is(tok::l_brace) && Current->BlockKind == BK_Block)
 459       ++Left->BlockParameterCount;
 460     if (Current->is(tok::comma)) {
 461       ++Left->ParameterCount;
 462       if (!Left->Role)
 463         Left->Role.reset(new CommaSeparatedList(Style));
 464       Left->Role->CommaFound(Current);
 465     } else if (Left->ParameterCount == 0 && Current->isNot(tok::comment)) {
 466       Left->ParameterCount = 1;
 467     }
 468   }
 469
 470   bool parseConditional() {
 471     while (CurrentToken) {
 472       if (CurrentToken->is(tok::colon)) {
 473         CurrentToken->Type = TT_ConditionalExpr;
 474         next();
 475         return true;
 476       }
 477       if (!consumeToken())
 478         return false;
 479     }
 480     return false;
 481   }
 482
 483   bool parseTemplateDeclaration() {
 484     if (CurrentToken && CurrentToken->is(tok::less)) {
 485       CurrentToken->Type = TT_TemplateOpener;
 486       next();
 487       if (!parseAngle())
 488         return false;
 489       if (CurrentToken)
 490         CurrentToken->Previous->ClosesTemplateDeclaration = true;
 491       return true;
 492     }
 493     return false;
 494   }
 495
 496   bool consumeToken() {
 497     FormatToken *Tok = CurrentToken;
 498     next();
 499     switch (Tok->Tok.getKind()) {
 500     case tok::plus:
 501     case tok::minus:
 502       if (!Tok->Previous && Line.MustBeDeclaration)
 503         Tok->Type = TT_ObjCMethodSpecifier;
 504       break;
 505     case tok::colon:
 506       if (!Tok->Previous)
 507         return false;
 508       // Colons from ?: are handled in parseConditional().
 509       if (Style.Language == FormatStyle::LK_JavaScript) {
 510         if (Contexts.back().ColonIsForRangeExpr || // colon in for loop
 511             (Contexts.size() == 1 &&               // switch/case labels
 512              !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) ||
 513             Contexts.back().ContextKind == tok::l_paren ||  // function params
 514             Contexts.back().ContextKind == tok::l_square || // array type
 515             (Contexts.size() == 1 &&
 516              Line.MustBeDeclaration)) { // method/property declaration
 517           Tok->Type = TT_JsTypeColon;
 518           break;
 519         }
 520       }
 521       if (Contexts.back().ColonIsDictLiteral ||
 522           Style.Language == FormatStyle::LK_Proto) {
 523         Tok->Type = TT_DictLiteral;
 524       } else if (Contexts.back().ColonIsObjCMethodExpr ||
 525                  Line.startsWith(TT_ObjCMethodSpecifier)) {
 526         Tok->Type = TT_ObjCMethodExpr;
 527         const FormatToken *BeforePrevious = Tok->Previous->Previous;
 528         if (!BeforePrevious ||
 529             !(BeforePrevious->is(TT_CastRParen) ||
 530               (BeforePrevious->is(TT_ObjCMethodExpr) &&
 531                BeforePrevious->is(tok::colon))) ||
 532             BeforePrevious->is(tok::r_square) ||
 533             Contexts.back().LongestObjCSelectorName == 0) {
 534           Tok->Previous->Type = TT_SelectorName;
 535           if (Tok->Previous->ColumnWidth >
 536               Contexts.back().LongestObjCSelectorName)
 537             Contexts.back().LongestObjCSelectorName =
 538                 Tok->Previous->ColumnWidth;
 539           if (!Contexts.back().FirstObjCSelectorName)
 540             Contexts.back().FirstObjCSelectorName = Tok->Previous;
 541         }
 542       } else if (Contexts.back().ColonIsForRangeExpr) {
 543         Tok->Type = TT_RangeBasedForLoopColon;
 544       } else if (CurrentToken && CurrentToken->is(tok::numeric_constant)) {
 545         Tok->Type = TT_BitFieldColon;
 546       } else if (Contexts.size() == 1 &&
 547                  !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) {
 548         if (Tok->getPreviousNonComment()->isOneOf(tok::r_paren,
 549                                                   tok::kw_noexcept))
 550           Tok->Type = TT_CtorInitializerColon;
 551         else
 552           Tok->Type = TT_InheritanceColon;
 553       } else if (Tok->Previous->is(tok::identifier) && Tok->Next &&
 554                  Tok->Next->isOneOf(tok::r_paren, tok::comma)) {
 555         // This handles a special macro in ObjC code where selectors including
 556         // the colon are passed as macro arguments.
 557         Tok->Type = TT_ObjCMethodExpr;
 558       } else if (Contexts.back().ContextKind == tok::l_paren) {
 559         Tok->Type = TT_InlineASMColon;
 560       }
 561       break;
 562     case tok::pipe:
 563     case tok::amp:
 564       // | and & in declarations/type expressions represent union and
 565       // intersection types, respectively.
 566       if (Style.Language == FormatStyle::LK_JavaScript &&
 567           !Contexts.back().IsExpression)
 568         Tok->Type = TT_JsTypeOperator;
 569       break;
 570     case tok::kw_if:
 571     case tok::kw_while:
 572       if (CurrentToken && CurrentToken->is(tok::l_paren)) {
 573         next();
 574         if (!parseParens(/*LookForDecls=*/true))
 575           return false;
 576       }
 577       break;
 578     case tok::kw_for:
 579       if (Style.Language == FormatStyle::LK_JavaScript && Tok->Previous &&
 580           Tok->Previous->is(tok::period))
 581         break;
 582       Contexts.back().ColonIsForRangeExpr = true;
 583       next();
 584       if (!parseParens())
 585         return false;
 586       break;
 587     case tok::l_paren:
 588       // When faced with 'operator()()', the kw_operator handler incorrectly
 589       // marks the first l_paren as a OverloadedOperatorLParen. Here, we make
 590       // the first two parens OverloadedOperators and the second l_paren an
 591       // OverloadedOperatorLParen.
 592       if (Tok->Previous &&
 593           Tok->Previous->is(tok::r_paren) &&
 594           Tok->Previous->MatchingParen &&
 595           Tok->Previous->MatchingParen->is(TT_OverloadedOperatorLParen)) {
 596         Tok->Previous->Type = TT_OverloadedOperator;
 597         Tok->Previous->MatchingParen->Type = TT_OverloadedOperator;
 598         Tok->Type = TT_OverloadedOperatorLParen;
 599       }
 600
 601       if (!parseParens())
 602         return false;
 603       if (Line.MustBeDeclaration && Contexts.size() == 1 &&
 604           !Contexts.back().IsExpression && !Line.startsWith(TT_ObjCProperty) &&
 605           (!Tok->Previous ||
 606            !Tok->Previous->isOneOf(tok::kw_decltype, tok::kw___attribute,
 607                                    TT_LeadingJavaAnnotation)))
 608         Line.MightBeFunctionDecl = true;
 609       break;
 610     case tok::l_square:
 611       if (!parseSquare())
 612         return false;
 613       break;
 614     case tok::l_brace:
 615       if (!parseBrace())
 616         return false;
 617       break;
 618     case tok::less:
 619       if (parseAngle()) {
 620         Tok->Type = TT_TemplateOpener;
 621       } else {
 622         Tok->Type = TT_BinaryOperator;
 623         NonTemplateLess.insert(Tok);
 624         CurrentToken = Tok;
 625         next();
 626       }
 627       break;
 628     case tok::r_paren:
 629     case tok::r_square:
 630       return false;
 631     case tok::r_brace:
 632       // Lines can start with '}'.
 633       if (Tok->Previous)
 634         return false;
 635       break;
 636     case tok::greater:
 637       Tok->Type = TT_BinaryOperator;
 638       break;
 639     case tok::kw_operator:
 640       while (CurrentToken &&
 641              !CurrentToken->isOneOf(tok::l_paren, tok::semi, tok::r_paren)) {
 642         if (CurrentToken->isOneOf(tok::star, tok::amp))
 643           CurrentToken->Type = TT_PointerOrReference;
 644         consumeToken();
 645         if (CurrentToken &&
 646             CurrentToken->Previous->isOneOf(TT_BinaryOperator, tok::comma))
 647           CurrentToken->Previous->Type = TT_OverloadedOperator;
 648       }
 649       if (CurrentToken) {
 650         CurrentToken->Type = TT_OverloadedOperatorLParen;
 651         if (CurrentToken->Previous->is(TT_BinaryOperator))
 652           CurrentToken->Previous->Type = TT_OverloadedOperator;
 653       }
 654       break;
 655     case tok::question:
 656       if (Style.Language == FormatStyle::LK_JavaScript && Tok->Next &&
 657           Tok->Next->isOneOf(tok::semi, tok::comma, tok::colon, tok::r_paren,
 658                              tok::r_brace)) {
 659         // Question marks before semicolons, colons, etc. indicate optional
 660         // types (fields, parameters), e.g.
 661         //   function(x?: string, y?) {...}
 662         //   class X { y?; }
 663         Tok->Type = TT_JsTypeOptionalQuestion;
 664         break;
 665       }
 666       // Declarations cannot be conditional expressions, this can only be part
 667       // of a type declaration.
 668       if (Line.MustBeDeclaration && !Contexts.back().IsExpression &&
 669           Style.Language == FormatStyle::LK_JavaScript)
 670         break;
 671       parseConditional();
 672       break;
 673     case tok::kw_template:
 674       parseTemplateDeclaration();
 675       break;
 676     case tok::comma:
 677       if (Contexts.back().InCtorInitializer)
 678         Tok->Type = TT_CtorInitializerComma;
 679       else if (Contexts.back().FirstStartOfName &&
 680                (Contexts.size() == 1 || Line.startsWith(tok::kw_for))) {
 681         Contexts.back().FirstStartOfName->PartOfMultiVariableDeclStmt = true;
 682         Line.IsMultiVariableDeclStmt = true;
 683       }
 684       if (Contexts.back().IsForEachMacro)
 685         Contexts.back().IsExpression = true;
 686       break;
 687     case tok::identifier:
 688       if (Tok->isOneOf(Keywords.kw___has_include,
 689                        Keywords.kw___has_include_next)) {
 690         parseHasInclude();
 691       }
 692       break;
 693     default:
 694       break;
 695     }
 696     return true;
 697   }
 698
 699   void parseIncludeDirective() {
 700     if (CurrentToken && CurrentToken->is(tok::less)) {
 701       next();
 702       while (CurrentToken) {
 703         if (CurrentToken->isNot(tok::comment) || CurrentToken->Next)
 704           CurrentToken->Type = TT_ImplicitStringLiteral;
 705         next();
 706       }
 707     }
 708   }
 709
 710   void parseWarningOrError() {
 711     next();
 712     // We still want to format the whitespace left of the first token of the
 713     // warning or error.
 714     next();
 715     while (CurrentToken) {
 716       CurrentToken->Type = TT_ImplicitStringLiteral;
 717       next();
 718     }
 719   }
 720
 721   void parsePragma() {
 722     next(); // Consume "pragma".
 723     if (CurrentToken &&
 724         CurrentToken->isOneOf(Keywords.kw_mark, Keywords.kw_option)) {
 725       bool IsMark = CurrentToken->is(Keywords.kw_mark);
 726       next(); // Consume "mark".
 727       next(); // Consume first token (so we fix leading whitespace).
 728       while (CurrentToken) {
 729         if (IsMark || CurrentToken->Previous->is(TT_BinaryOperator))
 730           CurrentToken->Type = TT_ImplicitStringLiteral;
 731         next();
 732       }
 733     }
 734   }
 735
 736   void parseHasInclude() {
 737     if (!CurrentToken || !CurrentToken->is(tok::l_paren))
 738       return;
 739     next();  // '('
 740     parseIncludeDirective();
 741     next();  // ')'
 742   }
 743
 744   LineType parsePreprocessorDirective() {
 745     bool IsFirstToken = CurrentToken->IsFirst;
 746     LineType Type = LT_PreprocessorDirective;
 747     next();
 748     if (!CurrentToken)
 749       return Type;
 750
 751     if (Style.Language == FormatStyle::LK_JavaScript && IsFirstToken) {
 752       // JavaScript files can contain shebang lines of the form:
 753       // #!/usr/bin/env node
 754       // Treat these like C++ #include directives.
 755       while (CurrentToken) {
 756         // Tokens cannot be comments here.
 757         CurrentToken->Type = TT_ImplicitStringLiteral;
 758         next();
 759       }
 760       return LT_ImportStatement;
 761     }
 762
 763     if (CurrentToken->Tok.is(tok::numeric_constant)) {
 764       CurrentToken->SpacesRequiredBefore = 1;
 765       return Type;
 766     }
 767     // Hashes in the middle of a line can lead to any strange token
 768     // sequence.
 769     if (!CurrentToken->Tok.getIdentifierInfo())
 770       return Type;
 771     switch (CurrentToken->Tok.getIdentifierInfo()->getPPKeywordID()) {
 772     case tok::pp_include:
 773     case tok::pp_include_next:
 774     case tok::pp_import:
 775       next();
 776       parseIncludeDirective();
 777       Type = LT_ImportStatement;
 778       break;
 779     case tok::pp_error:
 780     case tok::pp_warning:
 781       parseWarningOrError();
 782       break;
 783     case tok::pp_pragma:
 784       parsePragma();
 785       break;
 786     case tok::pp_if:
 787     case tok::pp_elif:
 788       Contexts.back().IsExpression = true;
 789       parseLine();
 790       break;
 791     default:
 792       break;
 793     }
 794     while (CurrentToken) {
 795       FormatToken *Tok = CurrentToken;
 796       next();
 797       if (Tok->isOneOf(Keywords.kw___has_include,
 798                        Keywords.kw___has_include_next)) {
 799         parseHasInclude();
 800       }
 801     }
 802     return Type;
 803   }
 804
 805 public:
 806   LineType parseLine() {
 807     NonTemplateLess.clear();
 808     if (CurrentToken->is(tok::hash))
 809       return parsePreprocessorDirective();
 810
 811     // Directly allow to 'import <string-literal>' to support protocol buffer
 812     // definitions (code.google.com/p/protobuf) or missing "#" (either way we
 813     // should not break the line).
 814     IdentifierInfo *Info = CurrentToken->Tok.getIdentifierInfo();
 815     if ((Style.Language == FormatStyle::LK_Java &&
 816          CurrentToken->is(Keywords.kw_package)) ||
 817         (Info && Info->getPPKeywordID() == tok::pp_import &&
 818          CurrentToken->Next &&
 819          CurrentToken->Next->isOneOf(tok::string_literal, tok::identifier,
 820                                      tok::kw_static))) {
 821       next();
 822       parseIncludeDirective();
 823       return LT_ImportStatement;
 824     }
 825
 826     // If this line starts and ends in '<' and '>', respectively, it is likely
 827     // part of "#define <a/b.h>".
 828     if (CurrentToken->is(tok::less) && Line.Last->is(tok::greater)) {
 829       parseIncludeDirective();
 830       return LT_ImportStatement;
 831     }
 832
 833     // In .proto files, top-level options are very similar to import statements
 834     // and should not be line-wrapped.
 835     if (Style.Language == FormatStyle::LK_Proto && Line.Level == 0 &&
 836         CurrentToken->is(Keywords.kw_option)) {
 837       next();
 838       if (CurrentToken && CurrentToken->is(tok::identifier))
 839         return LT_ImportStatement;
 840     }
 841
 842     bool KeywordVirtualFound = false;
 843     bool ImportStatement = false;
 844
 845     // import {...} from '...';
 846     if (Style.Language == FormatStyle::LK_JavaScript &&
 847         CurrentToken->is(Keywords.kw_import))
 848       ImportStatement = true;
 849
 850     while (CurrentToken) {
 851       if (CurrentToken->is(tok::kw_virtual))
 852         KeywordVirtualFound = true;
 853       if (Style.Language == FormatStyle::LK_JavaScript) {
 854         // export {...} from '...';
 855         // An export followed by "from 'some string';" is a re-export from
 856         // another module identified by a URI and is treated as a
 857         // LT_ImportStatement (i.e. prevent wraps on it for long URIs).
 858         // Just "export {...};" or "export class ..." should not be treated as
 859         // an import in this sense.
 860         if (Line.First->is(tok::kw_export) &&
 861             CurrentToken->is(Keywords.kw_from) && CurrentToken->Next &&
 862             CurrentToken->Next->isStringLiteral())
 863           ImportStatement = true;
 864         if (isClosureImportStatement(*CurrentToken))
 865           ImportStatement = true;
 866       }
 867       if (!consumeToken())
 868         return LT_Invalid;
 869     }
 870     if (KeywordVirtualFound)
 871       return LT_VirtualFunctionDecl;
 872     if (ImportStatement)
 873       return LT_ImportStatement;
 874
 875     if (Line.startsWith(TT_ObjCMethodSpecifier)) {
 876       if (Contexts.back().FirstObjCSelectorName)
 877         Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
 878             Contexts.back().LongestObjCSelectorName;
 879       return LT_ObjCMethodDecl;
 880     }
 881
 882     return LT_Other;
 883   }
 884
 885 private:
 886   bool isClosureImportStatement(const FormatToken &Tok) {
 887     // FIXME: Closure-library specific stuff should not be hard-coded but be
 888     // configurable.
 889     return Tok.TokenText == "goog" && Tok.Next && Tok.Next->is(tok::period) &&
 890            Tok.Next->Next && (Tok.Next->Next->TokenText == "module" ||
 891                               Tok.Next->Next->TokenText == "provide" ||
 892                               Tok.Next->Next->TokenText == "require" ||
 893                               Tok.Next->Next->TokenText == "setTestOnly" ||
 894                               Tok.Next->Next->TokenText == "forwardDeclare") &&
 895            Tok.Next->Next->Next && Tok.Next->Next->Next->is(tok::l_paren);
 896   }
 897
 898   void resetTokenMetadata(FormatToken *Token) {
 899     if (!Token)
 900       return;
 901
 902     // Reset token type in case we have already looked at it and then
 903     // recovered from an error (e.g. failure to find the matching >).
 904     if (!CurrentToken->isOneOf(TT_LambdaLSquare, TT_ForEachMacro,
 905                                TT_FunctionLBrace, TT_ImplicitStringLiteral,
 906                                TT_InlineASMBrace, TT_JsFatArrow, TT_LambdaArrow,
 907                                TT_OverloadedOperator, TT_RegexLiteral,
 908                                TT_TemplateString))
 909       CurrentToken->Type = TT_Unknown;
 910     CurrentToken->Role.reset();
 911     CurrentToken->MatchingParen = nullptr;
 912     CurrentToken->FakeLParens.clear();
 913     CurrentToken->FakeRParens = 0;
 914   }
 915
 916   void next() {
 917     if (CurrentToken) {
 918       CurrentToken->NestingLevel = Contexts.size() - 1;
 919       CurrentToken->BindingStrength = Contexts.back().BindingStrength;
 920       modifyContext(*CurrentToken);
 921       determineTokenType(*CurrentToken);
 922       CurrentToken = CurrentToken->Next;
 923     }
 924
 925     resetTokenMetadata(CurrentToken);
 926   }
 927
 928   /// \brief A struct to hold information valid in a specific context, e.g.
 929   /// a pair of parenthesis.
 930   struct Context {
 931     Context(tok::TokenKind ContextKind, unsigned BindingStrength,
 932             bool IsExpression)
 933         : ContextKind(ContextKind), BindingStrength(BindingStrength),
 934           IsExpression(IsExpression) {}
 935
 936     tok::TokenKind ContextKind;
 937     unsigned BindingStrength;
 938     bool IsExpression;
 939     unsigned LongestObjCSelectorName = 0;
 940     bool ColonIsForRangeExpr = false;
 941     bool ColonIsDictLiteral = false;
 942     bool ColonIsObjCMethodExpr = false;
 943     FormatToken *FirstObjCSelectorName = nullptr;
 944     FormatToken *FirstStartOfName = nullptr;
 945     bool CanBeExpression = true;
 946     bool InTemplateArgument = false;
 947     bool InCtorInitializer = false;
 948     bool CaretFound = false;
 949     bool IsForEachMacro = false;
 950   };
 951
 952   /// \brief Puts a new \c Context onto the stack \c Contexts for the lifetime
 953   /// of each instance.
 954   struct ScopedContextCreator {
 955     AnnotatingParser &P;
 956
 957     ScopedContextCreator(AnnotatingParser &P, tok::TokenKind ContextKind,
 958                          unsigned Increase)
 959         : P(P) {
 960       P.Contexts.push_back(Context(ContextKind,
 961                                    P.Contexts.back().BindingStrength + Increase,
 962                                    P.Contexts.back().IsExpression));
 963     }
 964
 965     ~ScopedContextCreator() { P.Contexts.pop_back(); }
 966   };
 967
 968   void modifyContext(const FormatToken &Current) {
 969     if (Current.getPrecedence() == prec::Assignment &&
 970         !Line.First->isOneOf(tok::kw_template, tok::kw_using, tok::kw_return) &&
 971         // Type aliases use `type X = ...;` in TypeScript.
 972         !(Style.Language == FormatStyle::LK_JavaScript &&
 973           Line.startsWith(Keywords.kw_type, tok::identifier)) &&
 974         (!Current.Previous || Current.Previous->isNot(tok::kw_operator))) {
 975       Contexts.back().IsExpression = true;
 976       if (!Line.startsWith(TT_UnaryOperator)) {
 977         for (FormatToken *Previous = Current.Previous;
 978              Previous && Previous->Previous &&
 979              !Previous->Previous->isOneOf(tok::comma, tok::semi);
 980              Previous = Previous->Previous) {
 981           if (Previous->isOneOf(tok::r_square, tok::r_paren)) {
 982             Previous = Previous->MatchingParen;
 983             if (!Previous)
 984               break;
 985           }
 986           if (Previous->opensScope())
 987             break;
 988           if (Previous->isOneOf(TT_BinaryOperator, TT_UnaryOperator) &&
 989               Previous->isOneOf(tok::star, tok::amp, tok::ampamp) &&
 990               Previous->Previous && Previous->Previous->isNot(tok::equal))
 991             Previous->Type = TT_PointerOrReference;
 992         }
 993       }
 994     } else if (Current.is(tok::lessless) &&
 995                (!Current.Previous || !Current.Previous->is(tok::kw_operator))) {
 996       Contexts.back().IsExpression = true;
 997     } else if (Current.isOneOf(tok::kw_return, tok::kw_throw)) {
 998       Contexts.back().IsExpression = true;
 999     } else if (Current.is(TT_TrailingReturnArrow)) {
1000       Contexts.back().IsExpression = false;
1001     } else if (Current.is(TT_LambdaArrow) || Current.is(Keywords.kw_assert)) {
1002       Contexts.back().IsExpression = Style.Language == FormatStyle::LK_Java;
1003     } else if (Current.Previous &&
1004                Current.Previous->is(TT_CtorInitializerColon)) {
1005       Contexts.back().IsExpression = true;
1006       Contexts.back().InCtorInitializer = true;
1007     } else if (Current.isOneOf(tok::r_paren, tok::greater, tok::comma)) {
1008       for (FormatToken *Previous = Current.Previous;
1009            Previous && Previous->isOneOf(tok::star, tok::amp);
1010            Previous = Previous->Previous)
1011         Previous->Type = TT_PointerOrReference;
1012       if (Line.MustBeDeclaration && !Contexts.front().InCtorInitializer)
1013         Contexts.back().IsExpression = false;
1014     } else if (Current.is(tok::kw_new)) {
1015       Contexts.back().CanBeExpression = false;
1016     } else if (Current.isOneOf(tok::semi, tok::exclaim)) {
1017       // This should be the condition or increment in a for-loop.
1018       Contexts.back().IsExpression = true;
1019     }
1020   }
1021
1022   void determineTokenType(FormatToken &Current) {
1023     if (!Current.is(TT_Unknown))
1024       // The token type is already known.
1025       return;
1026
1027     // Line.MightBeFunctionDecl can only be true after the parentheses of a
1028     // function declaration have been found. In this case, 'Current' is a
1029     // trailing token of this declaration and thus cannot be a name.
1030     if (Current.is(Keywords.kw_instanceof)) {
1031       Current.Type = TT_BinaryOperator;
1032     } else if (isStartOfName(Current) &&
1033                (!Line.MightBeFunctionDecl || Current.NestingLevel != 0)) {
1034       Contexts.back().FirstStartOfName = &Current;
1035       Current.Type = TT_StartOfName;
1036     } else if (Current.isOneOf(tok::kw_auto, tok::kw___auto_type)) {
1037       AutoFound = true;
1038     } else if (Current.is(tok::arrow) &&
1039                Style.Language == FormatStyle::LK_Java) {
1040       Current.Type = TT_LambdaArrow;
1041     } else if (Current.is(tok::arrow) && AutoFound && Line.MustBeDeclaration &&
1042                Current.NestingLevel == 0) {
1043       Current.Type = TT_TrailingReturnArrow;
1044     } else if (Current.isOneOf(tok::star, tok::amp, tok::ampamp)) {
1045       Current.Type =
1046           determineStarAmpUsage(Current, Contexts.back().CanBeExpression &&
1047                                              Contexts.back().IsExpression,
1048                                 Contexts.back().InTemplateArgument);
1049     } else if (Current.isOneOf(tok::minus, tok::plus, tok::caret)) {
1050       Current.Type = determinePlusMinusCaretUsage(Current);
1051       if (Current.is(TT_UnaryOperator) && Current.is(tok::caret))
1052         Contexts.back().CaretFound = true;
1053     } else if (Current.isOneOf(tok::minusminus, tok::plusplus)) {
1054       Current.Type = determineIncrementUsage(Current);
1055     } else if (Current.isOneOf(tok::exclaim, tok::tilde)) {
1056       Current.Type = TT_UnaryOperator;
1057     } else if (Current.is(tok::question)) {
1058       if (Style.Language == FormatStyle::LK_JavaScript &&
1059           Line.MustBeDeclaration && !Contexts.back().IsExpression) {
1060         // In JavaScript, `interface X { foo?(): bar; }` is an optional method
1061         // on the interface, not a ternary expression.
1062         Current.Type = TT_JsTypeOptionalQuestion;
1063       } else {
1064         Current.Type = TT_ConditionalExpr;
1065       }
1066     } else if (Current.isBinaryOperator() &&
1067                (!Current.Previous || Current.Previous->isNot(tok::l_square))) {
1068       Current.Type = TT_BinaryOperator;
1069     } else if (Current.is(tok::comment)) {
1070       if (Current.TokenText.startswith("/*")) {
1071         if (Current.TokenText.endswith("*/"))
1072           Current.Type = TT_BlockComment;
1073         else
1074           // The lexer has for some reason determined a comment here. But we
1075           // cannot really handle it, if it isn't properly terminated.
1076           Current.Tok.setKind(tok::unknown);
1077       } else {
1078         Current.Type = TT_LineComment;
1079       }
1080     } else if (Current.is(tok::r_paren)) {
1081       if (rParenEndsCast(Current))
1082         Current.Type = TT_CastRParen;
1083       if (Current.MatchingParen && Current.Next &&
1084           !Current.Next->isBinaryOperator() &&
1085           !Current.Next->isOneOf(tok::semi, tok::colon, tok::l_brace,
1086                                  tok::comma, tok::period, tok::arrow,
1087                                  tok::coloncolon))
1088         if (FormatToken *AfterParen = Current.MatchingParen->Next) {
1089           // Make sure this isn't the return type of an Obj-C block declaration
1090           if (AfterParen->Tok.isNot(tok::caret)) {
1091             if (FormatToken *BeforeParen = Current.MatchingParen->Previous)
1092               if (BeforeParen->is(tok::identifier) &&
1093                   BeforeParen->TokenText == BeforeParen->TokenText.upper() &&
1094                   (!BeforeParen->Previous ||
1095                    BeforeParen->Previous->ClosesTemplateDeclaration))
1096                 Current.Type = TT_FunctionAnnotationRParen;
1097           }
1098         }
1099     } else if (Current.is(tok::at) && Current.Next) {
1100       if (Current.Next->isStringLiteral()) {
1101         Current.Type = TT_ObjCStringLiteral;
1102       } else {
1103         switch (Current.Next->Tok.getObjCKeywordID()) {
1104         case tok::objc_interface:
1105         case tok::objc_implementation:
1106         case tok::objc_protocol:
1107           Current.Type = TT_ObjCDecl;
1108           break;
1109         case tok::objc_property:
1110           Current.Type = TT_ObjCProperty;
1111           break;
1112         default:
1113           break;
1114         }
1115       }
1116     } else if (Current.is(tok::period)) {
1117       FormatToken *PreviousNoComment = Current.getPreviousNonComment();
1118       if (PreviousNoComment &&
1119           PreviousNoComment->isOneOf(tok::comma, tok::l_brace))
1120         Current.Type = TT_DesignatedInitializerPeriod;
1121       else if (Style.Language == FormatStyle::LK_Java && Current.Previous &&
1122                Current.Previous->isOneOf(TT_JavaAnnotation,
1123                                          TT_LeadingJavaAnnotation)) {
1124         Current.Type = Current.Previous->Type;
1125       }
1126     } else if (Current.isOneOf(tok::identifier, tok::kw_const) &&
1127                Current.Previous &&
1128                !Current.Previous->isOneOf(tok::equal, tok::at) &&
1129                Line.MightBeFunctionDecl && Contexts.size() == 1) {
1130       // Line.MightBeFunctionDecl can only be true after the parentheses of a
1131       // function declaration have been found.
1132       Current.Type = TT_TrailingAnnotation;
1133     } else if ((Style.Language == FormatStyle::LK_Java ||
1134                 Style.Language == FormatStyle::LK_JavaScript) &&
1135                Current.Previous) {
1136       if (Current.Previous->is(tok::at) &&
1137           Current.isNot(Keywords.kw_interface)) {
1138         const FormatToken &AtToken = *Current.Previous;
1139         const FormatToken *Previous = AtToken.getPreviousNonComment();
1140         if (!Previous || Previous->is(TT_LeadingJavaAnnotation))
1141           Current.Type = TT_LeadingJavaAnnotation;
1142         else
1143           Current.Type = TT_JavaAnnotation;
1144       } else if (Current.Previous->is(tok::period) &&
1145                  Current.Previous->isOneOf(TT_JavaAnnotation,
1146                                            TT_LeadingJavaAnnotation)) {
1147         Current.Type = Current.Previous->Type;
1148       }
1149     }
1150   }
1151
1152   /// \brief Take a guess at whether \p Tok starts a name of a function or
1153   /// variable declaration.
1154   ///
1155   /// This is a heuristic based on whether \p Tok is an identifier following
1156   /// something that is likely a type.
1157   bool isStartOfName(const FormatToken &Tok) {
1158     if (Tok.isNot(tok::identifier) || !Tok.Previous)
1159       return false;
1160
1161     if (Tok.Previous->isOneOf(TT_LeadingJavaAnnotation, Keywords.kw_instanceof,
1162                               Keywords.kw_as))
1163       return false;
1164     if (Style.Language == FormatStyle::LK_JavaScript &&
1165         Tok.Previous->is(Keywords.kw_in))
1166       return false;
1167
1168     // Skip "const" as it does not have an influence on whether this is a name.
1169     FormatToken *PreviousNotConst = Tok.Previous;
1170     while (PreviousNotConst && PreviousNotConst->is(tok::kw_const))
1171       PreviousNotConst = PreviousNotConst->Previous;
1172
1173     if (!PreviousNotConst)
1174       return false;
1175
1176     bool IsPPKeyword = PreviousNotConst->is(tok::identifier) &&
1177                        PreviousNotConst->Previous &&
1178                        PreviousNotConst->Previous->is(tok::hash);
1179
1180     if (PreviousNotConst->is(TT_TemplateCloser))
1181       return PreviousNotConst && PreviousNotConst->MatchingParen &&
1182              PreviousNotConst->MatchingParen->Previous &&
1183              PreviousNotConst->MatchingParen->Previous->isNot(tok::period) &&
1184              PreviousNotConst->MatchingParen->Previous->isNot(tok::kw_template);
1185
1186     if (PreviousNotConst->is(tok::r_paren) && PreviousNotConst->MatchingParen &&
1187         PreviousNotConst->MatchingParen->Previous &&
1188         PreviousNotConst->MatchingParen->Previous->is(tok::kw_decltype))
1189       return true;
1190
1191     return (!IsPPKeyword &&
1192             PreviousNotConst->isOneOf(tok::identifier, tok::kw_auto)) ||
1193            PreviousNotConst->is(TT_PointerOrReference) ||
1194            PreviousNotConst->isSimpleTypeSpecifier();
1195   }
1196
1197   /// \brief Determine whether ')' is ending a cast.
1198   bool rParenEndsCast(const FormatToken &Tok) {
1199     // C-style casts are only used in C++ and Java.
1200     if (!Style.IsCpp() && Style.Language != FormatStyle::LK_Java)
1201       return false;
1202
1203     // Empty parens aren't casts and there are no casts at the end of the line.
1204     if (Tok.Previous == Tok.MatchingParen || !Tok.Next || !Tok.MatchingParen)
1205       return false;
1206
1207     FormatToken *LeftOfParens = Tok.MatchingParen->getPreviousNonComment();
1208     if (LeftOfParens) {
1209       // If there is a closing parenthesis left of the current parentheses,
1210       // look past it as these might be chained casts.
1211       if (LeftOfParens->is(tok::r_paren)) {
1212         if (!LeftOfParens->MatchingParen ||
1213             !LeftOfParens->MatchingParen->Previous)
1214           return false;
1215         LeftOfParens = LeftOfParens->MatchingParen->Previous;
1216       }
1217
1218       // If there is an identifier (or with a few exceptions a keyword) right
1219       // before the parentheses, this is unlikely to be a cast.
1220       if (LeftOfParens->Tok.getIdentifierInfo() &&
1221           !LeftOfParens->isOneOf(Keywords.kw_in, tok::kw_return, tok::kw_case,
1222                                  tok::kw_delete))
1223         return false;
1224
1225       // Certain other tokens right before the parentheses are also signals that
1226       // this cannot be a cast.
1227       if (LeftOfParens->isOneOf(tok::at, tok::r_square, TT_OverloadedOperator,
1228                                 TT_TemplateCloser, tok::ellipsis))
1229         return false;
1230     }
1231
1232     if (Tok.Next->is(tok::question))
1233       return false;
1234
1235     // As Java has no function types, a "(" after the ")" likely means that this
1236     // is a cast.
1237     if (Style.Language == FormatStyle::LK_Java && Tok.Next->is(tok::l_paren))
1238       return true;
1239
1240     // If a (non-string) literal follows, this is likely a cast.
1241     if (Tok.Next->isNot(tok::string_literal) &&
1242         (Tok.Next->Tok.isLiteral() ||
1243          Tok.Next->isOneOf(tok::kw_sizeof, tok::kw_alignof)))
1244       return true;
1245
1246     // Heuristically try to determine whether the parentheses contain a type.
1247     bool ParensAreType =
1248         !Tok.Previous ||
1249         Tok.Previous->isOneOf(TT_PointerOrReference, TT_TemplateCloser) ||
1250         Tok.Previous->isSimpleTypeSpecifier();
1251     bool ParensCouldEndDecl =
1252         Tok.Next->isOneOf(tok::equal, tok::semi, tok::l_brace, tok::greater);
1253     if (ParensAreType && !ParensCouldEndDecl)
1254       return true;
1255
1256     // At this point, we heuristically assume that there are no casts at the
1257     // start of the line. We assume that we have found most cases where there
1258     // are by the logic above, e.g. "(void)x;".
1259     if (!LeftOfParens)
1260       return false;
1261
1262     // Certain token types inside the parentheses mean that this can't be a
1263     // cast.
1264     for (const FormatToken *Token = Tok.MatchingParen->Next; Token != &Tok;
1265          Token = Token->Next)
1266       if (Token->is(TT_BinaryOperator))
1267         return false;
1268
1269     // If the following token is an identifier or 'this', this is a cast. All
1270     // cases where this can be something else are handled above.
1271     if (Tok.Next->isOneOf(tok::identifier, tok::kw_this))
1272       return true;
1273
1274     if (!Tok.Next->Next)
1275       return false;
1276
1277     // If the next token after the parenthesis is a unary operator, assume
1278     // that this is cast, unless there are unexpected tokens inside the
1279     // parenthesis.
1280     bool NextIsUnary =
1281         Tok.Next->isUnaryOperator() || Tok.Next->isOneOf(tok::amp, tok::star);
1282     if (!NextIsUnary || Tok.Next->is(tok::plus) ||
1283         !Tok.Next->Next->isOneOf(tok::identifier, tok::numeric_constant))
1284       return false;
1285     // Search for unexpected tokens.
1286     for (FormatToken *Prev = Tok.Previous; Prev != Tok.MatchingParen;
1287          Prev = Prev->Previous) {
1288       if (!Prev->isOneOf(tok::kw_const, tok::identifier, tok::coloncolon))
1289         return false;
1290     }
1291     return true;
1292   }
1293
1294   /// \brief Return the type of the given token assuming it is * or &.
1295   TokenType determineStarAmpUsage(const FormatToken &Tok, bool IsExpression,
1296                                   bool InTemplateArgument) {
1297     if (Style.Language == FormatStyle::LK_JavaScript)
1298       return TT_BinaryOperator;
1299
1300     const FormatToken *PrevToken = Tok.getPreviousNonComment();
1301     if (!PrevToken)
1302       return TT_UnaryOperator;
1303
1304     const FormatToken *NextToken = Tok.getNextNonComment();
1305     if (!NextToken || NextToken->isOneOf(tok::arrow, tok::equal) ||
1306         (NextToken->is(tok::l_brace) && !NextToken->getNextNonComment()))
1307       return TT_PointerOrReference;
1308
1309     if (PrevToken->is(tok::coloncolon))
1310       return TT_PointerOrReference;
1311
1312     if (PrevToken->isOneOf(tok::l_paren, tok::l_square, tok::l_brace,
1313                            tok::comma, tok::semi, tok::kw_return, tok::colon,
1314                            tok::equal, tok::kw_delete, tok::kw_sizeof) ||
1315         PrevToken->isOneOf(TT_BinaryOperator, TT_ConditionalExpr,
1316                            TT_UnaryOperator, TT_CastRParen))
1317       return TT_UnaryOperator;
1318
1319     if (NextToken->is(tok::l_square) && NextToken->isNot(TT_LambdaLSquare))
1320       return TT_PointerOrReference;
1321     if (NextToken->is(tok::kw_operator) && !IsExpression)
1322       return TT_PointerOrReference;
1323     if (NextToken->isOneOf(tok::comma, tok::semi))
1324       return TT_PointerOrReference;
1325
1326     if (PrevToken->is(tok::r_paren) && PrevToken->MatchingParen &&
1327         PrevToken->MatchingParen->Previous &&
1328         PrevToken->MatchingParen->Previous->isOneOf(tok::kw_typeof,
1329                                                     tok::kw_decltype))
1330       return TT_PointerOrReference;
1331
1332     if (PrevToken->Tok.isLiteral() ||
1333         PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::kw_true,
1334                            tok::kw_false, tok::r_brace) ||
1335         NextToken->Tok.isLiteral() ||
1336         NextToken->isOneOf(tok::kw_true, tok::kw_false) ||
1337         NextToken->isUnaryOperator() ||
1338         // If we know we're in a template argument, there are no named
1339         // declarations. Thus, having an identifier on the right-hand side
1340         // indicates a binary operator.
1341         (InTemplateArgument && NextToken->Tok.isAnyIdentifier()))
1342       return TT_BinaryOperator;
1343
1344     // "&&(" is quite unlikely to be two successive unary "&".
1345     if (Tok.is(tok::ampamp) && NextToken && NextToken->is(tok::l_paren))
1346       return TT_BinaryOperator;
1347
1348     // This catches some cases where evaluation order is used as control flow:
1349     //   aaa && aaa->f();
1350     const FormatToken *NextNextToken = NextToken->getNextNonComment();
1351     if (NextNextToken && NextNextToken->is(tok::arrow))
1352       return TT_BinaryOperator;
1353
1354     // It is very unlikely that we are going to find a pointer or reference type
1355     // definition on the RHS of an assignment.
1356     if (IsExpression && !Contexts.back().CaretFound)
1357       return TT_BinaryOperator;
1358
1359     return TT_PointerOrReference;
1360   }
1361
1362   TokenType determinePlusMinusCaretUsage(const FormatToken &Tok) {
1363     const FormatToken *PrevToken = Tok.getPreviousNonComment();
1364     if (!PrevToken)
1365       return TT_UnaryOperator;
1366
1367     if (PrevToken->isOneOf(TT_CastRParen, TT_UnaryOperator) &&
1368         !PrevToken->is(tok::exclaim))
1369       // There aren't any trailing unary operators except for TypeScript's
1370       // non-null operator (!). Thus, this must be squence of leading operators.
1371       return TT_UnaryOperator;
1372
1373     // Use heuristics to recognize unary operators.
1374     if (PrevToken->isOneOf(tok::equal, tok::l_paren, tok::comma, tok::l_square,
1375                            tok::question, tok::colon, tok::kw_return,
1376                            tok::kw_case, tok::at, tok::l_brace))
1377       return TT_UnaryOperator;
1378
1379     // There can't be two consecutive binary operators.
1380     if (PrevToken->is(TT_BinaryOperator))
1381       return TT_UnaryOperator;
1382
1383     // Fall back to marking the token as binary operator.
1384     return TT_BinaryOperator;
1385   }
1386
1387   /// \brief Determine whether ++/-- are pre- or post-increments/-decrements.
1388   TokenType determineIncrementUsage(const FormatToken &Tok) {
1389     const FormatToken *PrevToken = Tok.getPreviousNonComment();
1390     if (!PrevToken || PrevToken->is(TT_CastRParen))
1391       return TT_UnaryOperator;
1392     if (PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::identifier))
1393       return TT_TrailingUnaryOperator;
1394
1395     return TT_UnaryOperator;
1396   }
1397
1398   SmallVector<Context, 8> Contexts;
1399
1400   const FormatStyle &Style;
1401   AnnotatedLine &Line;
1402   FormatToken *CurrentToken;
1403   bool AutoFound;
1404   const AdditionalKeywords &Keywords;
1405
1406   // Set of "<" tokens that do not open a template parameter list. If parseAngle
1407   // determines that a specific token can't be a template opener, it will make
1408   // same decision irrespective of the decisions for tokens leading up to it.
1409   // Store this information to prevent this from causing exponential runtime.
1410   llvm::SmallPtrSet<FormatToken *, 16> NonTemplateLess;
1411 };
1412
1413 static const int PrecedenceUnaryOperator = prec::PointerToMember + 1;
1414 static const int PrecedenceArrowAndPeriod = prec::PointerToMember + 2;
1415
1416 /// \brief Parses binary expressions by inserting fake parenthesis based on
1417 /// operator precedence.
1418 class ExpressionParser {
1419 public:
1420   ExpressionParser(const FormatStyle &Style, const AdditionalKeywords &Keywords,
1421                    AnnotatedLine &Line)
1422       : Style(Style), Keywords(Keywords), Current(Line.First) {}
1423
1424   /// \brief Parse expressions with the given operatore precedence.
1425   void parse(int Precedence = 0) {
1426     // Skip 'return' and ObjC selector colons as they are not part of a binary
1427     // expression.
1428     while (Current && (Current->is(tok::kw_return) ||
1429                        (Current->is(tok::colon) &&
1430                         Current->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral))))
1431       next();
1432
1433     if (!Current || Precedence > PrecedenceArrowAndPeriod)
1434       return;
1435
1436     // Conditional expressions need to be parsed separately for proper nesting.
1437     if (Precedence == prec::Conditional) {
1438       parseConditionalExpr();
1439       return;
1440     }
1441
1442     // Parse unary operators, which all have a higher precedence than binary
1443     // operators.
1444     if (Precedence == PrecedenceUnaryOperator) {
1445       parseUnaryOperator();
1446       return;
1447     }
1448
1449     FormatToken *Start = Current;
1450     FormatToken *LatestOperator = nullptr;
1451     unsigned OperatorIndex = 0;
1452
1453     while (Current) {
1454       // Consume operators with higher precedence.
1455       parse(Precedence + 1);
1456
1457       int CurrentPrecedence = getCurrentPrecedence();
1458
1459       if (Current && Current->is(TT_SelectorName) &&
1460           Precedence == CurrentPrecedence) {
1461         if (LatestOperator)
1462           addFakeParenthesis(Start, prec::Level(Precedence));
1463         Start = Current;
1464       }
1465
1466       // At the end of the line or when an operator with higher precedence is
1467       // found, insert fake parenthesis and return.
1468       if (!Current ||
1469           (Current->closesScope() &&
1470            (Current->MatchingParen || Current->is(TT_TemplateString))) ||
1471           (CurrentPrecedence != -1 && CurrentPrecedence < Precedence) ||
1472           (CurrentPrecedence == prec::Conditional &&
1473            Precedence == prec::Assignment && Current->is(tok::colon))) {
1474         break;
1475       }
1476
1477       // Consume scopes: (), [], <> and {}
1478       if (Current->opensScope()) {
1479         // In fragment of a JavaScript template string can look like '}..${' and
1480         // thus close a scope and open a new one at the same time.
1481         while (Current && (!Current->closesScope() || Current->opensScope())) {
1482           next();
1483           parse();
1484         }
1485         next();
1486       } else {
1487         // Operator found.
1488         if (CurrentPrecedence == Precedence) {
1489           if (LatestOperator)
1490             LatestOperator->NextOperator = Current;
1491           LatestOperator = Current;
1492           Current->OperatorIndex = OperatorIndex;
1493           ++OperatorIndex;
1494         }
1495         next(/*SkipPastLeadingComments=*/Precedence > 0);
1496       }
1497     }
1498
1499     if (LatestOperator && (Current || Precedence > 0)) {
1500       // LatestOperator->LastOperator = true;
1501       if (Precedence == PrecedenceArrowAndPeriod) {
1502         // Call expressions don't have a binary operator precedence.
1503         addFakeParenthesis(Start, prec::Unknown);
1504       } else {
1505         addFakeParenthesis(Start, prec::Level(Precedence));
1506       }
1507     }
1508   }
1509
1510 private:
1511   /// \brief Gets the precedence (+1) of the given token for binary operators
1512   /// and other tokens that we treat like binary operators.
1513   int getCurrentPrecedence() {
1514     if (Current) {
1515       const FormatToken *NextNonComment = Current->getNextNonComment();
1516       if (Current->is(TT_ConditionalExpr))
1517         return prec::Conditional;
1518       if (NextNonComment && NextNonComment->is(tok::colon) &&
1519           NextNonComment->is(TT_DictLiteral))
1520         return prec::Assignment;
1521       if (Current->is(TT_JsComputedPropertyName))
1522         return prec::Assignment;
1523       if (Current->is(TT_LambdaArrow))
1524         return prec::Comma;
1525       if (Current->is(TT_JsFatArrow))
1526         return prec::Assignment;
1527       if (Current->isOneOf(tok::semi, TT_InlineASMColon, TT_SelectorName) ||
1528           (Current->is(tok::comment) && NextNonComment &&
1529            NextNonComment->is(TT_SelectorName)))
1530         return 0;
1531       if (Current->is(TT_RangeBasedForLoopColon))
1532         return prec::Comma;
1533       if ((Style.Language == FormatStyle::LK_Java ||
1534            Style.Language == FormatStyle::LK_JavaScript) &&
1535           Current->is(Keywords.kw_instanceof))
1536         return prec::Relational;
1537       if (Style.Language == FormatStyle::LK_JavaScript &&
1538           Current->isOneOf(Keywords.kw_in, Keywords.kw_as))
1539         return prec::Relational;
1540       if (Current->is(TT_BinaryOperator) || Current->is(tok::comma))
1541         return Current->getPrecedence();
1542       if (Current->isOneOf(tok::period, tok::arrow))
1543         return PrecedenceArrowAndPeriod;
1544       if ((Style.Language == FormatStyle::LK_Java ||
1545            Style.Language == FormatStyle::LK_JavaScript) &&
1546           Current->isOneOf(Keywords.kw_extends, Keywords.kw_implements,
1547                            Keywords.kw_throws))
1548         return 0;
1549     }
1550     return -1;
1551   }
1552
1553   void addFakeParenthesis(FormatToken *Start, prec::Level Precedence) {
1554     Start->FakeLParens.push_back(Precedence);
1555     if (Precedence > prec::Unknown)
1556       Start->StartsBinaryExpression = true;
1557     if (Current) {
1558       FormatToken *Previous = Current->Previous;
1559       while (Previous->is(tok::comment) && Previous->Previous)
1560         Previous = Previous->Previous;
1561       ++Previous->FakeRParens;
1562       if (Precedence > prec::Unknown)
1563         Previous->EndsBinaryExpression = true;
1564     }
1565   }
1566
1567   /// \brief Parse unary operator expressions and surround them with fake
1568   /// parentheses if appropriate.
1569   void parseUnaryOperator() {
1570     if (!Current || Current->isNot(TT_UnaryOperator)) {
1571       parse(PrecedenceArrowAndPeriod);
1572       return;
1573     }
1574
1575     FormatToken *Start = Current;
1576     next();
1577     parseUnaryOperator();
1578
1579     // The actual precedence doesn't matter.
1580     addFakeParenthesis(Start, prec::Unknown);
1581   }
1582
1583   void parseConditionalExpr() {
1584     while (Current && Current->isTrailingComment()) {
1585       next();
1586     }
1587     FormatToken *Start = Current;
1588     parse(prec::LogicalOr);
1589     if (!Current || !Current->is(tok::question))
1590       return;
1591     next();
1592     parse(prec::Assignment);
1593     if (!Current || Current->isNot(TT_ConditionalExpr))
1594       return;
1595     next();
1596     parse(prec::Assignment);
1597     addFakeParenthesis(Start, prec::Conditional);
1598   }
1599
1600   void next(bool SkipPastLeadingComments = true) {
1601     if (Current)
1602       Current = Current->Next;
1603     while (Current &&
1604            (Current->NewlinesBefore == 0 || SkipPastLeadingComments) &&
1605            Current->isTrailingComment())
1606       Current = Current->Next;
1607   }
1608
1609   const FormatStyle &Style;
1610   const AdditionalKeywords &Keywords;
1611   FormatToken *Current;
1612 };
1613
1614 } // end anonymous namespace
1615
1616 void TokenAnnotator::setCommentLineLevels(
1617     SmallVectorImpl<AnnotatedLine *> &Lines) {
1618   const AnnotatedLine *NextNonCommentLine = nullptr;
1619   for (SmallVectorImpl<AnnotatedLine *>::reverse_iterator I = Lines.rbegin(),
1620                                                           E = Lines.rend();
1621        I != E; ++I) {
1622     bool CommentLine = (*I)->First;
1623     for (const FormatToken *Tok = (*I)->First; Tok; Tok = Tok->Next) {
1624       if (!Tok->is(tok::comment)) {
1625         CommentLine = false;
1626         break;
1627       }
1628     }
1629     if (NextNonCommentLine && CommentLine)
1630       (*I)->Level = NextNonCommentLine->Level;
1631     else
1632       NextNonCommentLine = (*I)->First->isNot(tok::r_brace) ? (*I) : nullptr;
1633
1634     setCommentLineLevels((*I)->Children);
1635   }
1636 }
1637
1638 static unsigned maxNestingDepth(const AnnotatedLine &Line) {
1639   unsigned Result = 0;
1640   for (const auto* Tok = Line.First; Tok != nullptr; Tok = Tok->Next)
1641     Result = std::max(Result, Tok->NestingLevel);
1642   return Result;
1643 }
1644
1645 void TokenAnnotator::annotate(AnnotatedLine &Line) {
1646   for (SmallVectorImpl<AnnotatedLine *>::iterator I = Line.Children.begin(),
1647                                                   E = Line.Children.end();
1648        I != E; ++I) {
1649     annotate(**I);
1650   }
1651   AnnotatingParser Parser(Style, Line, Keywords);
1652   Line.Type = Parser.parseLine();
1653
1654   // With very deep nesting, ExpressionParser uses lots of stack and the
1655   // formatting algorithm is very slow. We're not going to do a good job here
1656   // anyway - it's probably generated code being formatted by mistake.
1657   // Just skip the whole line.
1658   if (maxNestingDepth(Line) > 50)
1659     Line.Type = LT_Invalid;
1660
1661   if (Line.Type == LT_Invalid)
1662     return;
1663
1664   ExpressionParser ExprParser(Style, Keywords, Line);
1665   ExprParser.parse();
1666
1667   if (Line.startsWith(TT_ObjCMethodSpecifier))
1668     Line.Type = LT_ObjCMethodDecl;
1669   else if (Line.startsWith(TT_ObjCDecl))
1670     Line.Type = LT_ObjCDecl;
1671   else if (Line.startsWith(TT_ObjCProperty))
1672     Line.Type = LT_ObjCProperty;
1673
1674   Line.First->SpacesRequiredBefore = 1;
1675   Line.First->CanBreakBefore = Line.First->MustBreakBefore;
1676 }
1677
1678 // This function heuristically determines whether 'Current' starts the name of a
1679 // function declaration.
1680 static bool isFunctionDeclarationName(const FormatToken &Current,
1681                                       const AnnotatedLine &Line) {
1682   auto skipOperatorName = [](const FormatToken* Next) -> const FormatToken* {
1683     for (; Next; Next = Next->Next) {
1684       if (Next->is(TT_OverloadedOperatorLParen))
1685         return Next;
1686       if (Next->is(TT_OverloadedOperator))
1687         continue;
1688       if (Next->isOneOf(tok::kw_new, tok::kw_delete)) {
1689         // For 'new[]' and 'delete[]'.
1690         if (Next->Next && Next->Next->is(tok::l_square) &&
1691             Next->Next->Next && Next->Next->Next->is(tok::r_square))
1692           Next = Next->Next->Next;
1693         continue;
1694       }
1695
1696       break;
1697     }
1698     return nullptr;
1699   };
1700
1701   // Find parentheses of parameter list.
1702   const FormatToken *Next = Current.Next;
1703   if (Current.is(tok::kw_operator)) {
1704     if (Current.Previous && Current.Previous->is(tok::coloncolon))
1705       return false;
1706     Next = skipOperatorName(Next);
1707   } else {
1708     if (!Current.is(TT_StartOfName) || Current.NestingLevel != 0)
1709       return false;
1710     for (; Next; Next = Next->Next) {
1711       if (Next->is(TT_TemplateOpener)) {
1712         Next = Next->MatchingParen;
1713       } else if (Next->is(tok::coloncolon)) {
1714         Next = Next->Next;
1715         if (!Next)
1716           return false;
1717         if (Next->is(tok::kw_operator)) {
1718           Next = skipOperatorName(Next->Next);
1719           break;
1720         }
1721         if (!Next->is(tok::identifier))
1722           return false;
1723       } else if (Next->is(tok::l_paren)) {
1724         break;
1725       } else {
1726         return false;
1727       }
1728     }
1729   }
1730
1731   // Check whether parameter list can belong to a function declaration.
1732   if (!Next || !Next->is(tok::l_paren) || !Next->MatchingParen)
1733     return false;
1734   // If the lines ends with "{", this is likely an function definition.
1735   if (Line.Last->is(tok::l_brace))
1736     return true;
1737   if (Next->Next == Next->MatchingParen)
1738     return true; // Empty parentheses.
1739   // If there is an &/&& after the r_paren, this is likely a function.
1740   if (Next->MatchingParen->Next &&
1741       Next->MatchingParen->Next->is(TT_PointerOrReference))
1742     return true;
1743   for (const FormatToken *Tok = Next->Next; Tok && Tok != Next->MatchingParen;
1744        Tok = Tok->Next) {
1745     if (Tok->is(tok::l_paren) && Tok->MatchingParen) {
1746       Tok = Tok->MatchingParen;
1747       continue;
1748     }
1749     if (Tok->is(tok::kw_const) || Tok->isSimpleTypeSpecifier() ||
1750         Tok->isOneOf(TT_PointerOrReference, TT_StartOfName, tok::ellipsis))
1751       return true;
1752     if (Tok->isOneOf(tok::l_brace, tok::string_literal, TT_ObjCMethodExpr) ||
1753         Tok->Tok.isLiteral())
1754       return false;
1755   }
1756   return false;
1757 }
1758
1759 bool TokenAnnotator::mustBreakForReturnType(const AnnotatedLine &Line) const {
1760   assert(Line.MightBeFunctionDecl);
1761
1762   if ((Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_TopLevel ||
1763        Style.AlwaysBreakAfterReturnType ==
1764            FormatStyle::RTBS_TopLevelDefinitions) &&
1765       Line.Level > 0)
1766     return false;
1767
1768   switch (Style.AlwaysBreakAfterReturnType) {
1769   case FormatStyle::RTBS_None:
1770     return false;
1771   case FormatStyle::RTBS_All:
1772   case FormatStyle::RTBS_TopLevel:
1773     return true;
1774   case FormatStyle::RTBS_AllDefinitions:
1775   case FormatStyle::RTBS_TopLevelDefinitions:
1776     return Line.mightBeFunctionDefinition();
1777   }
1778
1779   return false;
1780 }
1781
1782 void TokenAnnotator::calculateFormattingInformation(AnnotatedLine &Line) {
1783   for (SmallVectorImpl<AnnotatedLine *>::iterator I = Line.Children.begin(),
1784                                                   E = Line.Children.end();
1785        I != E; ++I) {
1786     calculateFormattingInformation(**I);
1787   }
1788
1789   Line.First->TotalLength =
1790       Line.First->IsMultiline ? Style.ColumnLimit : Line.First->ColumnWidth;
1791   FormatToken *Current = Line.First->Next;
1792   bool InFunctionDecl = Line.MightBeFunctionDecl;
1793   while (Current) {
1794     if (isFunctionDeclarationName(*Current, Line))
1795       Current->Type = TT_FunctionDeclarationName;
1796     if (Current->is(TT_LineComment)) {
1797       if (Current->Previous->BlockKind == BK_BracedInit &&
1798           Current->Previous->opensScope())
1799         Current->SpacesRequiredBefore = Style.Cpp11BracedListStyle ? 0 : 1;
1800       else
1801         Current->SpacesRequiredBefore = Style.SpacesBeforeTrailingComments;
1802
1803       // If we find a trailing comment, iterate backwards to determine whether
1804       // it seems to relate to a specific parameter. If so, break before that
1805       // parameter to avoid changing the comment's meaning. E.g. don't move 'b'
1806       // to the previous line in:
1807       //   SomeFunction(a,
1808       //                b, // comment
1809       //                c);
1810       if (!Current->HasUnescapedNewline) {
1811         for (FormatToken *Parameter = Current->Previous; Parameter;
1812              Parameter = Parameter->Previous) {
1813           if (Parameter->isOneOf(tok::comment, tok::r_brace))
1814             break;
1815           if (Parameter->Previous && Parameter->Previous->is(tok::comma)) {
1816             if (!Parameter->Previous->is(TT_CtorInitializerComma) &&
1817                 Parameter->HasUnescapedNewline)
1818               Parameter->MustBreakBefore = true;
1819             break;
1820           }
1821         }
1822       }
1823     } else if (Current->SpacesRequiredBefore == 0 &&
1824                spaceRequiredBefore(Line, *Current)) {
1825       Current->SpacesRequiredBefore = 1;
1826     }
1827
1828     Current->MustBreakBefore =
1829         Current->MustBreakBefore || mustBreakBefore(Line, *Current);
1830
1831     if (!Current->MustBreakBefore && InFunctionDecl &&
1832         Current->is(TT_FunctionDeclarationName))
1833       Current->MustBreakBefore = mustBreakForReturnType(Line);
1834
1835     Current->CanBreakBefore =
1836         Current->MustBreakBefore || canBreakBefore(Line, *Current);
1837     unsigned ChildSize = 0;
1838     if (Current->Previous->Children.size() == 1) {
1839       FormatToken &LastOfChild = *Current->Previous->Children[0]->Last;
1840       ChildSize = LastOfChild.isTrailingComment() ? Style.ColumnLimit
1841                                                   : LastOfChild.TotalLength + 1;
1842     }
1843     const FormatToken *Prev = Current->Previous;
1844     if (Current->MustBreakBefore || Prev->Children.size() > 1 ||
1845         (Prev->Children.size() == 1 &&
1846          Prev->Children[0]->First->MustBreakBefore) ||
1847         Current->IsMultiline)
1848       Current->TotalLength = Prev->TotalLength + Style.ColumnLimit;
1849     else
1850       Current->TotalLength = Prev->TotalLength + Current->ColumnWidth +
1851                              ChildSize + Current->SpacesRequiredBefore;
1852
1853     if (Current->is(TT_CtorInitializerColon))
1854       InFunctionDecl = false;
1855
1856     // FIXME: Only calculate this if CanBreakBefore is true once static
1857     // initializers etc. are sorted out.
1858     // FIXME: Move magic numbers to a better place.
1859     Current->SplitPenalty = 20 * Current->BindingStrength +
1860                             splitPenalty(Line, *Current, InFunctionDecl);
1861
1862     Current = Current->Next;
1863   }
1864
1865   calculateUnbreakableTailLengths(Line);
1866   unsigned IndentLevel = Line.Level;
1867   for (Current = Line.First; Current != nullptr; Current = Current->Next) {
1868     if (Current->Role)
1869       Current->Role->precomputeFormattingInfos(Current);
1870     if (Current->MatchingParen &&
1871         Current->MatchingParen->opensBlockOrBlockTypeList(Style)) {
1872       assert(IndentLevel > 0);
1873       --IndentLevel;
1874     }
1875     Current->IndentLevel = IndentLevel;
1876     if (Current->opensBlockOrBlockTypeList(Style))
1877       ++IndentLevel;
1878   }
1879
1880   DEBUG({ printDebugInfo(Line); });
1881 }
1882
1883 void TokenAnnotator::calculateUnbreakableTailLengths(AnnotatedLine &Line) {
1884   unsigned UnbreakableTailLength = 0;
1885   FormatToken *Current = Line.Last;
1886   while (Current) {
1887     Current->UnbreakableTailLength = UnbreakableTailLength;
1888     if (Current->CanBreakBefore ||
1889         Current->isOneOf(tok::comment, tok::string_literal)) {
1890       UnbreakableTailLength = 0;
1891     } else {
1892       UnbreakableTailLength +=
1893           Current->ColumnWidth + Current->SpacesRequiredBefore;
1894     }
1895     Current = Current->Previous;
1896   }
1897 }
1898
1899 unsigned TokenAnnotator::splitPenalty(const AnnotatedLine &Line,
1900                                       const FormatToken &Tok,
1901                                       bool InFunctionDecl) {
1902   const FormatToken &Left = *Tok.Previous;
1903   const FormatToken &Right = Tok;
1904
1905   if (Left.is(tok::semi))
1906     return 0;
1907
1908   if (Style.Language == FormatStyle::LK_Java) {
1909     if (Right.isOneOf(Keywords.kw_extends, Keywords.kw_throws))
1910       return 1;
1911     if (Right.is(Keywords.kw_implements))
1912       return 2;
1913     if (Left.is(tok::comma) && Left.NestingLevel == 0)
1914       return 3;
1915   } else if (Style.Language == FormatStyle::LK_JavaScript) {
1916     if (Right.is(Keywords.kw_function) && Left.isNot(tok::comma))
1917       return 100;
1918     if (Left.is(TT_JsTypeColon))
1919       return 35;
1920     if ((Left.is(TT_TemplateString) && Left.TokenText.endswith("${")) ||
1921         (Right.is(TT_TemplateString) && Right.TokenText.startswith("}")))
1922       return 100;
1923   }
1924
1925   if (Right.is(tok::identifier) && Right.Next && Right.Next->is(TT_DictLiteral))
1926     return 1;
1927   if (Right.is(tok::l_square)) {
1928     if (Style.Language == FormatStyle::LK_Proto)
1929       return 1;
1930     if (Left.is(tok::r_square))
1931       return 200;
1932     // Slightly prefer formatting local lambda definitions like functions.
1933     if (Right.is(TT_LambdaLSquare) && Left.is(tok::equal))
1934       return 35;
1935     if (!Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare,
1936                        TT_ArrayInitializerLSquare))
1937       return 500;
1938   }
1939
1940   if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
1941       Right.is(tok::kw_operator)) {
1942     if (Line.startsWith(tok::kw_for) && Right.PartOfMultiVariableDeclStmt)
1943       return 3;
1944     if (Left.is(TT_StartOfName))
1945       return 110;
1946     if (InFunctionDecl && Right.NestingLevel == 0)
1947       return Style.PenaltyReturnTypeOnItsOwnLine;
1948     return 200;
1949   }
1950   if (Right.is(TT_PointerOrReference))
1951     return 190;
1952   if (Right.is(TT_LambdaArrow))
1953     return 110;
1954   if (Left.is(tok::equal) && Right.is(tok::l_brace))
1955     return 150;
1956   if (Left.is(TT_CastRParen))
1957     return 100;
1958   if (Left.is(tok::coloncolon) ||
1959       (Right.is(tok::period) && Style.Language == FormatStyle::LK_Proto))
1960     return 500;
1961   if (Left.isOneOf(tok::kw_class, tok::kw_struct))
1962     return 5000;
1963   if (Left.is(tok::comment))
1964     return 1000;
1965
1966   if (Left.isOneOf(TT_RangeBasedForLoopColon, TT_InheritanceColon))
1967     return 2;
1968
1969   if (Right.isMemberAccess()) {
1970     // Breaking before the "./->" of a chained call/member access is reasonably
1971     // cheap, as formatting those with one call per line is generally
1972     // desirable. In particular, it should be cheaper to break before the call
1973     // than it is to break inside a call's parameters, which could lead to weird
1974     // "hanging" indents. The exception is the very last "./->" to support this
1975     // frequent pattern:
1976     //
1977     //   aaaaaaaa.aaaaaaaa.bbbbbbb().ccccccccccccccccccccc(
1978     //       dddddddd);
1979     //
1980     // which might otherwise be blown up onto many lines. Here, clang-format
1981     // won't produce "hanging" indents anyway as there is no other trailing
1982     // call.
1983     //
1984     // Also apply higher penalty is not a call as that might lead to a wrapping
1985     // like:
1986     //
1987     //   aaaaaaa
1988     //       .aaaaaaaaa.bbbbbbbb(cccccccc);
1989     return !Right.NextOperator || !Right.NextOperator->Previous->closesScope()
1990                ? 150
1991                : 35;
1992   }
1993
1994   if (Right.is(TT_TrailingAnnotation) &&
1995       (!Right.Next || Right.Next->isNot(tok::l_paren))) {
1996     // Moving trailing annotations to the next line is fine for ObjC method
1997     // declarations.
1998     if (Line.startsWith(TT_ObjCMethodSpecifier))
1999       return 10;
2000     // Generally, breaking before a trailing annotation is bad unless it is
2001     // function-like. It seems to be especially preferable to keep standard
2002     // annotations (i.e. "const", "final" and "override") on the same line.
2003     // Use a slightly higher penalty after ")" so that annotations like
2004     // "const override" are kept together.
2005     bool is_short_annotation = Right.TokenText.size() < 10;
2006     return (Left.is(tok::r_paren) ? 100 : 120) + (is_short_annotation ? 50 : 0);
2007   }
2008
2009   // In for-loops, prefer breaking at ',' and ';'.
2010   if (Line.startsWith(tok::kw_for) && Left.is(tok::equal))
2011     return 4;
2012
2013   // In Objective-C method expressions, prefer breaking before "param:" over
2014   // breaking after it.
2015   if (Right.is(TT_SelectorName))
2016     return 0;
2017   if (Left.is(tok::colon) && Left.is(TT_ObjCMethodExpr))
2018     return Line.MightBeFunctionDecl ? 50 : 500;
2019
2020   if (Left.is(tok::l_paren) && InFunctionDecl &&
2021       Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign)
2022     return 100;
2023   if (Left.is(tok::l_paren) && Left.Previous &&
2024       Left.Previous->isOneOf(tok::kw_if, tok::kw_for))
2025     return 1000;
2026   if (Left.is(tok::equal) && InFunctionDecl)
2027     return 110;
2028   if (Right.is(tok::r_brace))
2029     return 1;
2030   if (Left.is(TT_TemplateOpener))
2031     return 100;
2032   if (Left.opensScope()) {
2033     if (Style.AlignAfterOpenBracket == FormatStyle::BAS_DontAlign)
2034       return 0;
2035     return Left.ParameterCount > 1 ? Style.PenaltyBreakBeforeFirstCallParameter
2036                                    : 19;
2037   }
2038   if (Left.is(TT_JavaAnnotation))
2039     return 50;
2040
2041   if (Left.isOneOf(tok::plus, tok::comma) && Left.Previous &&
2042       Left.Previous->isLabelString() &&
2043       (Left.NextOperator || Left.OperatorIndex != 0))
2044     return 45;
2045   if (Right.is(tok::plus) && Left.isLabelString() &&
2046       (Right.NextOperator || Right.OperatorIndex != 0))
2047     return 25;
2048   if (Left.is(tok::comma))
2049     return 1;
2050   if (Right.is(tok::lessless) && Left.isLabelString() &&
2051       (Right.NextOperator || Right.OperatorIndex != 1))
2052     return 25;
2053   if (Right.is(tok::lessless)) {
2054     // Breaking at a << is really cheap.
2055     if (!Left.is(tok::r_paren) || Right.OperatorIndex > 0)
2056       // Slightly prefer to break before the first one in log-like statements.
2057       return 2;
2058     return 1;
2059   }
2060   if (Left.is(TT_ConditionalExpr))
2061     return prec::Conditional;
2062   prec::Level Level = Left.getPrecedence();
2063   if (Level != prec::Unknown)
2064     return Level;
2065   Level = Right.getPrecedence();
2066   if (Level != prec::Unknown)
2067     return Level;
2068
2069   return 3;
2070 }
2071
2072 bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
2073                                           const FormatToken &Left,
2074                                           const FormatToken &Right) {
2075   if (Left.is(tok::kw_return) && Right.isNot(tok::semi))
2076     return true;
2077   if (Style.ObjCSpaceAfterProperty && Line.Type == LT_ObjCProperty &&
2078       Left.Tok.getObjCKeywordID() == tok::objc_property)
2079     return true;
2080   if (Right.is(tok::hashhash))
2081     return Left.is(tok::hash);
2082   if (Left.isOneOf(tok::hashhash, tok::hash))
2083     return Right.is(tok::hash);
2084   if (Left.is(tok::l_paren) && Right.is(tok::r_paren))
2085     return Style.SpaceInEmptyParentheses;
2086   if (Left.is(tok::l_paren) || Right.is(tok::r_paren))
2087     return (Right.is(TT_CastRParen) ||
2088             (Left.MatchingParen && Left.MatchingParen->is(TT_CastRParen)))
2089                ? Style.SpacesInCStyleCastParentheses
2090                : Style.SpacesInParentheses;
2091   if (Right.isOneOf(tok::semi, tok::comma))
2092     return false;
2093   if (Right.is(tok::less) &&
2094       Line.Type == LT_ObjCDecl && Style.ObjCSpaceBeforeProtocolList)
2095     return true;
2096   if (Right.is(tok::less) && Left.is(tok::kw_template))
2097     return Style.SpaceAfterTemplateKeyword;
2098   if (Left.isOneOf(tok::exclaim, tok::tilde))
2099     return false;
2100   if (Left.is(tok::at) &&
2101       Right.isOneOf(tok::identifier, tok::string_literal, tok::char_constant,
2102                     tok::numeric_constant, tok::l_paren, tok::l_brace,
2103                     tok::kw_true, tok::kw_false))
2104     return false;
2105   if (Left.is(tok::colon))
2106     return !Left.is(TT_ObjCMethodExpr);
2107   if (Left.is(tok::coloncolon))
2108     return false;
2109   if (Left.is(tok::less) || Right.isOneOf(tok::greater, tok::less))
2110     return false;
2111   if (Right.is(tok::ellipsis))
2112     return Left.Tok.isLiteral() || (Left.is(tok::identifier) && Left.Previous &&
2113                                     Left.Previous->is(tok::kw_case));
2114   if (Left.is(tok::l_square) && Right.is(tok::amp))
2115     return false;
2116   if (Right.is(TT_PointerOrReference))
2117     return (Left.is(tok::r_paren) && Line.MightBeFunctionDecl) ||
2118            (Left.Tok.isLiteral() || (Left.is(tok::kw_const) && Left.Previous &&
2119                                      Left.Previous->is(tok::r_paren)) ||
2120             (!Left.isOneOf(TT_PointerOrReference, tok::l_paren) &&
2121              (Style.PointerAlignment != FormatStyle::PAS_Left ||
2122               (Line.IsMultiVariableDeclStmt &&
2123                (Left.NestingLevel == 0 ||
2124                 (Left.NestingLevel == 1 && Line.First->is(tok::kw_for)))))));
2125   if (Right.is(TT_FunctionTypeLParen) && Left.isNot(tok::l_paren) &&
2126       (!Left.is(TT_PointerOrReference) ||
2127        (Style.PointerAlignment != FormatStyle::PAS_Right &&
2128         !Line.IsMultiVariableDeclStmt)))
2129     return true;
2130   if (Left.is(TT_PointerOrReference))
2131     return Right.Tok.isLiteral() || Right.is(TT_BlockComment) ||
2132            (Right.isOneOf(Keywords.kw_override, Keywords.kw_final) &&
2133             !Right.is(TT_StartOfName)) ||
2134            (Right.is(tok::l_brace) && Right.BlockKind == BK_Block) ||
2135            (!Right.isOneOf(TT_PointerOrReference, TT_ArraySubscriptLSquare,
2136                            tok::l_paren) &&
2137             (Style.PointerAlignment != FormatStyle::PAS_Right &&
2138              !Line.IsMultiVariableDeclStmt) &&
2139             Left.Previous &&
2140             !Left.Previous->isOneOf(tok::l_paren, tok::coloncolon));
2141   if (Right.is(tok::star) && Left.is(tok::l_paren))
2142     return false;
2143   if (Left.is(tok::l_square))
2144     return (Left.is(TT_ArrayInitializerLSquare) &&
2145             Style.SpacesInContainerLiterals && Right.isNot(tok::r_square)) ||
2146            (Left.is(TT_ArraySubscriptLSquare) && Style.SpacesInSquareBrackets &&
2147             Right.isNot(tok::r_square));
2148   if (Right.is(tok::r_square))
2149     return Right.MatchingParen &&
2150            ((Style.SpacesInContainerLiterals &&
2151              Right.MatchingParen->is(TT_ArrayInitializerLSquare)) ||
2152             (Style.SpacesInSquareBrackets &&
2153              Right.MatchingParen->is(TT_ArraySubscriptLSquare)));
2154   if (Right.is(tok::l_square) &&
2155       !Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare) &&
2156       !Left.isOneOf(tok::numeric_constant, TT_DictLiteral))
2157     return false;
2158   if (Left.is(tok::l_brace) && Right.is(tok::r_brace))
2159     return !Left.Children.empty(); // No spaces in "{}".
2160   if ((Left.is(tok::l_brace) && Left.BlockKind != BK_Block) ||
2161       (Right.is(tok::r_brace) && Right.MatchingParen &&
2162        Right.MatchingParen->BlockKind != BK_Block))
2163     return !Style.Cpp11BracedListStyle;
2164   if (Left.is(TT_BlockComment))
2165     return !Left.TokenText.endswith("=*/");
2166   if (Right.is(tok::l_paren)) {
2167     if (Left.is(tok::r_paren) && Left.is(TT_AttributeParen))
2168       return true;
2169     return Line.Type == LT_ObjCDecl || Left.is(tok::semi) ||
2170            (Style.SpaceBeforeParens != FormatStyle::SBPO_Never &&
2171             (Left.isOneOf(tok::kw_if, tok::pp_elif, tok::kw_for, tok::kw_while,
2172                           tok::kw_switch, tok::kw_case, TT_ForEachMacro,
2173                           TT_ObjCForIn) ||
2174              (Left.isOneOf(tok::kw_try, Keywords.kw___except, tok::kw_catch,
2175                            tok::kw_new, tok::kw_delete) &&
2176               (!Left.Previous || Left.Previous->isNot(tok::period))))) ||
2177            (Style.SpaceBeforeParens == FormatStyle::SBPO_Always &&
2178             (Left.is(tok::identifier) || Left.isFunctionLikeKeyword() ||
2179              Left.is(tok::r_paren)) &&
2180             Line.Type != LT_PreprocessorDirective);
2181   }
2182   if (Left.is(tok::at) && Right.Tok.getObjCKeywordID() != tok::objc_not_keyword)
2183     return false;
2184   if (Right.is(TT_UnaryOperator))
2185     return !Left.isOneOf(tok::l_paren, tok::l_square, tok::at) &&
2186            (Left.isNot(tok::colon) || Left.isNot(TT_ObjCMethodExpr));
2187   if ((Left.isOneOf(tok::identifier, tok::greater, tok::r_square,
2188                     tok::r_paren) ||
2189        Left.isSimpleTypeSpecifier()) &&
2190       Right.is(tok::l_brace) && Right.getNextNonComment() &&
2191       Right.BlockKind != BK_Block)
2192     return false;
2193   if (Left.is(tok::period) || Right.is(tok::period))
2194     return false;
2195   if (Right.is(tok::hash) && Left.is(tok::identifier) && Left.TokenText == "L")
2196     return false;
2197   if (Left.is(TT_TemplateCloser) && Left.MatchingParen &&
2198       Left.MatchingParen->Previous &&
2199       Left.MatchingParen->Previous->is(tok::period))
2200     // A.<B>DoSomething();
2201     return false;
2202   if (Left.is(TT_TemplateCloser) && Right.is(tok::l_square))
2203     return false;
2204   return true;
2205 }
2206
2207 bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
2208                                          const FormatToken &Right) {
2209   const FormatToken &Left = *Right.Previous;
2210   if (Right.Tok.getIdentifierInfo() && Left.Tok.getIdentifierInfo())
2211     return true; // Never ever merge two identifiers.
2212   if (Style.IsCpp()) {
2213     if (Left.is(tok::kw_operator))
2214       return Right.is(tok::coloncolon);
2215   } else if (Style.Language == FormatStyle::LK_Proto) {
2216     if (Right.is(tok::period) &&
2217         Left.isOneOf(Keywords.kw_optional, Keywords.kw_required,
2218                      Keywords.kw_repeated, Keywords.kw_extend))
2219       return true;
2220     if (Right.is(tok::l_paren) &&
2221         Left.isOneOf(Keywords.kw_returns, Keywords.kw_option))
2222       return true;
2223   } else if (Style.Language == FormatStyle::LK_JavaScript) {
2224     if (Left.is(TT_JsFatArrow))
2225       return true;
2226     if (Left.is(Keywords.kw_async) && Right.is(tok::l_paren) &&
2227         Right.MatchingParen) {
2228       const FormatToken *Next = Right.MatchingParen->getNextNonComment();
2229       // An async arrow function, for example: `x = async () => foo();`,
2230       // as opposed to calling a function called async: `x = async();`
2231       if (Next && Next->is(TT_JsFatArrow))
2232         return true;
2233     }
2234     if ((Left.is(TT_TemplateString) && Left.TokenText.endswith("${")) ||
2235         (Right.is(TT_TemplateString) && Right.TokenText.startswith("}")))
2236       return false;
2237     if (Left.is(tok::identifier) && Right.is(TT_TemplateString))
2238       return false;
2239     if (Right.is(tok::star) &&
2240         Left.isOneOf(Keywords.kw_function, Keywords.kw_yield))
2241       return false;
2242     if (Right.isOneOf(tok::l_brace, tok::l_square) &&
2243         Left.isOneOf(Keywords.kw_function, Keywords.kw_yield))
2244       return true;
2245     // JS methods can use some keywords as names (e.g. `delete()`).
2246     if (Right.is(tok::l_paren) && Line.MustBeDeclaration &&
2247         Left.Tok.getIdentifierInfo())
2248       return false;
2249     if (Left.isOneOf(Keywords.kw_let, Keywords.kw_var, Keywords.kw_in,
2250                      Keywords.kw_of, tok::kw_const) &&
2251         (!Left.Previous || !Left.Previous->is(tok::period)))
2252       return true;
2253     if (Left.isOneOf(tok::kw_for, Keywords.kw_as) && Left.Previous &&
2254         Left.Previous->is(tok::period) && Right.is(tok::l_paren))
2255       return false;
2256     if (Left.is(Keywords.kw_as) &&
2257         Right.isOneOf(tok::l_square, tok::l_brace, tok::l_paren))
2258       return true;
2259     if (Left.is(tok::kw_default) && Left.Previous &&
2260         Left.Previous->is(tok::kw_export))
2261       return true;
2262     if (Left.is(Keywords.kw_is) && Right.is(tok::l_brace))
2263       return true;
2264     if (Right.isOneOf(TT_JsTypeColon, TT_JsTypeOptionalQuestion))
2265       return false;
2266     if (Left.is(TT_JsTypeOperator) || Right.is(TT_JsTypeOperator))
2267       return false;
2268     if ((Left.is(tok::l_brace) || Right.is(tok::r_brace)) &&
2269         Line.First->isOneOf(Keywords.kw_import, tok::kw_export))
2270       return false;
2271     if (Left.is(tok::ellipsis))
2272       return false;
2273     if (Left.is(TT_TemplateCloser) &&
2274         !Right.isOneOf(tok::equal, tok::l_brace, tok::comma, tok::l_square,
2275                        Keywords.kw_implements, Keywords.kw_extends))
2276       // Type assertions ('<type>expr') are not followed by whitespace. Other
2277       // locations that should have whitespace following are identified by the
2278       // above set of follower tokens.
2279       return false;
2280     // Postfix non-null assertion operator, as in `foo!.bar()`.
2281     if (Right.is(tok::exclaim) && (Left.isOneOf(tok::identifier, tok::r_paren,
2282                                                 tok::r_square, tok::r_brace) ||
2283                                    Left.Tok.isLiteral()))
2284       return false;
2285     if (Left.is(tok::exclaim) && Right.is(Keywords.kw_as))
2286       return true; // "x! as string"
2287   } else if (Style.Language == FormatStyle::LK_Java) {
2288     if (Left.is(tok::r_square) && Right.is(tok::l_brace))
2289       return true;
2290     if (Left.is(Keywords.kw_synchronized) && Right.is(tok::l_paren))
2291       return Style.SpaceBeforeParens != FormatStyle::SBPO_Never;
2292     if ((Left.isOneOf(tok::kw_static, tok::kw_public, tok::kw_private,
2293                       tok::kw_protected) ||
2294          Left.isOneOf(Keywords.kw_final, Keywords.kw_abstract,
2295                       Keywords.kw_native)) &&
2296         Right.is(TT_TemplateOpener))
2297       return true;
2298   }
2299   if (Left.is(TT_ImplicitStringLiteral))
2300     return Right.WhitespaceRange.getBegin() != Right.WhitespaceRange.getEnd();
2301   if (Line.Type == LT_ObjCMethodDecl) {
2302     if (Left.is(TT_ObjCMethodSpecifier))
2303       return true;
2304     if (Left.is(tok::r_paren) && Right.is(tok::identifier))
2305       // Don't space between ')' and <id>
2306       return false;
2307   }
2308   if (Line.Type == LT_ObjCProperty &&
2309       (Right.is(tok::equal) || Left.is(tok::equal)))
2310     return false;
2311
2312   if (Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow) ||
2313       Left.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow))
2314     return true;
2315   if (Right.is(TT_OverloadedOperatorLParen))
2316     return Style.SpaceBeforeParens == FormatStyle::SBPO_Always;
2317   if (Left.is(tok::comma))
2318     return true;
2319   if (Right.is(tok::comma))
2320     return false;
2321   if (Right.isOneOf(TT_CtorInitializerColon, TT_ObjCBlockLParen))
2322     return true;
2323   if (Right.is(tok::colon)) {
2324     if (Line.First->isOneOf(tok::kw_case, tok::kw_default) ||
2325         !Right.getNextNonComment() || Right.getNextNonComment()->is(tok::semi))
2326       return false;
2327     if (Right.is(TT_ObjCMethodExpr))
2328       return false;
2329     if (Left.is(tok::question))
2330       return false;
2331     if (Right.is(TT_InlineASMColon) && Left.is(tok::coloncolon))
2332       return false;
2333     if (Right.is(TT_DictLiteral))
2334       return Style.SpacesInContainerLiterals;
2335     return true;
2336   }
2337   if (Left.is(TT_UnaryOperator))
2338     return Right.is(TT_BinaryOperator);
2339
2340   // If the next token is a binary operator or a selector name, we have
2341   // incorrectly classified the parenthesis as a cast. FIXME: Detect correctly.
2342   if (Left.is(TT_CastRParen))
2343     return Style.SpaceAfterCStyleCast ||
2344            Right.isOneOf(TT_BinaryOperator, TT_SelectorName);
2345
2346   if (Left.is(tok::greater) && Right.is(tok::greater))
2347     return Right.is(TT_TemplateCloser) && Left.is(TT_TemplateCloser) &&
2348            (Style.Standard != FormatStyle::LS_Cpp11 || Style.SpacesInAngles);
2349   if (Right.isOneOf(tok::arrow, tok::period, tok::arrowstar, tok::periodstar) ||
2350       Left.isOneOf(tok::arrow, tok::period, tok::arrowstar, tok::periodstar))
2351     return false;
2352   if (!Style.SpaceBeforeAssignmentOperators &&
2353       Right.getPrecedence() == prec::Assignment)
2354     return false;
2355   if (Right.is(tok::coloncolon) && Left.is(tok::identifier))
2356     // Generally don't remove existing spaces between an identifier and "::".
2357     // The identifier might actually be a macro name such as ALWAYS_INLINE. If
2358     // this turns out to be too lenient, add analysis of the identifier itself.
2359     return Right.WhitespaceRange.getBegin() != Right.WhitespaceRange.getEnd();
2360   if (Right.is(tok::coloncolon) && !Left.isOneOf(tok::l_brace, tok::comment))
2361     return (Left.is(TT_TemplateOpener) &&
2362             Style.Standard == FormatStyle::LS_Cpp03) ||
2363            !(Left.isOneOf(tok::l_paren, tok::r_paren, tok::l_square,
2364                           TT_TemplateCloser, TT_TemplateOpener));
2365   if ((Left.is(TT_TemplateOpener)) != (Right.is(TT_TemplateCloser)))
2366     return Style.SpacesInAngles;
2367   if ((Right.is(TT_BinaryOperator) && !Left.is(tok::l_paren)) ||
2368       (Left.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) &&
2369        !Right.is(tok::r_paren)))
2370     return true;
2371   if (Left.is(TT_TemplateCloser) && Right.is(tok::l_paren) &&
2372       Right.isNot(TT_FunctionTypeLParen))
2373     return Style.SpaceBeforeParens == FormatStyle::SBPO_Always;
2374   if (Right.is(TT_TemplateOpener) && Left.is(tok::r_paren) &&
2375       Left.MatchingParen && Left.MatchingParen->is(TT_OverloadedOperatorLParen))
2376     return false;
2377   if (Right.is(tok::less) && Left.isNot(tok::l_paren) &&
2378       Line.startsWith(tok::hash))
2379     return true;
2380   if (Right.is(TT_TrailingUnaryOperator))
2381     return false;
2382   if (Left.is(TT_RegexLiteral))
2383     return false;
2384   return spaceRequiredBetween(Line, Left, Right);
2385 }
2386
2387 // Returns 'true' if 'Tok' is a brace we'd want to break before in Allman style.
2388 static bool isAllmanBrace(const FormatToken &Tok) {
2389   return Tok.is(tok::l_brace) && Tok.BlockKind == BK_Block &&
2390          !Tok.isOneOf(TT_ObjCBlockLBrace, TT_DictLiteral);
2391 }
2392
2393 bool TokenAnnotator::mustBreakBefore(const AnnotatedLine &Line,
2394                                      const FormatToken &Right) {
2395   const FormatToken &Left = *Right.Previous;
2396   if (Right.NewlinesBefore > 1 && Style.MaxEmptyLinesToKeep > 0)
2397     return true;
2398
2399   if (Style.Language == FormatStyle::LK_JavaScript) {
2400     // FIXME: This might apply to other languages and token kinds.
2401     if (Right.is(tok::string_literal) && Left.is(tok::plus) && Left.Previous &&
2402         Left.Previous->is(tok::string_literal))
2403       return true;
2404     if (Left.is(TT_DictLiteral) && Left.is(tok::l_brace) && Line.Level == 0 &&
2405         Left.Previous && Left.Previous->is(tok::equal) &&
2406         Line.First->isOneOf(tok::identifier, Keywords.kw_import, tok::kw_export,
2407                             tok::kw_const) &&
2408         // kw_var/kw_let are pseudo-tokens that are tok::identifier, so match
2409         // above.
2410         !Line.First->isOneOf(Keywords.kw_var, Keywords.kw_let))
2411       // Object literals on the top level of a file are treated as "enum-style".
2412       // Each key/value pair is put on a separate line, instead of bin-packing.
2413       return true;
2414     if (Left.is(tok::l_brace) && Line.Level == 0 &&
2415         (Line.startsWith(tok::kw_enum) ||
2416          Line.startsWith(tok::kw_export, tok::kw_enum)))
2417       // JavaScript top-level enum key/value pairs are put on separate lines
2418       // instead of bin-packing.
2419       return true;
2420     if (Right.is(tok::r_brace) && Left.is(tok::l_brace) &&
2421         !Left.Children.empty())
2422       // Support AllowShortFunctionsOnASingleLine for JavaScript.
2423       return Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_None ||
2424              Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_Empty ||
2425              (Left.NestingLevel == 0 && Line.Level == 0 &&
2426               Style.AllowShortFunctionsOnASingleLine ==
2427                   FormatStyle::SFS_Inline);
2428   } else if (Style.Language == FormatStyle::LK_Java) {
2429     if (Right.is(tok::plus) && Left.is(tok::string_literal) && Right.Next &&
2430         Right.Next->is(tok::string_literal))
2431       return true;
2432   } else if (Style.Language == FormatStyle::LK_Cpp ||
2433              Style.Language == FormatStyle::LK_ObjC ||
2434              Style.Language == FormatStyle::LK_Proto) {
2435     if (Left.isStringLiteral() &&
2436         (Right.isStringLiteral() || Right.is(TT_ObjCStringLiteral)))
2437       return true;
2438   }
2439
2440   // If the last token before a '}' is a comma or a trailing comment, the
2441   // intention is to insert a line break after it in order to make shuffling
2442   // around entries easier.
2443   const FormatToken *BeforeClosingBrace = nullptr;
2444   if (Left.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) &&
2445       Left.BlockKind != BK_Block && Left.MatchingParen)
2446     BeforeClosingBrace = Left.MatchingParen->Previous;
2447   else if (Right.MatchingParen &&
2448            Right.MatchingParen->isOneOf(tok::l_brace,
2449                                         TT_ArrayInitializerLSquare))
2450     BeforeClosingBrace = &Left;
2451   if (BeforeClosingBrace && (BeforeClosingBrace->is(tok::comma) ||
2452                              BeforeClosingBrace->isTrailingComment()))
2453     return true;
2454
2455   if (Right.is(tok::comment))
2456     return Left.BlockKind != BK_BracedInit &&
2457            Left.isNot(TT_CtorInitializerColon) &&
2458            (Right.NewlinesBefore > 0 && Right.HasUnescapedNewline);
2459   if (Left.isTrailingComment())
2460     return true;
2461   if (Right.Previous->IsUnterminatedLiteral)
2462     return true;
2463   if (Right.is(tok::lessless) && Right.Next &&
2464       Right.Previous->is(tok::string_literal) &&
2465       Right.Next->is(tok::string_literal))
2466     return true;
2467   if (Right.Previous->ClosesTemplateDeclaration &&
2468       Right.Previous->MatchingParen &&
2469       Right.Previous->MatchingParen->NestingLevel == 0 &&
2470       Style.AlwaysBreakTemplateDeclarations)
2471     return true;
2472   if ((Right.isOneOf(TT_CtorInitializerComma, TT_CtorInitializerColon)) &&
2473       Style.BreakConstructorInitializersBeforeComma &&
2474       !Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
2475     return true;
2476   if (Right.is(tok::string_literal) && Right.TokenText.startswith("R\""))
2477     // Raw string literals are special wrt. line breaks. The author has made a
2478     // deliberate choice and might have aligned the contents of the string
2479     // literal accordingly. Thus, we try keep existing line breaks.
2480     return Right.NewlinesBefore > 0;
2481   if (Right.Previous->is(tok::l_brace) && Right.NestingLevel == 1 &&
2482       Style.Language == FormatStyle::LK_Proto)
2483     // Don't put enums onto single lines in protocol buffers.
2484     return true;
2485   if (Right.is(TT_InlineASMBrace))
2486     return Right.HasUnescapedNewline;
2487   if (isAllmanBrace(Left) || isAllmanBrace(Right))
2488     return (Line.startsWith(tok::kw_enum) && Style.BraceWrapping.AfterEnum) ||
2489            (Line.startsWith(tok::kw_class) && Style.BraceWrapping.AfterClass) ||
2490            (Line.startsWith(tok::kw_struct) && Style.BraceWrapping.AfterStruct);
2491   if (Left.is(TT_ObjCBlockLBrace) && !Style.AllowShortBlocksOnASingleLine)
2492     return true;
2493
2494   if ((Style.Language == FormatStyle::LK_Java ||
2495        Style.Language == FormatStyle::LK_JavaScript) &&
2496       Left.is(TT_LeadingJavaAnnotation) &&
2497       Right.isNot(TT_LeadingJavaAnnotation) && Right.isNot(tok::l_paren) &&
2498       (Line.Last->is(tok::l_brace) || Style.BreakAfterJavaFieldAnnotations))
2499     return true;
2500
2501   return false;
2502 }
2503
2504 bool TokenAnnotator::canBreakBefore(const AnnotatedLine &Line,
2505                                     const FormatToken &Right) {
2506   const FormatToken &Left = *Right.Previous;
2507
2508   // Language-specific stuff.
2509   if (Style.Language == FormatStyle::LK_Java) {
2510     if (Left.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
2511                      Keywords.kw_implements))
2512       return false;
2513     if (Right.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
2514                       Keywords.kw_implements))
2515       return true;
2516   } else if (Style.Language == FormatStyle::LK_JavaScript) {
2517     const FormatToken *NonComment = Right.getPreviousNonComment();
2518     if (Left.isOneOf(tok::kw_return, tok::kw_continue, tok::kw_break,
2519                      tok::kw_throw) ||
2520         (NonComment &&
2521          NonComment->isOneOf(tok::kw_return, tok::kw_continue, tok::kw_break,
2522                              tok::kw_throw)))
2523       return false; // Otherwise a semicolon is inserted.
2524     if (Left.is(TT_JsFatArrow) && Right.is(tok::l_brace))
2525       return false;
2526     if (Left.is(TT_JsTypeColon))
2527       return true;
2528     if (Right.NestingLevel == 0 && Right.is(Keywords.kw_is))
2529       return false;
2530     if (Left.is(Keywords.kw_in))
2531       return Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None;
2532     if (Right.is(Keywords.kw_in))
2533       return Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None;
2534     if (Right.is(Keywords.kw_as))
2535       return false; // must not break before as in 'x as type' casts
2536     if (Left.is(Keywords.kw_as))
2537       return true;
2538     if (Left.is(Keywords.kw_declare) &&
2539         Right.isOneOf(Keywords.kw_module, tok::kw_namespace,
2540                       Keywords.kw_function, tok::kw_class, tok::kw_enum,
2541                       Keywords.kw_interface, Keywords.kw_type, Keywords.kw_var,
2542                       Keywords.kw_let, tok::kw_const))
2543       // See grammar for 'declare' statements at:
2544       // https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md#A.10
2545       return false;
2546     if (Left.isOneOf(Keywords.kw_module, tok::kw_namespace) &&
2547         Right.isOneOf(tok::identifier, tok::string_literal))
2548       return false; // must not break in "module foo { ...}"
2549     if (Right.is(TT_TemplateString) && Right.closesScope())
2550       return false;
2551     if (Left.is(TT_TemplateString) && Left.opensScope())
2552       return true;
2553   }
2554
2555   if (Left.is(tok::at))
2556     return false;
2557   if (Left.Tok.getObjCKeywordID() == tok::objc_interface)
2558     return false;
2559   if (Left.isOneOf(TT_JavaAnnotation, TT_LeadingJavaAnnotation))
2560     return !Right.is(tok::l_paren);
2561   if (Right.is(TT_PointerOrReference))
2562     return Line.IsMultiVariableDeclStmt ||
2563            (Style.PointerAlignment == FormatStyle::PAS_Right &&
2564             (!Right.Next || Right.Next->isNot(TT_FunctionDeclarationName)));
2565   if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
2566       Right.is(tok::kw_operator))
2567     return true;
2568   if (Left.is(TT_PointerOrReference))
2569     return false;
2570   if (Right.isTrailingComment())
2571     // We rely on MustBreakBefore being set correctly here as we should not
2572     // change the "binding" behavior of a comment.
2573     // The first comment in a braced lists is always interpreted as belonging to
2574     // the first list element. Otherwise, it should be placed outside of the
2575     // list.
2576     return Left.BlockKind == BK_BracedInit;
2577   if (Left.is(tok::question) && Right.is(tok::colon))
2578     return false;
2579   if (Right.is(TT_ConditionalExpr) || Right.is(tok::question))
2580     return Style.BreakBeforeTernaryOperators;
2581   if (Left.is(TT_ConditionalExpr) || Left.is(tok::question))
2582     return !Style.BreakBeforeTernaryOperators;
2583   if (Right.is(TT_InheritanceColon))
2584     return true;
2585   if (Right.is(TT_ObjCMethodExpr) && !Right.is(tok::r_square) &&
2586       Left.isNot(TT_SelectorName))
2587     return true;
2588   if (Right.is(tok::colon) &&
2589       !Right.isOneOf(TT_CtorInitializerColon, TT_InlineASMColon))
2590     return false;
2591   if (Left.is(tok::colon) && Left.isOneOf(TT_DictLiteral, TT_ObjCMethodExpr))
2592     return true;
2593   if (Right.is(TT_SelectorName) || (Right.is(tok::identifier) && Right.Next &&
2594                                     Right.Next->is(TT_ObjCMethodExpr)))
2595     return Left.isNot(tok::period); // FIXME: Properly parse ObjC calls.
2596   if (Left.is(tok::r_paren) && Line.Type == LT_ObjCProperty)
2597     return true;
2598   if (Left.ClosesTemplateDeclaration || Left.is(TT_FunctionAnnotationRParen))
2599     return true;
2600   if (Right.isOneOf(TT_RangeBasedForLoopColon, TT_OverloadedOperatorLParen,
2601                     TT_OverloadedOperator))
2602     return false;
2603   if (Left.is(TT_RangeBasedForLoopColon))
2604     return true;
2605   if (Right.is(TT_RangeBasedForLoopColon))
2606     return false;
2607   if (Left.is(TT_TemplateCloser) && Right.is(TT_TemplateOpener))
2608     return true;
2609   if (Left.isOneOf(TT_TemplateCloser, TT_UnaryOperator) ||
2610       Left.is(tok::kw_operator))
2611     return false;
2612   if (Left.is(tok::equal) && !Right.isOneOf(tok::kw_default, tok::kw_delete) &&
2613       Line.Type == LT_VirtualFunctionDecl && Left.NestingLevel == 0)
2614     return false;
2615   if (Left.is(tok::l_paren) && Left.is(TT_AttributeParen))
2616     return false;
2617   if (Left.is(tok::l_paren) && Left.Previous &&
2618       (Left.Previous->isOneOf(TT_BinaryOperator, TT_CastRParen)))
2619     return false;
2620   if (Right.is(TT_ImplicitStringLiteral))
2621     return false;
2622
2623   if (Right.is(tok::r_paren) || Right.is(TT_TemplateCloser))
2624     return false;
2625   if (Right.is(tok::r_square) && Right.MatchingParen &&
2626       Right.MatchingParen->is(TT_LambdaLSquare))
2627     return false;
2628
2629   // We only break before r_brace if there was a corresponding break before
2630   // the l_brace, which is tracked by BreakBeforeClosingBrace.
2631   if (Right.is(tok::r_brace))
2632     return Right.MatchingParen && Right.MatchingParen->BlockKind == BK_Block;
2633
2634   // Allow breaking after a trailing annotation, e.g. after a method
2635   // declaration.
2636   if (Left.is(TT_TrailingAnnotation))
2637     return !Right.isOneOf(tok::l_brace, tok::semi, tok::equal, tok::l_paren,
2638                           tok::less, tok::coloncolon);
2639
2640   if (Right.is(tok::kw___attribute))
2641     return true;
2642
2643   if (Left.is(tok::identifier) && Right.is(tok::string_literal))
2644     return true;
2645
2646   if (Right.is(tok::identifier) && Right.Next && Right.Next->is(TT_DictLiteral))
2647     return true;
2648
2649   if (Left.is(TT_CtorInitializerComma) &&
2650       Style.BreakConstructorInitializersBeforeComma)
2651     return false;
2652   if (Right.is(TT_CtorInitializerComma) &&
2653       Style.BreakConstructorInitializersBeforeComma)
2654     return true;
2655   if ((Left.is(tok::greater) && Right.is(tok::greater)) ||
2656       (Left.is(tok::less) && Right.is(tok::less)))
2657     return false;
2658   if (Right.is(TT_BinaryOperator) &&
2659       Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None &&
2660       (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_All ||
2661        Right.getPrecedence() != prec::Assignment))
2662     return true;
2663   if (Left.is(TT_ArrayInitializerLSquare))
2664     return true;
2665   if (Right.is(tok::kw_typename) && Left.isNot(tok::kw_const))
2666     return true;
2667   if ((Left.isBinaryOperator() || Left.is(TT_BinaryOperator)) &&
2668       !Left.isOneOf(tok::arrowstar, tok::lessless) &&
2669       Style.BreakBeforeBinaryOperators != FormatStyle::BOS_All &&
2670       (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None ||
2671        Left.getPrecedence() == prec::Assignment))
2672     return true;
2673   return Left.isOneOf(tok::comma, tok::coloncolon, tok::semi, tok::l_brace,
2674                       tok::kw_class, tok::kw_struct, tok::comment) ||
2675          Right.isMemberAccess() ||
2676          Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow, tok::lessless,
2677                        tok::colon, tok::l_square, tok::at) ||
2678          (Left.is(tok::r_paren) &&
2679           Right.isOneOf(tok::identifier, tok::kw_const)) ||
2680          (Left.is(tok::l_paren) && !Right.is(tok::r_paren)) ||
2681          (Left.is(TT_TemplateOpener) && !Right.is(TT_TemplateCloser));
2682 }
2683
2684 void TokenAnnotator::printDebugInfo(const AnnotatedLine &Line) {
2685   llvm::errs() << "AnnotatedTokens:\n";
2686   const FormatToken *Tok = Line.First;
2687   while (Tok) {
2688     llvm::errs() << " M=" << Tok->MustBreakBefore
2689                  << " C=" << Tok->CanBreakBefore
2690                  << " T=" << getTokenTypeName(Tok->Type)
2691                  << " S=" << Tok->SpacesRequiredBefore
2692                  << " B=" << Tok->BlockParameterCount
2693                  << " BK=" << Tok->BlockKind
2694                  << " P=" << Tok->SplitPenalty << " Name=" << Tok->Tok.getName()
2695                  << " L=" << Tok->TotalLength << " PPK=" << Tok->PackingKind
2696                  << " FakeLParens=";
2697     for (unsigned i = 0, e = Tok->FakeLParens.size(); i != e; ++i)
2698       llvm::errs() << Tok->FakeLParens[i] << "/";
2699     llvm::errs() << " FakeRParens=" << Tok->FakeRParens;
2700     llvm::errs() << " Text='" << Tok->TokenText << "'\n";
2701     if (!Tok->Next)
2702       assert(Tok == Line.Last);
2703     Tok = Tok->Next;
2704   }
2705   llvm::errs() << "----\n";
2706 }
2707
2708 } // namespace format
2709 } // namespace clang