clang  10.0.0svn
TokenAnnotator.cpp
Go to the documentation of this file.
1 //===--- TokenAnnotator.cpp - Format C++ code -----------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// This file implements a token annotator, i.e. creates
11 /// \c AnnotatedTokens out of \c FormatTokens with required extra information.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #include "TokenAnnotator.h"
16 #include "FormatToken.h"
18 #include "clang/Basic/TokenKinds.h"
19 #include "llvm/ADT/SmallPtrSet.h"
20 #include "llvm/Support/Debug.h"
21 
22 #define DEBUG_TYPE "format-token-annotator"
23 
24 namespace clang {
25 namespace format {
26 
27 namespace {
28 
29 /// Returns \c true if the token can be used as an identifier in
30 /// an Objective-C \c @selector, \c false otherwise.
31 ///
32 /// Because getFormattingLangOpts() always lexes source code as
33 /// Objective-C++, C++ keywords like \c new and \c delete are
34 /// lexed as tok::kw_*, not tok::identifier, even for Objective-C.
35 ///
36 /// For Objective-C and Objective-C++, both identifiers and keywords
37 /// are valid inside @selector(...) (or a macro which
38 /// invokes @selector(...)). So, we allow treat any identifier or
39 /// keyword as a potential Objective-C selector component.
40 static bool canBeObjCSelectorComponent(const FormatToken &Tok) {
41  return Tok.Tok.getIdentifierInfo() != nullptr;
42 }
43 
44 /// With `Left` being '(', check if we're at either `[...](` or
45 /// `[...]<...>(`, where the [ opens a lambda capture list.
46 static bool isLambdaParameterList(const FormatToken *Left) {
47  // Skip <...> if present.
48  if (Left->Previous && Left->Previous->is(tok::greater) &&
49  Left->Previous->MatchingParen &&
50  Left->Previous->MatchingParen->is(TT_TemplateOpener))
51  Left = Left->Previous->MatchingParen;
52 
53  // Check for `[...]`.
54  return Left->Previous && Left->Previous->is(tok::r_square) &&
55  Left->Previous->MatchingParen &&
56  Left->Previous->MatchingParen->is(TT_LambdaLSquare);
57 }
58 
59 /// A parser that gathers additional information about tokens.
60 ///
61 /// The \c TokenAnnotator tries to match parenthesis and square brakets and
62 /// store a parenthesis levels. It also tries to resolve matching "<" and ">"
63 /// into template parameter lists.
64 class AnnotatingParser {
65 public:
66  AnnotatingParser(const FormatStyle &Style, AnnotatedLine &Line,
67  const AdditionalKeywords &Keywords)
68  : Style(Style), Line(Line), CurrentToken(Line.First), AutoFound(false),
69  Keywords(Keywords) {
70  Contexts.push_back(Context(tok::unknown, 1, /*IsExpression=*/false));
71  resetTokenMetadata(CurrentToken);
72  }
73 
74 private:
75  bool parseAngle() {
76  if (!CurrentToken || !CurrentToken->Previous)
77  return false;
78  if (NonTemplateLess.count(CurrentToken->Previous))
79  return false;
80 
81  const FormatToken &Previous = *CurrentToken->Previous; // The '<'.
82  if (Previous.Previous) {
83  if (Previous.Previous->Tok.isLiteral())
84  return false;
85  if (Previous.Previous->is(tok::r_paren) && Contexts.size() > 1 &&
86  (!Previous.Previous->MatchingParen ||
87  !Previous.Previous->MatchingParen->is(TT_OverloadedOperatorLParen)))
88  return false;
89  }
90 
91  FormatToken *Left = CurrentToken->Previous;
92  Left->ParentBracket = Contexts.back().ContextKind;
93  ScopedContextCreator ContextCreator(*this, tok::less, 12);
94 
95  // If this angle is in the context of an expression, we need to be more
96  // hesitant to detect it as opening template parameters.
97  bool InExprContext = Contexts.back().IsExpression;
98 
99  Contexts.back().IsExpression = false;
100  // If there's a template keyword before the opening angle bracket, this is a
101  // template parameter, not an argument.
102  Contexts.back().InTemplateArgument =
103  Left->Previous && Left->Previous->Tok.isNot(tok::kw_template);
104 
105  if (Style.Language == FormatStyle::LK_Java &&
106  CurrentToken->is(tok::question))
107  next();
108 
109  while (CurrentToken) {
110  if (CurrentToken->is(tok::greater)) {
111  Left->MatchingParen = CurrentToken;
112  CurrentToken->MatchingParen = Left;
113  // In TT_Proto, we must distignuish between:
114  // map<key, value>
115  // msg < item: data >
116  // msg: < item: data >
117  // In TT_TextProto, map<key, value> does not occur.
118  if (Style.Language == FormatStyle::LK_TextProto ||
119  (Style.Language == FormatStyle::LK_Proto && Left->Previous &&
120  Left->Previous->isOneOf(TT_SelectorName, TT_DictLiteral)))
121  CurrentToken->Type = TT_DictLiteral;
122  else
123  CurrentToken->Type = TT_TemplateCloser;
124  next();
125  return true;
126  }
127  if (CurrentToken->is(tok::question) &&
128  Style.Language == FormatStyle::LK_Java) {
129  next();
130  continue;
131  }
132  if (CurrentToken->isOneOf(tok::r_paren, tok::r_square, tok::r_brace) ||
133  (CurrentToken->isOneOf(tok::colon, tok::question) && InExprContext &&
134  Style.Language != FormatStyle::LK_Proto &&
135  Style.Language != FormatStyle::LK_TextProto))
136  return false;
137  // If a && or || is found and interpreted as a binary operator, this set
138  // of angles is likely part of something like "a < b && c > d". If the
139  // angles are inside an expression, the ||/&& might also be a binary
140  // operator that was misinterpreted because we are parsing template
141  // parameters.
142  // FIXME: This is getting out of hand, write a decent parser.
143  if (CurrentToken->Previous->isOneOf(tok::pipepipe, tok::ampamp) &&
144  CurrentToken->Previous->is(TT_BinaryOperator) &&
145  Contexts[Contexts.size() - 2].IsExpression &&
146  !Line.startsWith(tok::kw_template))
147  return false;
148  updateParameterCount(Left, CurrentToken);
149  if (Style.Language == FormatStyle::LK_Proto) {
150  if (FormatToken *Previous = CurrentToken->getPreviousNonComment()) {
151  if (CurrentToken->is(tok::colon) ||
152  (CurrentToken->isOneOf(tok::l_brace, tok::less) &&
153  Previous->isNot(tok::colon)))
154  Previous->Type = TT_SelectorName;
155  }
156  }
157  if (!consumeToken())
158  return false;
159  }
160  return false;
161  }
162 
163  bool parseParens(bool LookForDecls = false) {
164  if (!CurrentToken)
165  return false;
166  FormatToken *Left = CurrentToken->Previous;
167  Left->ParentBracket = Contexts.back().ContextKind;
168  ScopedContextCreator ContextCreator(*this, tok::l_paren, 1);
169 
170  // FIXME: This is a bit of a hack. Do better.
171  Contexts.back().ColonIsForRangeExpr =
172  Contexts.size() == 2 && Contexts[0].ColonIsForRangeExpr;
173 
174  bool StartsObjCMethodExpr = false;
175  if (FormatToken *MaybeSel = Left->Previous) {
176  // @selector( starts a selector.
177  if (MaybeSel->isObjCAtKeyword(tok::objc_selector) && MaybeSel->Previous &&
178  MaybeSel->Previous->is(tok::at)) {
179  StartsObjCMethodExpr = true;
180  }
181  }
182 
183  if (Left->is(TT_OverloadedOperatorLParen)) {
184  Contexts.back().IsExpression = false;
185  } else if (Style.Language == FormatStyle::LK_JavaScript &&
186  (Line.startsWith(Keywords.kw_type, tok::identifier) ||
187  Line.startsWith(tok::kw_export, Keywords.kw_type,
188  tok::identifier))) {
189  // type X = (...);
190  // export type X = (...);
191  Contexts.back().IsExpression = false;
192  } else if (Left->Previous &&
193  (Left->Previous->isOneOf(tok::kw_static_assert, tok::kw_decltype,
194  tok::kw_while, tok::l_paren,
195  tok::comma) ||
196  Left->Previous->isIf() ||
197  Left->Previous->is(TT_BinaryOperator))) {
198  // static_assert, if and while usually contain expressions.
199  Contexts.back().IsExpression = true;
200  } else if (Style.Language == FormatStyle::LK_JavaScript && Left->Previous &&
201  (Left->Previous->is(Keywords.kw_function) ||
202  (Left->Previous->endsSequence(tok::identifier,
203  Keywords.kw_function)))) {
204  // function(...) or function f(...)
205  Contexts.back().IsExpression = false;
206  } else if (Style.Language == FormatStyle::LK_JavaScript && Left->Previous &&
207  Left->Previous->is(TT_JsTypeColon)) {
208  // let x: (SomeType);
209  Contexts.back().IsExpression = false;
210  } else if (isLambdaParameterList(Left)) {
211  // This is a parameter list of a lambda expression.
212  Contexts.back().IsExpression = false;
213  } else if (Line.InPPDirective &&
214  (!Left->Previous || !Left->Previous->is(tok::identifier))) {
215  Contexts.back().IsExpression = true;
216  } else if (Contexts[Contexts.size() - 2].CaretFound) {
217  // This is the parameter list of an ObjC block.
218  Contexts.back().IsExpression = false;
219  } else if (Left->Previous && Left->Previous->is(tok::kw___attribute)) {
220  Left->Type = TT_AttributeParen;
221  } else if (Left->Previous && Left->Previous->is(TT_ForEachMacro)) {
222  // The first argument to a foreach macro is a declaration.
223  Contexts.back().IsForEachMacro = true;
224  Contexts.back().IsExpression = false;
225  } else if (Left->Previous && Left->Previous->MatchingParen &&
226  Left->Previous->MatchingParen->is(TT_ObjCBlockLParen)) {
227  Contexts.back().IsExpression = false;
228  } else if (!Line.MustBeDeclaration && !Line.InPPDirective) {
229  bool IsForOrCatch =
230  Left->Previous && Left->Previous->isOneOf(tok::kw_for, tok::kw_catch);
231  Contexts.back().IsExpression = !IsForOrCatch;
232  }
233 
234  if (StartsObjCMethodExpr) {
235  Contexts.back().ColonIsObjCMethodExpr = true;
236  Left->Type = TT_ObjCMethodExpr;
237  }
238 
239  // MightBeFunctionType and ProbablyFunctionType are used for
240  // function pointer and reference types as well as Objective-C
241  // block types:
242  //
243  // void (*FunctionPointer)(void);
244  // void (&FunctionReference)(void);
245  // void (^ObjCBlock)(void);
246  bool MightBeFunctionType = !Contexts[Contexts.size() - 2].IsExpression;
247  bool ProbablyFunctionType =
248  CurrentToken->isOneOf(tok::star, tok::amp, tok::caret);
249  bool HasMultipleLines = false;
250  bool HasMultipleParametersOnALine = false;
251  bool MightBeObjCForRangeLoop =
252  Left->Previous && Left->Previous->is(tok::kw_for);
253  FormatToken *PossibleObjCForInToken = nullptr;
254  while (CurrentToken) {
255  // LookForDecls is set when "if (" has been seen. Check for
256  // 'identifier' '*' 'identifier' followed by not '=' -- this
257  // '*' has to be a binary operator but determineStarAmpUsage() will
258  // categorize it as an unary operator, so set the right type here.
259  if (LookForDecls && CurrentToken->Next) {
260  FormatToken *Prev = CurrentToken->getPreviousNonComment();
261  if (Prev) {
262  FormatToken *PrevPrev = Prev->getPreviousNonComment();
263  FormatToken *Next = CurrentToken->Next;
264  if (PrevPrev && PrevPrev->is(tok::identifier) &&
265  Prev->isOneOf(tok::star, tok::amp, tok::ampamp) &&
266  CurrentToken->is(tok::identifier) && Next->isNot(tok::equal)) {
267  Prev->Type = TT_BinaryOperator;
268  LookForDecls = false;
269  }
270  }
271  }
272 
273  if (CurrentToken->Previous->is(TT_PointerOrReference) &&
274  CurrentToken->Previous->Previous->isOneOf(tok::l_paren,
275  tok::coloncolon))
276  ProbablyFunctionType = true;
277  if (CurrentToken->is(tok::comma))
278  MightBeFunctionType = false;
279  if (CurrentToken->Previous->is(TT_BinaryOperator))
280  Contexts.back().IsExpression = true;
281  if (CurrentToken->is(tok::r_paren)) {
282  if (MightBeFunctionType && ProbablyFunctionType && CurrentToken->Next &&
283  (CurrentToken->Next->is(tok::l_paren) ||
284  (CurrentToken->Next->is(tok::l_square) && Line.MustBeDeclaration)))
285  Left->Type = Left->Next->is(tok::caret) ? TT_ObjCBlockLParen
286  : TT_FunctionTypeLParen;
287  Left->MatchingParen = CurrentToken;
288  CurrentToken->MatchingParen = Left;
289 
290  if (CurrentToken->Next && CurrentToken->Next->is(tok::l_brace) &&
291  Left->Previous && Left->Previous->is(tok::l_paren)) {
292  // Detect the case where macros are used to generate lambdas or
293  // function bodies, e.g.:
294  // auto my_lambda = MARCO((Type *type, int i) { .. body .. });
295  for (FormatToken *Tok = Left; Tok != CurrentToken; Tok = Tok->Next) {
296  if (Tok->is(TT_BinaryOperator) &&
297  Tok->isOneOf(tok::star, tok::amp, tok::ampamp))
298  Tok->Type = TT_PointerOrReference;
299  }
300  }
301 
302  if (StartsObjCMethodExpr) {
303  CurrentToken->Type = TT_ObjCMethodExpr;
304  if (Contexts.back().FirstObjCSelectorName) {
305  Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
306  Contexts.back().LongestObjCSelectorName;
307  }
308  }
309 
310  if (Left->is(TT_AttributeParen))
311  CurrentToken->Type = TT_AttributeParen;
312  if (Left->Previous && Left->Previous->is(TT_JavaAnnotation))
313  CurrentToken->Type = TT_JavaAnnotation;
314  if (Left->Previous && Left->Previous->is(TT_LeadingJavaAnnotation))
315  CurrentToken->Type = TT_LeadingJavaAnnotation;
316  if (Left->Previous && Left->Previous->is(TT_AttributeSquare))
317  CurrentToken->Type = TT_AttributeSquare;
318 
319  if (!HasMultipleLines)
320  Left->PackingKind = PPK_Inconclusive;
321  else if (HasMultipleParametersOnALine)
322  Left->PackingKind = PPK_BinPacked;
323  else
324  Left->PackingKind = PPK_OnePerLine;
325 
326  next();
327  return true;
328  }
329  if (CurrentToken->isOneOf(tok::r_square, tok::r_brace))
330  return false;
331 
332  if (CurrentToken->is(tok::l_brace))
333  Left->Type = TT_Unknown; // Not TT_ObjCBlockLParen
334  if (CurrentToken->is(tok::comma) && CurrentToken->Next &&
335  !CurrentToken->Next->HasUnescapedNewline &&
336  !CurrentToken->Next->isTrailingComment())
337  HasMultipleParametersOnALine = true;
338  if ((CurrentToken->Previous->isOneOf(tok::kw_const, tok::kw_auto) ||
339  CurrentToken->Previous->isSimpleTypeSpecifier()) &&
340  !CurrentToken->is(tok::l_brace))
341  Contexts.back().IsExpression = false;
342  if (CurrentToken->isOneOf(tok::semi, tok::colon)) {
343  MightBeObjCForRangeLoop = false;
344  if (PossibleObjCForInToken) {
345  PossibleObjCForInToken->Type = TT_Unknown;
346  PossibleObjCForInToken = nullptr;
347  }
348  }
349  if (MightBeObjCForRangeLoop && CurrentToken->is(Keywords.kw_in)) {
350  PossibleObjCForInToken = CurrentToken;
351  PossibleObjCForInToken->Type = TT_ObjCForIn;
352  }
353  // When we discover a 'new', we set CanBeExpression to 'false' in order to
354  // parse the type correctly. Reset that after a comma.
355  if (CurrentToken->is(tok::comma))
356  Contexts.back().CanBeExpression = true;
357 
358  FormatToken *Tok = CurrentToken;
359  if (!consumeToken())
360  return false;
361  updateParameterCount(Left, Tok);
362  if (CurrentToken && CurrentToken->HasUnescapedNewline)
363  HasMultipleLines = true;
364  }
365  return false;
366  }
367 
368  bool isCSharpAttributeSpecifier(const FormatToken &Tok) {
369  if (!Style.isCSharp())
370  return false;
371 
372  const FormatToken *AttrTok = Tok.Next;
373  if (!AttrTok)
374  return false;
375 
376  // Just an empty declaration e.g. string [].
377  if (AttrTok->is(tok::r_square))
378  return false;
379 
380  // Move along the tokens inbetween the '[' and ']' e.g. [STAThread].
381  while (AttrTok && AttrTok->isNot(tok::r_square)) {
382  AttrTok = AttrTok->Next;
383  }
384 
385  if (!AttrTok)
386  return false;
387 
388  // Move past the end of ']'.
389  AttrTok = AttrTok->Next;
390  if (!AttrTok)
391  return false;
392 
393  // Limit this to being an access modifier that follows.
394  if (AttrTok->isOneOf(tok::kw_public, tok::kw_private, tok::kw_protected,
395  tok::kw_class, tok::kw_static, tok::l_square,
396  Keywords.kw_internal)) {
397  return true;
398  }
399 
400  // incase its a [XXX] retval func(....
401  if (AttrTok->Next &&
402  AttrTok->Next->startsSequence(tok::identifier, tok::l_paren))
403  return true;
404 
405  return false;
406  }
407 
408  bool isCpp11AttributeSpecifier(const FormatToken &Tok) {
409  if (!Style.isCpp() || !Tok.startsSequence(tok::l_square, tok::l_square))
410  return false;
411  // The first square bracket is part of an ObjC array literal
412  if (Tok.Previous && Tok.Previous->is(tok::at)) {
413  return false;
414  }
415  const FormatToken *AttrTok = Tok.Next->Next;
416  if (!AttrTok)
417  return false;
418  // C++17 '[[using ns: foo, bar(baz, blech)]]'
419  // We assume nobody will name an ObjC variable 'using'.
420  if (AttrTok->startsSequence(tok::kw_using, tok::identifier, tok::colon))
421  return true;
422  if (AttrTok->isNot(tok::identifier))
423  return false;
424  while (AttrTok && !AttrTok->startsSequence(tok::r_square, tok::r_square)) {
425  // ObjC message send. We assume nobody will use : in a C++11 attribute
426  // specifier parameter, although this is technically valid:
427  // [[foo(:)]].
428  if (AttrTok->is(tok::colon) ||
429  AttrTok->startsSequence(tok::identifier, tok::identifier) ||
430  AttrTok->startsSequence(tok::r_paren, tok::identifier))
431  return false;
432  if (AttrTok->is(tok::ellipsis))
433  return true;
434  AttrTok = AttrTok->Next;
435  }
436  return AttrTok && AttrTok->startsSequence(tok::r_square, tok::r_square);
437  }
438 
439  bool parseSquare() {
440  if (!CurrentToken)
441  return false;
442 
443  // A '[' could be an index subscript (after an identifier or after
444  // ')' or ']'), it could be the start of an Objective-C method
445  // expression, it could the start of an Objective-C array literal,
446  // or it could be a C++ attribute specifier [[foo::bar]].
447  FormatToken *Left = CurrentToken->Previous;
448  Left->ParentBracket = Contexts.back().ContextKind;
449  FormatToken *Parent = Left->getPreviousNonComment();
450 
451  // Cases where '>' is followed by '['.
452  // In C++, this can happen either in array of templates (foo<int>[10])
453  // or when array is a nested template type (unique_ptr<type1<type2>[]>).
454  bool CppArrayTemplates =
455  Style.isCpp() && Parent && Parent->is(TT_TemplateCloser) &&
456  (Contexts.back().CanBeExpression || Contexts.back().IsExpression ||
457  Contexts.back().InTemplateArgument);
458 
459  bool IsCpp11AttributeSpecifier = isCpp11AttributeSpecifier(*Left) ||
460  Contexts.back().InCpp11AttributeSpecifier;
461 
462  // Treat C# Attributes [STAThread] much like C++ attributes [[...]].
463  bool IsCSharp11AttributeSpecifier =
464  isCSharpAttributeSpecifier(*Left) ||
465  Contexts.back().InCSharpAttributeSpecifier;
466 
467  bool InsideInlineASM = Line.startsWith(tok::kw_asm);
468  bool IsCppStructuredBinding = Left->isCppStructuredBinding(Style);
469  bool StartsObjCMethodExpr =
470  !IsCppStructuredBinding && !InsideInlineASM && !CppArrayTemplates &&
471  Style.isCpp() && !IsCpp11AttributeSpecifier &&
472  Contexts.back().CanBeExpression && Left->isNot(TT_LambdaLSquare) &&
473  !CurrentToken->isOneOf(tok::l_brace, tok::r_square) &&
474  (!Parent ||
475  Parent->isOneOf(tok::colon, tok::l_square, tok::l_paren,
476  tok::kw_return, tok::kw_throw) ||
477  Parent->isUnaryOperator() ||
478  // FIXME(bug 36976): ObjC return types shouldn't use TT_CastRParen.
479  Parent->isOneOf(TT_ObjCForIn, TT_CastRParen) ||
480  (getBinOpPrecedence(Parent->Tok.getKind(), true, true) >
481  prec::Unknown));
482  bool ColonFound = false;
483 
484  unsigned BindingIncrease = 1;
485  if (IsCppStructuredBinding) {
486  Left->Type = TT_StructuredBindingLSquare;
487  } else if (Left->is(TT_Unknown)) {
488  if (StartsObjCMethodExpr) {
489  Left->Type = TT_ObjCMethodExpr;
490  } else if (IsCpp11AttributeSpecifier) {
491  Left->Type = TT_AttributeSquare;
492  } else if (Style.Language == FormatStyle::LK_JavaScript && Parent &&
493  Contexts.back().ContextKind == tok::l_brace &&
494  Parent->isOneOf(tok::l_brace, tok::comma)) {
495  Left->Type = TT_JsComputedPropertyName;
496  } else if (Style.isCpp() && Contexts.back().ContextKind == tok::l_brace &&
497  Parent && Parent->isOneOf(tok::l_brace, tok::comma)) {
498  Left->Type = TT_DesignatedInitializerLSquare;
499  } else if (IsCSharp11AttributeSpecifier) {
500  Left->Type = TT_AttributeSquare;
501  } else if (CurrentToken->is(tok::r_square) && Parent &&
502  Parent->is(TT_TemplateCloser)) {
503  Left->Type = TT_ArraySubscriptLSquare;
504  } else if (Style.Language == FormatStyle::LK_Proto ||
505  Style.Language == FormatStyle::LK_TextProto) {
506  // Square braces in LK_Proto can either be message field attributes:
507  //
508  // optional Aaa aaa = 1 [
509  // (aaa) = aaa
510  // ];
511  //
512  // extensions 123 [
513  // (aaa) = aaa
514  // ];
515  //
516  // or text proto extensions (in options):
517  //
518  // option (Aaa.options) = {
519  // [type.type/type] {
520  // key: value
521  // }
522  // }
523  //
524  // or repeated fields (in options):
525  //
526  // option (Aaa.options) = {
527  // keys: [ 1, 2, 3 ]
528  // }
529  //
530  // In the first and the third case we want to spread the contents inside
531  // the square braces; in the second we want to keep them inline.
532  Left->Type = TT_ArrayInitializerLSquare;
533  if (!Left->endsSequence(tok::l_square, tok::numeric_constant,
534  tok::equal) &&
535  !Left->endsSequence(tok::l_square, tok::numeric_constant,
536  tok::identifier) &&
537  !Left->endsSequence(tok::l_square, tok::colon, TT_SelectorName)) {
538  Left->Type = TT_ProtoExtensionLSquare;
539  BindingIncrease = 10;
540  }
541  } else if (!CppArrayTemplates && Parent &&
542  Parent->isOneOf(TT_BinaryOperator, TT_TemplateCloser, tok::at,
543  tok::comma, tok::l_paren, tok::l_square,
544  tok::question, tok::colon, tok::kw_return,
545  // Should only be relevant to JavaScript:
546  tok::kw_default)) {
547  Left->Type = TT_ArrayInitializerLSquare;
548  } else {
549  BindingIncrease = 10;
550  Left->Type = TT_ArraySubscriptLSquare;
551  }
552  }
553 
554  ScopedContextCreator ContextCreator(*this, tok::l_square, BindingIncrease);
555  Contexts.back().IsExpression = true;
556  if (Style.Language == FormatStyle::LK_JavaScript && Parent &&
557  Parent->is(TT_JsTypeColon))
558  Contexts.back().IsExpression = false;
559 
560  Contexts.back().ColonIsObjCMethodExpr = StartsObjCMethodExpr;
561  Contexts.back().InCpp11AttributeSpecifier = IsCpp11AttributeSpecifier;
562  Contexts.back().InCSharpAttributeSpecifier = IsCSharp11AttributeSpecifier;
563 
564  while (CurrentToken) {
565  if (CurrentToken->is(tok::r_square)) {
566  if (IsCpp11AttributeSpecifier)
567  CurrentToken->Type = TT_AttributeSquare;
568  if (IsCSharp11AttributeSpecifier)
569  CurrentToken->Type = TT_AttributeSquare;
570  else if (((CurrentToken->Next &&
571  CurrentToken->Next->is(tok::l_paren)) ||
572  (CurrentToken->Previous &&
573  CurrentToken->Previous->Previous == Left)) &&
574  Left->is(TT_ObjCMethodExpr)) {
575  // An ObjC method call is rarely followed by an open parenthesis. It
576  // also can't be composed of just one token, unless it's a macro that
577  // will be expanded to more tokens.
578  // FIXME: Do we incorrectly label ":" with this?
579  StartsObjCMethodExpr = false;
580  Left->Type = TT_Unknown;
581  }
582  if (StartsObjCMethodExpr && CurrentToken->Previous != Left) {
583  CurrentToken->Type = TT_ObjCMethodExpr;
584  // If we haven't seen a colon yet, make sure the last identifier
585  // before the r_square is tagged as a selector name component.
586  if (!ColonFound && CurrentToken->Previous &&
587  CurrentToken->Previous->is(TT_Unknown) &&
588  canBeObjCSelectorComponent(*CurrentToken->Previous))
589  CurrentToken->Previous->Type = TT_SelectorName;
590  // determineStarAmpUsage() thinks that '*' '[' is allocating an
591  // array of pointers, but if '[' starts a selector then '*' is a
592  // binary operator.
593  if (Parent && Parent->is(TT_PointerOrReference))
594  Parent->Type = TT_BinaryOperator;
595  }
596  // An arrow after an ObjC method expression is not a lambda arrow.
597  if (CurrentToken->Type == TT_ObjCMethodExpr && CurrentToken->Next &&
598  CurrentToken->Next->is(TT_LambdaArrow))
599  CurrentToken->Next->Type = TT_Unknown;
600  Left->MatchingParen = CurrentToken;
601  CurrentToken->MatchingParen = Left;
602  // FirstObjCSelectorName is set when a colon is found. This does
603  // not work, however, when the method has no parameters.
604  // Here, we set FirstObjCSelectorName when the end of the method call is
605  // reached, in case it was not set already.
606  if (!Contexts.back().FirstObjCSelectorName) {
607  FormatToken *Previous = CurrentToken->getPreviousNonComment();
608  if (Previous && Previous->is(TT_SelectorName)) {
609  Previous->ObjCSelectorNameParts = 1;
610  Contexts.back().FirstObjCSelectorName = Previous;
611  }
612  } else {
613  Left->ParameterCount =
614  Contexts.back().FirstObjCSelectorName->ObjCSelectorNameParts;
615  }
616  if (Contexts.back().FirstObjCSelectorName) {
617  Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
618  Contexts.back().LongestObjCSelectorName;
619  if (Left->BlockParameterCount > 1)
620  Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName = 0;
621  }
622  next();
623  return true;
624  }
625  if (CurrentToken->isOneOf(tok::r_paren, tok::r_brace))
626  return false;
627  if (CurrentToken->is(tok::colon)) {
628  if (IsCpp11AttributeSpecifier &&
629  CurrentToken->endsSequence(tok::colon, tok::identifier,
630  tok::kw_using)) {
631  // Remember that this is a [[using ns: foo]] C++ attribute, so we
632  // don't add a space before the colon (unlike other colons).
633  CurrentToken->Type = TT_AttributeColon;
634  } else if (Left->isOneOf(TT_ArraySubscriptLSquare,
635  TT_DesignatedInitializerLSquare)) {
636  Left->Type = TT_ObjCMethodExpr;
637  StartsObjCMethodExpr = true;
638  Contexts.back().ColonIsObjCMethodExpr = true;
639  if (Parent && Parent->is(tok::r_paren))
640  // FIXME(bug 36976): ObjC return types shouldn't use TT_CastRParen.
641  Parent->Type = TT_CastRParen;
642  }
643  ColonFound = true;
644  }
645  if (CurrentToken->is(tok::comma) && Left->is(TT_ObjCMethodExpr) &&
646  !ColonFound)
647  Left->Type = TT_ArrayInitializerLSquare;
648  FormatToken *Tok = CurrentToken;
649  if (!consumeToken())
650  return false;
651  updateParameterCount(Left, Tok);
652  }
653  return false;
654  }
655 
656  bool parseBrace() {
657  if (CurrentToken) {
658  FormatToken *Left = CurrentToken->Previous;
659  Left->ParentBracket = Contexts.back().ContextKind;
660 
661  if (Contexts.back().CaretFound)
662  Left->Type = TT_ObjCBlockLBrace;
663  Contexts.back().CaretFound = false;
664 
665  ScopedContextCreator ContextCreator(*this, tok::l_brace, 1);
666  Contexts.back().ColonIsDictLiteral = true;
667  if (Left->BlockKind == BK_BracedInit)
668  Contexts.back().IsExpression = true;
669  if (Style.Language == FormatStyle::LK_JavaScript && Left->Previous &&
670  Left->Previous->is(TT_JsTypeColon))
671  Contexts.back().IsExpression = false;
672 
673  while (CurrentToken) {
674  if (CurrentToken->is(tok::r_brace)) {
675  Left->MatchingParen = CurrentToken;
676  CurrentToken->MatchingParen = Left;
677  next();
678  return true;
679  }
680  if (CurrentToken->isOneOf(tok::r_paren, tok::r_square))
681  return false;
682  updateParameterCount(Left, CurrentToken);
683  if (CurrentToken->isOneOf(tok::colon, tok::l_brace, tok::less)) {
684  FormatToken *Previous = CurrentToken->getPreviousNonComment();
685  if (Previous->is(TT_JsTypeOptionalQuestion))
686  Previous = Previous->getPreviousNonComment();
687  if ((CurrentToken->is(tok::colon) &&
688  (!Contexts.back().ColonIsDictLiteral || !Style.isCpp())) ||
689  Style.Language == FormatStyle::LK_Proto ||
690  Style.Language == FormatStyle::LK_TextProto) {
691  Left->Type = TT_DictLiteral;
692  if (Previous->Tok.getIdentifierInfo() ||
693  Previous->is(tok::string_literal))
694  Previous->Type = TT_SelectorName;
695  }
696  if (CurrentToken->is(tok::colon) ||
697  Style.Language == FormatStyle::LK_JavaScript)
698  Left->Type = TT_DictLiteral;
699  }
700  if (CurrentToken->is(tok::comma) &&
701  Style.Language == FormatStyle::LK_JavaScript)
702  Left->Type = TT_DictLiteral;
703  if (!consumeToken())
704  return false;
705  }
706  }
707  return true;
708  }
709 
710  void updateParameterCount(FormatToken *Left, FormatToken *Current) {
711  // For ObjC methods, the number of parameters is calculated differently as
712  // method declarations have a different structure (the parameters are not
713  // inside a bracket scope).
714  if (Current->is(tok::l_brace) && Current->BlockKind == BK_Block)
715  ++Left->BlockParameterCount;
716  if (Current->is(tok::comma)) {
717  ++Left->ParameterCount;
718  if (!Left->Role)
719  Left->Role.reset(new CommaSeparatedList(Style));
720  Left->Role->CommaFound(Current);
721  } else if (Left->ParameterCount == 0 && Current->isNot(tok::comment)) {
722  Left->ParameterCount = 1;
723  }
724  }
725 
726  bool parseConditional() {
727  while (CurrentToken) {
728  if (CurrentToken->is(tok::colon)) {
729  CurrentToken->Type = TT_ConditionalExpr;
730  next();
731  return true;
732  }
733  if (!consumeToken())
734  return false;
735  }
736  return false;
737  }
738 
739  bool parseTemplateDeclaration() {
740  if (CurrentToken && CurrentToken->is(tok::less)) {
741  CurrentToken->Type = TT_TemplateOpener;
742  next();
743  if (!parseAngle())
744  return false;
745  if (CurrentToken)
746  CurrentToken->Previous->ClosesTemplateDeclaration = true;
747  return true;
748  }
749  return false;
750  }
751 
752  bool consumeToken() {
753  FormatToken *Tok = CurrentToken;
754  next();
755  switch (Tok->Tok.getKind()) {
756  case tok::plus:
757  case tok::minus:
758  if (!Tok->Previous && Line.MustBeDeclaration)
759  Tok->Type = TT_ObjCMethodSpecifier;
760  break;
761  case tok::colon:
762  if (!Tok->Previous)
763  return false;
764  // Colons from ?: are handled in parseConditional().
765  if (Style.Language == FormatStyle::LK_JavaScript) {
766  if (Contexts.back().ColonIsForRangeExpr || // colon in for loop
767  (Contexts.size() == 1 && // switch/case labels
768  !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) ||
769  Contexts.back().ContextKind == tok::l_paren || // function params
770  Contexts.back().ContextKind == tok::l_square || // array type
771  (!Contexts.back().IsExpression &&
772  Contexts.back().ContextKind == tok::l_brace) || // object type
773  (Contexts.size() == 1 &&
774  Line.MustBeDeclaration)) { // method/property declaration
775  Contexts.back().IsExpression = false;
776  Tok->Type = TT_JsTypeColon;
777  break;
778  }
779  }
780  if (Contexts.back().ColonIsDictLiteral ||
781  Style.Language == FormatStyle::LK_Proto ||
782  Style.Language == FormatStyle::LK_TextProto) {
783  Tok->Type = TT_DictLiteral;
784  if (Style.Language == FormatStyle::LK_TextProto) {
785  if (FormatToken *Previous = Tok->getPreviousNonComment())
786  Previous->Type = TT_SelectorName;
787  }
788  } else if (Contexts.back().ColonIsObjCMethodExpr ||
789  Line.startsWith(TT_ObjCMethodSpecifier)) {
790  Tok->Type = TT_ObjCMethodExpr;
791  const FormatToken *BeforePrevious = Tok->Previous->Previous;
792  // Ensure we tag all identifiers in method declarations as
793  // TT_SelectorName.
794  bool UnknownIdentifierInMethodDeclaration =
795  Line.startsWith(TT_ObjCMethodSpecifier) &&
796  Tok->Previous->is(tok::identifier) && Tok->Previous->is(TT_Unknown);
797  if (!BeforePrevious ||
798  // FIXME(bug 36976): ObjC return types shouldn't use TT_CastRParen.
799  !(BeforePrevious->is(TT_CastRParen) ||
800  (BeforePrevious->is(TT_ObjCMethodExpr) &&
801  BeforePrevious->is(tok::colon))) ||
802  BeforePrevious->is(tok::r_square) ||
803  Contexts.back().LongestObjCSelectorName == 0 ||
804  UnknownIdentifierInMethodDeclaration) {
805  Tok->Previous->Type = TT_SelectorName;
806  if (!Contexts.back().FirstObjCSelectorName)
807  Contexts.back().FirstObjCSelectorName = Tok->Previous;
808  else if (Tok->Previous->ColumnWidth >
809  Contexts.back().LongestObjCSelectorName)
810  Contexts.back().LongestObjCSelectorName =
811  Tok->Previous->ColumnWidth;
812  Tok->Previous->ParameterIndex =
813  Contexts.back().FirstObjCSelectorName->ObjCSelectorNameParts;
814  ++Contexts.back().FirstObjCSelectorName->ObjCSelectorNameParts;
815  }
816  } else if (Contexts.back().ColonIsForRangeExpr) {
817  Tok->Type = TT_RangeBasedForLoopColon;
818  } else if (CurrentToken && CurrentToken->is(tok::numeric_constant)) {
819  Tok->Type = TT_BitFieldColon;
820  } else if (Contexts.size() == 1 &&
821  !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) {
822  if (Tok->getPreviousNonComment()->isOneOf(tok::r_paren,
823  tok::kw_noexcept))
824  Tok->Type = TT_CtorInitializerColon;
825  else
826  Tok->Type = TT_InheritanceColon;
827  } else if (canBeObjCSelectorComponent(*Tok->Previous) && Tok->Next &&
828  (Tok->Next->isOneOf(tok::r_paren, tok::comma) ||
829  (canBeObjCSelectorComponent(*Tok->Next) && Tok->Next->Next &&
830  Tok->Next->Next->is(tok::colon)))) {
831  // This handles a special macro in ObjC code where selectors including
832  // the colon are passed as macro arguments.
833  Tok->Type = TT_ObjCMethodExpr;
834  } else if (Contexts.back().ContextKind == tok::l_paren) {
835  Tok->Type = TT_InlineASMColon;
836  }
837  break;
838  case tok::pipe:
839  case tok::amp:
840  // | and & in declarations/type expressions represent union and
841  // intersection types, respectively.
842  if (Style.Language == FormatStyle::LK_JavaScript &&
843  !Contexts.back().IsExpression)
844  Tok->Type = TT_JsTypeOperator;
845  break;
846  case tok::kw_if:
847  case tok::kw_while:
848  if (Tok->is(tok::kw_if) && CurrentToken &&
849  CurrentToken->isOneOf(tok::kw_constexpr, tok::identifier))
850  next();
851  if (CurrentToken && CurrentToken->is(tok::l_paren)) {
852  next();
853  if (!parseParens(/*LookForDecls=*/true))
854  return false;
855  }
856  break;
857  case tok::kw_for:
858  if (Style.Language == FormatStyle::LK_JavaScript) {
859  // x.for and {for: ...}
860  if ((Tok->Previous && Tok->Previous->is(tok::period)) ||
861  (Tok->Next && Tok->Next->is(tok::colon)))
862  break;
863  // JS' for await ( ...
864  if (CurrentToken && CurrentToken->is(Keywords.kw_await))
865  next();
866  }
867  Contexts.back().ColonIsForRangeExpr = true;
868  next();
869  if (!parseParens())
870  return false;
871  break;
872  case tok::l_paren:
873  // When faced with 'operator()()', the kw_operator handler incorrectly
874  // marks the first l_paren as a OverloadedOperatorLParen. Here, we make
875  // the first two parens OverloadedOperators and the second l_paren an
876  // OverloadedOperatorLParen.
877  if (Tok->Previous && Tok->Previous->is(tok::r_paren) &&
878  Tok->Previous->MatchingParen &&
879  Tok->Previous->MatchingParen->is(TT_OverloadedOperatorLParen)) {
880  Tok->Previous->Type = TT_OverloadedOperator;
881  Tok->Previous->MatchingParen->Type = TT_OverloadedOperator;
882  Tok->Type = TT_OverloadedOperatorLParen;
883  }
884 
885  if (!parseParens())
886  return false;
887  if (Line.MustBeDeclaration && Contexts.size() == 1 &&
888  !Contexts.back().IsExpression && !Line.startsWith(TT_ObjCProperty) &&
889  (!Tok->Previous ||
890  !Tok->Previous->isOneOf(tok::kw_decltype, tok::kw___attribute,
891  TT_LeadingJavaAnnotation)))
892  Line.MightBeFunctionDecl = true;
893  break;
894  case tok::l_square:
895  if (!parseSquare())
896  return false;
897  break;
898  case tok::l_brace:
899  if (Style.Language == FormatStyle::LK_TextProto) {
900  FormatToken *Previous = Tok->getPreviousNonComment();
901  if (Previous && Previous->Type != TT_DictLiteral)
902  Previous->Type = TT_SelectorName;
903  }
904  if (!parseBrace())
905  return false;
906  break;
907  case tok::less:
908  if (parseAngle()) {
909  Tok->Type = TT_TemplateOpener;
910  // In TT_Proto, we must distignuish between:
911  // map<key, value>
912  // msg < item: data >
913  // msg: < item: data >
914  // In TT_TextProto, map<key, value> does not occur.
915  if (Style.Language == FormatStyle::LK_TextProto ||
916  (Style.Language == FormatStyle::LK_Proto && Tok->Previous &&
917  Tok->Previous->isOneOf(TT_SelectorName, TT_DictLiteral))) {
918  Tok->Type = TT_DictLiteral;
919  FormatToken *Previous = Tok->getPreviousNonComment();
920  if (Previous && Previous->Type != TT_DictLiteral)
921  Previous->Type = TT_SelectorName;
922  }
923  } else {
924  Tok->Type = TT_BinaryOperator;
925  NonTemplateLess.insert(Tok);
926  CurrentToken = Tok;
927  next();
928  }
929  break;
930  case tok::r_paren:
931  case tok::r_square:
932  return false;
933  case tok::r_brace:
934  // Lines can start with '}'.
935  if (Tok->Previous)
936  return false;
937  break;
938  case tok::greater:
939  if (Style.Language != FormatStyle::LK_TextProto)
940  Tok->Type = TT_BinaryOperator;
941  if (Tok->Previous && Tok->Previous->is(TT_TemplateCloser))
942  Tok->SpacesRequiredBefore = 1;
943  break;
944  case tok::kw_operator:
945  if (Style.Language == FormatStyle::LK_TextProto ||
946  Style.Language == FormatStyle::LK_Proto)
947  break;
948  while (CurrentToken &&
949  !CurrentToken->isOneOf(tok::l_paren, tok::semi, tok::r_paren)) {
950  if (CurrentToken->isOneOf(tok::star, tok::amp))
951  CurrentToken->Type = TT_PointerOrReference;
952  consumeToken();
953  if (CurrentToken &&
954  CurrentToken->Previous->isOneOf(TT_BinaryOperator, TT_UnaryOperator,
955  tok::comma))
956  CurrentToken->Previous->Type = TT_OverloadedOperator;
957  }
958  if (CurrentToken) {
959  CurrentToken->Type = TT_OverloadedOperatorLParen;
960  if (CurrentToken->Previous->is(TT_BinaryOperator))
961  CurrentToken->Previous->Type = TT_OverloadedOperator;
962  }
963  break;
964  case tok::question:
965  if (Style.Language == FormatStyle::LK_JavaScript && Tok->Next &&
966  Tok->Next->isOneOf(tok::semi, tok::comma, tok::colon, tok::r_paren,
967  tok::r_brace)) {
968  // Question marks before semicolons, colons, etc. indicate optional
969  // types (fields, parameters), e.g.
970  // function(x?: string, y?) {...}
971  // class X { y?; }
972  Tok->Type = TT_JsTypeOptionalQuestion;
973  break;
974  }
975  // Declarations cannot be conditional expressions, this can only be part
976  // of a type declaration.
977  if (Line.MustBeDeclaration && !Contexts.back().IsExpression &&
978  Style.Language == FormatStyle::LK_JavaScript)
979  break;
980  parseConditional();
981  break;
982  case tok::kw_template:
983  parseTemplateDeclaration();
984  break;
985  case tok::comma:
986  if (Contexts.back().InCtorInitializer)
987  Tok->Type = TT_CtorInitializerComma;
988  else if (Contexts.back().InInheritanceList)
989  Tok->Type = TT_InheritanceComma;
990  else if (Contexts.back().FirstStartOfName &&
991  (Contexts.size() == 1 || Line.startsWith(tok::kw_for))) {
992  Contexts.back().FirstStartOfName->PartOfMultiVariableDeclStmt = true;
993  Line.IsMultiVariableDeclStmt = true;
994  }
995  if (Contexts.back().IsForEachMacro)
996  Contexts.back().IsExpression = true;
997  break;
998  case tok::identifier:
999  if (Tok->isOneOf(Keywords.kw___has_include,
1000  Keywords.kw___has_include_next)) {
1001  parseHasInclude();
1002  }
1003  break;
1004  default:
1005  break;
1006  }
1007  return true;
1008  }
1009 
1010  void parseIncludeDirective() {
1011  if (CurrentToken && CurrentToken->is(tok::less)) {
1012  next();
1013  while (CurrentToken) {
1014  // Mark tokens up to the trailing line comments as implicit string
1015  // literals.
1016  if (CurrentToken->isNot(tok::comment) &&
1017  !CurrentToken->TokenText.startswith("//"))
1018  CurrentToken->Type = TT_ImplicitStringLiteral;
1019  next();
1020  }
1021  }
1022  }
1023 
1024  void parseWarningOrError() {
1025  next();
1026  // We still want to format the whitespace left of the first token of the
1027  // warning or error.
1028  next();
1029  while (CurrentToken) {
1030  CurrentToken->Type = TT_ImplicitStringLiteral;
1031  next();
1032  }
1033  }
1034 
1035  void parsePragma() {
1036  next(); // Consume "pragma".
1037  if (CurrentToken &&
1038  CurrentToken->isOneOf(Keywords.kw_mark, Keywords.kw_option)) {
1039  bool IsMark = CurrentToken->is(Keywords.kw_mark);
1040  next(); // Consume "mark".
1041  next(); // Consume first token (so we fix leading whitespace).
1042  while (CurrentToken) {
1043  if (IsMark || CurrentToken->Previous->is(TT_BinaryOperator))
1044  CurrentToken->Type = TT_ImplicitStringLiteral;
1045  next();
1046  }
1047  }
1048  }
1049 
1050  void parseHasInclude() {
1051  if (!CurrentToken || !CurrentToken->is(tok::l_paren))
1052  return;
1053  next(); // '('
1054  parseIncludeDirective();
1055  next(); // ')'
1056  }
1057 
1058  LineType parsePreprocessorDirective() {
1059  bool IsFirstToken = CurrentToken->IsFirst;
1061  next();
1062  if (!CurrentToken)
1063  return Type;
1064 
1065  if (Style.Language == FormatStyle::LK_JavaScript && IsFirstToken) {
1066  // JavaScript files can contain shebang lines of the form:
1067  // #!/usr/bin/env node
1068  // Treat these like C++ #include directives.
1069  while (CurrentToken) {
1070  // Tokens cannot be comments here.
1071  CurrentToken->Type = TT_ImplicitStringLiteral;
1072  next();
1073  }
1074  return LT_ImportStatement;
1075  }
1076 
1077  if (CurrentToken->Tok.is(tok::numeric_constant)) {
1078  CurrentToken->SpacesRequiredBefore = 1;
1079  return Type;
1080  }
1081  // Hashes in the middle of a line can lead to any strange token
1082  // sequence.
1083  if (!CurrentToken->Tok.getIdentifierInfo())
1084  return Type;
1085  switch (CurrentToken->Tok.getIdentifierInfo()->getPPKeywordID()) {
1086  case tok::pp_include:
1087  case tok::pp_include_next:
1088  case tok::pp_import:
1089  next();
1090  parseIncludeDirective();
1091  Type = LT_ImportStatement;
1092  break;
1093  case tok::pp_error:
1094  case tok::pp_warning:
1095  parseWarningOrError();
1096  break;
1097  case tok::pp_pragma:
1098  parsePragma();
1099  break;
1100  case tok::pp_if:
1101  case tok::pp_elif:
1102  Contexts.back().IsExpression = true;
1103  next();
1104  parseLine();
1105  break;
1106  default:
1107  break;
1108  }
1109  while (CurrentToken) {
1110  FormatToken *Tok = CurrentToken;
1111  next();
1112  if (Tok->is(tok::l_paren))
1113  parseParens();
1114  else if (Tok->isOneOf(Keywords.kw___has_include,
1115  Keywords.kw___has_include_next))
1116  parseHasInclude();
1117  }
1118  return Type;
1119  }
1120 
1121 public:
1122  LineType parseLine() {
1123  if (!CurrentToken)
1124  return LT_Invalid;
1125  NonTemplateLess.clear();
1126  if (CurrentToken->is(tok::hash))
1127  return parsePreprocessorDirective();
1128 
1129  // Directly allow to 'import <string-literal>' to support protocol buffer
1130  // definitions (github.com/google/protobuf) or missing "#" (either way we
1131  // should not break the line).
1132  IdentifierInfo *Info = CurrentToken->Tok.getIdentifierInfo();
1133  if ((Style.Language == FormatStyle::LK_Java &&
1134  CurrentToken->is(Keywords.kw_package)) ||
1135  (Info && Info->getPPKeywordID() == tok::pp_import &&
1136  CurrentToken->Next &&
1137  CurrentToken->Next->isOneOf(tok::string_literal, tok::identifier,
1138  tok::kw_static))) {
1139  next();
1140  parseIncludeDirective();
1141  return LT_ImportStatement;
1142  }
1143 
1144  // If this line starts and ends in '<' and '>', respectively, it is likely
1145  // part of "#define <a/b.h>".
1146  if (CurrentToken->is(tok::less) && Line.Last->is(tok::greater)) {
1147  parseIncludeDirective();
1148  return LT_ImportStatement;
1149  }
1150 
1151  // In .proto files, top-level options and package statements are very
1152  // similar to import statements and should not be line-wrapped.
1153  if (Style.Language == FormatStyle::LK_Proto && Line.Level == 0 &&
1154  CurrentToken->isOneOf(Keywords.kw_option, Keywords.kw_package)) {
1155  next();
1156  if (CurrentToken && CurrentToken->is(tok::identifier)) {
1157  while (CurrentToken)
1158  next();
1159  return LT_ImportStatement;
1160  }
1161  }
1162 
1163  bool KeywordVirtualFound = false;
1164  bool ImportStatement = false;
1165 
1166  // import {...} from '...';
1167  if (Style.Language == FormatStyle::LK_JavaScript &&
1168  CurrentToken->is(Keywords.kw_import))
1169  ImportStatement = true;
1170 
1171  while (CurrentToken) {
1172  if (CurrentToken->is(tok::kw_virtual))
1173  KeywordVirtualFound = true;
1174  if (Style.Language == FormatStyle::LK_JavaScript) {
1175  // export {...} from '...';
1176  // An export followed by "from 'some string';" is a re-export from
1177  // another module identified by a URI and is treated as a
1178  // LT_ImportStatement (i.e. prevent wraps on it for long URIs).
1179  // Just "export {...};" or "export class ..." should not be treated as
1180  // an import in this sense.
1181  if (Line.First->is(tok::kw_export) &&
1182  CurrentToken->is(Keywords.kw_from) && CurrentToken->Next &&
1183  CurrentToken->Next->isStringLiteral())
1184  ImportStatement = true;
1185  if (isClosureImportStatement(*CurrentToken))
1186  ImportStatement = true;
1187  }
1188  if (!consumeToken())
1189  return LT_Invalid;
1190  }
1191  if (KeywordVirtualFound)
1192  return LT_VirtualFunctionDecl;
1193  if (ImportStatement)
1194  return LT_ImportStatement;
1195 
1196  if (Line.startsWith(TT_ObjCMethodSpecifier)) {
1197  if (Contexts.back().FirstObjCSelectorName)
1198  Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
1199  Contexts.back().LongestObjCSelectorName;
1200  return LT_ObjCMethodDecl;
1201  }
1202 
1203  return LT_Other;
1204  }
1205 
1206 private:
1207  bool isClosureImportStatement(const FormatToken &Tok) {
1208  // FIXME: Closure-library specific stuff should not be hard-coded but be
1209  // configurable.
1210  return Tok.TokenText == "goog" && Tok.Next && Tok.Next->is(tok::period) &&
1211  Tok.Next->Next &&
1212  (Tok.Next->Next->TokenText == "module" ||
1213  Tok.Next->Next->TokenText == "provide" ||
1214  Tok.Next->Next->TokenText == "require" ||
1215  Tok.Next->Next->TokenText == "requireType" ||
1216  Tok.Next->Next->TokenText == "forwardDeclare") &&
1217  Tok.Next->Next->Next && Tok.Next->Next->Next->is(tok::l_paren);
1218  }
1219 
1220  void resetTokenMetadata(FormatToken *Token) {
1221  if (!Token)
1222  return;
1223 
1224  // Reset token type in case we have already looked at it and then
1225  // recovered from an error (e.g. failure to find the matching >).
1226  if (!CurrentToken->isOneOf(
1227  TT_LambdaLSquare, TT_LambdaLBrace, TT_ForEachMacro,
1228  TT_TypenameMacro, TT_FunctionLBrace, TT_ImplicitStringLiteral,
1229  TT_InlineASMBrace, TT_JsFatArrow, TT_LambdaArrow, TT_NamespaceMacro,
1230  TT_OverloadedOperator, TT_RegexLiteral, TT_TemplateString,
1231  TT_ObjCStringLiteral))
1232  CurrentToken->Type = TT_Unknown;
1233  CurrentToken->Role.reset();
1234  CurrentToken->MatchingParen = nullptr;
1235  CurrentToken->FakeLParens.clear();
1236  CurrentToken->FakeRParens = 0;
1237  }
1238 
1239  void next() {
1240  if (CurrentToken) {
1241  CurrentToken->NestingLevel = Contexts.size() - 1;
1242  CurrentToken->BindingStrength = Contexts.back().BindingStrength;
1243  modifyContext(*CurrentToken);
1244  determineTokenType(*CurrentToken);
1245  CurrentToken = CurrentToken->Next;
1246  }
1247 
1248  resetTokenMetadata(CurrentToken);
1249  }
1250 
1251  /// A struct to hold information valid in a specific context, e.g.
1252  /// a pair of parenthesis.
1253  struct Context {
1254  Context(tok::TokenKind ContextKind, unsigned BindingStrength,
1255  bool IsExpression)
1256  : ContextKind(ContextKind), BindingStrength(BindingStrength),
1257  IsExpression(IsExpression) {}
1258 
1263  bool ColonIsForRangeExpr = false;
1264  bool ColonIsDictLiteral = false;
1266  FormatToken *FirstObjCSelectorName = nullptr;
1267  FormatToken *FirstStartOfName = nullptr;
1268  bool CanBeExpression = true;
1269  bool InTemplateArgument = false;
1270  bool InCtorInitializer = false;
1271  bool InInheritanceList = false;
1272  bool CaretFound = false;
1273  bool IsForEachMacro = false;
1276  };
1277 
1278  /// Puts a new \c Context onto the stack \c Contexts for the lifetime
1279  /// of each instance.
1280  struct ScopedContextCreator {
1281  AnnotatingParser &P;
1282 
1283  ScopedContextCreator(AnnotatingParser &P, tok::TokenKind ContextKind,
1284  unsigned Increase)
1285  : P(P) {
1286  P.Contexts.push_back(Context(ContextKind,
1287  P.Contexts.back().BindingStrength + Increase,
1288  P.Contexts.back().IsExpression));
1289  }
1290 
1291  ~ScopedContextCreator() { P.Contexts.pop_back(); }
1292  };
1293 
1294  void modifyContext(const FormatToken &Current) {
1295  if (Current.getPrecedence() == prec::Assignment &&
1296  !Line.First->isOneOf(tok::kw_template, tok::kw_using, tok::kw_return) &&
1297  // Type aliases use `type X = ...;` in TypeScript and can be exported
1298  // using `export type ...`.
1299  !(Style.Language == FormatStyle::LK_JavaScript &&
1300  (Line.startsWith(Keywords.kw_type, tok::identifier) ||
1301  Line.startsWith(tok::kw_export, Keywords.kw_type,
1302  tok::identifier))) &&
1303  (!Current.Previous || Current.Previous->isNot(tok::kw_operator))) {
1304  Contexts.back().IsExpression = true;
1305  if (!Line.startsWith(TT_UnaryOperator)) {
1306  for (FormatToken *Previous = Current.Previous;
1307  Previous && Previous->Previous &&
1308  !Previous->Previous->isOneOf(tok::comma, tok::semi);
1309  Previous = Previous->Previous) {
1310  if (Previous->isOneOf(tok::r_square, tok::r_paren)) {
1311  Previous = Previous->MatchingParen;
1312  if (!Previous)
1313  break;
1314  }
1315  if (Previous->opensScope())
1316  break;
1317  if (Previous->isOneOf(TT_BinaryOperator, TT_UnaryOperator) &&
1318  Previous->isOneOf(tok::star, tok::amp, tok::ampamp) &&
1319  Previous->Previous && Previous->Previous->isNot(tok::equal))
1320  Previous->Type = TT_PointerOrReference;
1321  }
1322  }
1323  } else if (Current.is(tok::lessless) &&
1324  (!Current.Previous || !Current.Previous->is(tok::kw_operator))) {
1325  Contexts.back().IsExpression = true;
1326  } else if (Current.isOneOf(tok::kw_return, tok::kw_throw)) {
1327  Contexts.back().IsExpression = true;
1328  } else if (Current.is(TT_TrailingReturnArrow)) {
1329  Contexts.back().IsExpression = false;
1330  } else if (Current.is(TT_LambdaArrow) || Current.is(Keywords.kw_assert)) {
1331  Contexts.back().IsExpression = Style.Language == FormatStyle::LK_Java;
1332  } else if (Current.Previous &&
1333  Current.Previous->is(TT_CtorInitializerColon)) {
1334  Contexts.back().IsExpression = true;
1335  Contexts.back().InCtorInitializer = true;
1336  } else if (Current.Previous && Current.Previous->is(TT_InheritanceColon)) {
1337  Contexts.back().InInheritanceList = true;
1338  } else if (Current.isOneOf(tok::r_paren, tok::greater, tok::comma)) {
1339  for (FormatToken *Previous = Current.Previous;
1340  Previous && Previous->isOneOf(tok::star, tok::amp);
1341  Previous = Previous->Previous)
1342  Previous->Type = TT_PointerOrReference;
1343  if (Line.MustBeDeclaration && !Contexts.front().InCtorInitializer)
1344  Contexts.back().IsExpression = false;
1345  } else if (Current.is(tok::kw_new)) {
1346  Contexts.back().CanBeExpression = false;
1347  } else if (Current.isOneOf(tok::semi, tok::exclaim)) {
1348  // This should be the condition or increment in a for-loop.
1349  Contexts.back().IsExpression = true;
1350  }
1351  }
1352 
1353  void determineTokenType(FormatToken &Current) {
1354  if (!Current.is(TT_Unknown))
1355  // The token type is already known.
1356  return;
1357 
1358  if (Style.Language == FormatStyle::LK_JavaScript) {
1359  if (Current.is(tok::exclaim)) {
1360  if (Current.Previous &&
1361  (Current.Previous->isOneOf(tok::identifier, tok::kw_namespace,
1362  tok::r_paren, tok::r_square,
1363  tok::r_brace) ||
1364  Current.Previous->Tok.isLiteral())) {
1365  Current.Type = TT_JsNonNullAssertion;
1366  return;
1367  }
1368  if (Current.Next &&
1369  Current.Next->isOneOf(TT_BinaryOperator, Keywords.kw_as)) {
1370  Current.Type = TT_JsNonNullAssertion;
1371  return;
1372  }
1373  }
1374  }
1375 
1376  // Line.MightBeFunctionDecl can only be true after the parentheses of a
1377  // function declaration have been found. In this case, 'Current' is a
1378  // trailing token of this declaration and thus cannot be a name.
1379  if (Current.is(Keywords.kw_instanceof)) {
1380  Current.Type = TT_BinaryOperator;
1381  } else if (isStartOfName(Current) &&
1382  (!Line.MightBeFunctionDecl || Current.NestingLevel != 0)) {
1383  Contexts.back().FirstStartOfName = &Current;
1384  Current.Type = TT_StartOfName;
1385  } else if (Current.is(tok::semi)) {
1386  // Reset FirstStartOfName after finding a semicolon so that a for loop
1387  // with multiple increment statements is not confused with a for loop
1388  // having multiple variable declarations.
1389  Contexts.back().FirstStartOfName = nullptr;
1390  } else if (Current.isOneOf(tok::kw_auto, tok::kw___auto_type)) {
1391  AutoFound = true;
1392  } else if (Current.is(tok::arrow) &&
1393  Style.Language == FormatStyle::LK_Java) {
1394  Current.Type = TT_LambdaArrow;
1395  } else if (Current.is(tok::arrow) && AutoFound && Line.MustBeDeclaration &&
1396  Current.NestingLevel == 0 &&
1397  !Current.Previous->is(tok::kw_operator)) {
1398  // not auto operator->() -> xxx;
1399  Current.Type = TT_TrailingReturnArrow;
1400  } else if (Current.isOneOf(tok::star, tok::amp, tok::ampamp)) {
1401  Current.Type = determineStarAmpUsage(Current,
1402  Contexts.back().CanBeExpression &&
1403  Contexts.back().IsExpression,
1404  Contexts.back().InTemplateArgument);
1405  } else if (Current.isOneOf(tok::minus, tok::plus, tok::caret)) {
1406  Current.Type = determinePlusMinusCaretUsage(Current);
1407  if (Current.is(TT_UnaryOperator) && Current.is(tok::caret))
1408  Contexts.back().CaretFound = true;
1409  } else if (Current.isOneOf(tok::minusminus, tok::plusplus)) {
1410  Current.Type = determineIncrementUsage(Current);
1411  } else if (Current.isOneOf(tok::exclaim, tok::tilde)) {
1412  Current.Type = TT_UnaryOperator;
1413  } else if (Current.is(tok::question)) {
1414  if (Style.Language == FormatStyle::LK_JavaScript &&
1415  Line.MustBeDeclaration && !Contexts.back().IsExpression) {
1416  // In JavaScript, `interface X { foo?(): bar; }` is an optional method
1417  // on the interface, not a ternary expression.
1418  Current.Type = TT_JsTypeOptionalQuestion;
1419  } else {
1420  Current.Type = TT_ConditionalExpr;
1421  }
1422  } else if (Current.isBinaryOperator() &&
1423  (!Current.Previous || Current.Previous->isNot(tok::l_square)) &&
1424  (!Current.is(tok::greater) &&
1425  Style.Language != FormatStyle::LK_TextProto)) {
1426  Current.Type = TT_BinaryOperator;
1427  } else if (Current.is(tok::comment)) {
1428  if (Current.TokenText.startswith("/*")) {
1429  if (Current.TokenText.endswith("*/"))
1430  Current.Type = TT_BlockComment;
1431  else
1432  // The lexer has for some reason determined a comment here. But we
1433  // cannot really handle it, if it isn't properly terminated.
1434  Current.Tok.setKind(tok::unknown);
1435  } else {
1436  Current.Type = TT_LineComment;
1437  }
1438  } else if (Current.is(tok::r_paren)) {
1439  if (rParenEndsCast(Current))
1440  Current.Type = TT_CastRParen;
1441  if (Current.MatchingParen && Current.Next &&
1442  !Current.Next->isBinaryOperator() &&
1443  !Current.Next->isOneOf(tok::semi, tok::colon, tok::l_brace,
1444  tok::comma, tok::period, tok::arrow,
1445  tok::coloncolon))
1446  if (FormatToken *AfterParen = Current.MatchingParen->Next) {
1447  // Make sure this isn't the return type of an Obj-C block declaration
1448  if (AfterParen->Tok.isNot(tok::caret)) {
1449  if (FormatToken *BeforeParen = Current.MatchingParen->Previous)
1450  if (BeforeParen->is(tok::identifier) &&
1451  !BeforeParen->is(TT_TypenameMacro) &&
1452  BeforeParen->TokenText == BeforeParen->TokenText.upper() &&
1453  (!BeforeParen->Previous ||
1454  BeforeParen->Previous->ClosesTemplateDeclaration))
1455  Current.Type = TT_FunctionAnnotationRParen;
1456  }
1457  }
1458  } else if (Current.is(tok::at) && Current.Next &&
1459  Style.Language != FormatStyle::LK_JavaScript &&
1460  Style.Language != FormatStyle::LK_Java) {
1461  // In Java & JavaScript, "@..." is a decorator or annotation. In ObjC, it
1462  // marks declarations and properties that need special formatting.
1463  switch (Current.Next->Tok.getObjCKeywordID()) {
1464  case tok::objc_interface:
1465  case tok::objc_implementation:
1466  case tok::objc_protocol:
1467  Current.Type = TT_ObjCDecl;
1468  break;
1469  case tok::objc_property:
1470  Current.Type = TT_ObjCProperty;
1471  break;
1472  default:
1473  break;
1474  }
1475  } else if (Current.is(tok::period)) {
1476  FormatToken *PreviousNoComment = Current.getPreviousNonComment();
1477  if (PreviousNoComment &&
1478  PreviousNoComment->isOneOf(tok::comma, tok::l_brace))
1479  Current.Type = TT_DesignatedInitializerPeriod;
1480  else if (Style.Language == FormatStyle::LK_Java && Current.Previous &&
1481  Current.Previous->isOneOf(TT_JavaAnnotation,
1482  TT_LeadingJavaAnnotation)) {
1483  Current.Type = Current.Previous->Type;
1484  }
1485  } else if (canBeObjCSelectorComponent(Current) &&
1486  // FIXME(bug 36976): ObjC return types shouldn't use
1487  // TT_CastRParen.
1488  Current.Previous && Current.Previous->is(TT_CastRParen) &&
1489  Current.Previous->MatchingParen &&
1490  Current.Previous->MatchingParen->Previous &&
1491  Current.Previous->MatchingParen->Previous->is(
1492  TT_ObjCMethodSpecifier)) {
1493  // This is the first part of an Objective-C selector name. (If there's no
1494  // colon after this, this is the only place which annotates the identifier
1495  // as a selector.)
1496  Current.Type = TT_SelectorName;
1497  } else if (Current.isOneOf(tok::identifier, tok::kw_const,
1498  tok::kw_noexcept) &&
1499  Current.Previous &&
1500  !Current.Previous->isOneOf(tok::equal, tok::at) &&
1501  Line.MightBeFunctionDecl && Contexts.size() == 1) {
1502  // Line.MightBeFunctionDecl can only be true after the parentheses of a
1503  // function declaration have been found.
1504  Current.Type = TT_TrailingAnnotation;
1505  } else if ((Style.Language == FormatStyle::LK_Java ||
1506  Style.Language == FormatStyle::LK_JavaScript) &&
1507  Current.Previous) {
1508  if (Current.Previous->is(tok::at) &&
1509  Current.isNot(Keywords.kw_interface)) {
1510  const FormatToken &AtToken = *Current.Previous;
1511  const FormatToken *Previous = AtToken.getPreviousNonComment();
1512  if (!Previous || Previous->is(TT_LeadingJavaAnnotation))
1513  Current.Type = TT_LeadingJavaAnnotation;
1514  else
1515  Current.Type = TT_JavaAnnotation;
1516  } else if (Current.Previous->is(tok::period) &&
1517  Current.Previous->isOneOf(TT_JavaAnnotation,
1518  TT_LeadingJavaAnnotation)) {
1519  Current.Type = Current.Previous->Type;
1520  }
1521  }
1522  }
1523 
1524  /// Take a guess at whether \p Tok starts a name of a function or
1525  /// variable declaration.
1526  ///
1527  /// This is a heuristic based on whether \p Tok is an identifier following
1528  /// something that is likely a type.
1529  bool isStartOfName(const FormatToken &Tok) {
1530  if (Tok.isNot(tok::identifier) || !Tok.Previous)
1531  return false;
1532 
1533  if (Tok.Previous->isOneOf(TT_LeadingJavaAnnotation, Keywords.kw_instanceof,
1534  Keywords.kw_as))
1535  return false;
1536  if (Style.Language == FormatStyle::LK_JavaScript &&
1537  Tok.Previous->is(Keywords.kw_in))
1538  return false;
1539 
1540  // Skip "const" as it does not have an influence on whether this is a name.
1541  FormatToken *PreviousNotConst = Tok.getPreviousNonComment();
1542  while (PreviousNotConst && PreviousNotConst->is(tok::kw_const))
1543  PreviousNotConst = PreviousNotConst->getPreviousNonComment();
1544 
1545  if (!PreviousNotConst)
1546  return false;
1547 
1548  bool IsPPKeyword = PreviousNotConst->is(tok::identifier) &&
1549  PreviousNotConst->Previous &&
1550  PreviousNotConst->Previous->is(tok::hash);
1551 
1552  if (PreviousNotConst->is(TT_TemplateCloser))
1553  return PreviousNotConst && PreviousNotConst->MatchingParen &&
1554  PreviousNotConst->MatchingParen->Previous &&
1555  PreviousNotConst->MatchingParen->Previous->isNot(tok::period) &&
1556  PreviousNotConst->MatchingParen->Previous->isNot(tok::kw_template);
1557 
1558  if (PreviousNotConst->is(tok::r_paren) && PreviousNotConst->MatchingParen &&
1559  PreviousNotConst->MatchingParen->Previous &&
1560  PreviousNotConst->MatchingParen->Previous->is(tok::kw_decltype))
1561  return true;
1562 
1563  return (!IsPPKeyword &&
1564  PreviousNotConst->isOneOf(tok::identifier, tok::kw_auto)) ||
1565  PreviousNotConst->is(TT_PointerOrReference) ||
1566  PreviousNotConst->isSimpleTypeSpecifier();
1567  }
1568 
1569  /// Determine whether ')' is ending a cast.
1570  bool rParenEndsCast(const FormatToken &Tok) {
1571  // C-style casts are only used in C++ and Java.
1572  if (!Style.isCpp() && Style.Language != FormatStyle::LK_Java)
1573  return false;
1574 
1575  // Empty parens aren't casts and there are no casts at the end of the line.
1576  if (Tok.Previous == Tok.MatchingParen || !Tok.Next || !Tok.MatchingParen)
1577  return false;
1578 
1579  FormatToken *LeftOfParens = Tok.MatchingParen->getPreviousNonComment();
1580  if (LeftOfParens) {
1581  // If there is a closing parenthesis left of the current parentheses,
1582  // look past it as these might be chained casts.
1583  if (LeftOfParens->is(tok::r_paren)) {
1584  if (!LeftOfParens->MatchingParen ||
1585  !LeftOfParens->MatchingParen->Previous)
1586  return false;
1587  LeftOfParens = LeftOfParens->MatchingParen->Previous;
1588  }
1589 
1590  // If there is an identifier (or with a few exceptions a keyword) right
1591  // before the parentheses, this is unlikely to be a cast.
1592  if (LeftOfParens->Tok.getIdentifierInfo() &&
1593  !LeftOfParens->isOneOf(Keywords.kw_in, tok::kw_return, tok::kw_case,
1594  tok::kw_delete))
1595  return false;
1596 
1597  // Certain other tokens right before the parentheses are also signals that
1598  // this cannot be a cast.
1599  if (LeftOfParens->isOneOf(tok::at, tok::r_square, TT_OverloadedOperator,
1600  TT_TemplateCloser, tok::ellipsis))
1601  return false;
1602  }
1603 
1604  if (Tok.Next->is(tok::question))
1605  return false;
1606 
1607  // Functions which end with decorations like volatile, noexcept are unlikely
1608  // to be casts.
1609  if (Tok.Next->isOneOf(tok::kw_noexcept, tok::kw_volatile, tok::kw_const,
1610  tok::kw_throw, tok::l_square, tok::arrow,
1611  Keywords.kw_override, Keywords.kw_final))
1612  return false;
1613 
1614  // As Java has no function types, a "(" after the ")" likely means that this
1615  // is a cast.
1616  if (Style.Language == FormatStyle::LK_Java && Tok.Next->is(tok::l_paren))
1617  return true;
1618 
1619  // If a (non-string) literal follows, this is likely a cast.
1620  if (Tok.Next->isNot(tok::string_literal) &&
1621  (Tok.Next->Tok.isLiteral() ||
1622  Tok.Next->isOneOf(tok::kw_sizeof, tok::kw_alignof)))
1623  return true;
1624 
1625  // Heuristically try to determine whether the parentheses contain a type.
1626  bool ParensAreType =
1627  !Tok.Previous ||
1628  Tok.Previous->isOneOf(TT_PointerOrReference, TT_TemplateCloser) ||
1629  Tok.Previous->isSimpleTypeSpecifier();
1630  bool ParensCouldEndDecl =
1631  Tok.Next->isOneOf(tok::equal, tok::semi, tok::l_brace, tok::greater);
1632  if (ParensAreType && !ParensCouldEndDecl)
1633  return true;
1634 
1635  // At this point, we heuristically assume that there are no casts at the
1636  // start of the line. We assume that we have found most cases where there
1637  // are by the logic above, e.g. "(void)x;".
1638  if (!LeftOfParens)
1639  return false;
1640 
1641  // Certain token types inside the parentheses mean that this can't be a
1642  // cast.
1643  for (const FormatToken *Token = Tok.MatchingParen->Next; Token != &Tok;
1644  Token = Token->Next)
1645  if (Token->is(TT_BinaryOperator))
1646  return false;
1647 
1648  // If the following token is an identifier or 'this', this is a cast. All
1649  // cases where this can be something else are handled above.
1650  if (Tok.Next->isOneOf(tok::identifier, tok::kw_this))
1651  return true;
1652 
1653  if (!Tok.Next->Next)
1654  return false;
1655 
1656  // If the next token after the parenthesis is a unary operator, assume
1657  // that this is cast, unless there are unexpected tokens inside the
1658  // parenthesis.
1659  bool NextIsUnary =
1660  Tok.Next->isUnaryOperator() || Tok.Next->isOneOf(tok::amp, tok::star);
1661  if (!NextIsUnary || Tok.Next->is(tok::plus) ||
1662  !Tok.Next->Next->isOneOf(tok::identifier, tok::numeric_constant))
1663  return false;
1664  // Search for unexpected tokens.
1665  for (FormatToken *Prev = Tok.Previous; Prev != Tok.MatchingParen;
1666  Prev = Prev->Previous) {
1667  if (!Prev->isOneOf(tok::kw_const, tok::identifier, tok::coloncolon))
1668  return false;
1669  }
1670  return true;
1671  }
1672 
1673  /// Return the type of the given token assuming it is * or &.
1674  TokenType determineStarAmpUsage(const FormatToken &Tok, bool IsExpression,
1675  bool InTemplateArgument) {
1676  if (Style.Language == FormatStyle::LK_JavaScript)
1677  return TT_BinaryOperator;
1678 
1679  const FormatToken *PrevToken = Tok.getPreviousNonComment();
1680  if (!PrevToken)
1681  return TT_UnaryOperator;
1682 
1683  const FormatToken *NextToken = Tok.getNextNonComment();
1684  if (!NextToken ||
1685  NextToken->isOneOf(tok::arrow, tok::equal, tok::kw_const,
1686  tok::kw_noexcept) ||
1687  (NextToken->is(tok::l_brace) && !NextToken->getNextNonComment()))
1688  return TT_PointerOrReference;
1689 
1690  if (PrevToken->is(tok::coloncolon))
1691  return TT_PointerOrReference;
1692 
1693  if (PrevToken->isOneOf(tok::l_paren, tok::l_square, tok::l_brace,
1694  tok::comma, tok::semi, tok::kw_return, tok::colon,
1695  tok::equal, tok::kw_delete, tok::kw_sizeof,
1696  tok::kw_throw) ||
1697  PrevToken->isOneOf(TT_BinaryOperator, TT_ConditionalExpr,
1698  TT_UnaryOperator, TT_CastRParen))
1699  return TT_UnaryOperator;
1700 
1701  if (NextToken->is(tok::l_square) && NextToken->isNot(TT_LambdaLSquare))
1702  return TT_PointerOrReference;
1703  if (NextToken->is(tok::kw_operator) && !IsExpression)
1704  return TT_PointerOrReference;
1705  if (NextToken->isOneOf(tok::comma, tok::semi))
1706  return TT_PointerOrReference;
1707 
1708  if (PrevToken->is(tok::r_paren) && PrevToken->MatchingParen) {
1709  FormatToken *TokenBeforeMatchingParen =
1710  PrevToken->MatchingParen->getPreviousNonComment();
1711  if (TokenBeforeMatchingParen &&
1712  TokenBeforeMatchingParen->isOneOf(tok::kw_typeof, tok::kw_decltype,
1713  TT_TypenameMacro))
1714  return TT_PointerOrReference;
1715  }
1716 
1717  if (PrevToken->Tok.isLiteral() ||
1718  PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::kw_true,
1719  tok::kw_false, tok::r_brace) ||
1720  NextToken->Tok.isLiteral() ||
1721  NextToken->isOneOf(tok::kw_true, tok::kw_false) ||
1722  NextToken->isUnaryOperator() ||
1723  // If we know we're in a template argument, there are no named
1724  // declarations. Thus, having an identifier on the right-hand side
1725  // indicates a binary operator.
1726  (InTemplateArgument && NextToken->Tok.isAnyIdentifier()))
1727  return TT_BinaryOperator;
1728 
1729  // "&&(" is quite unlikely to be two successive unary "&".
1730  if (Tok.is(tok::ampamp) && NextToken && NextToken->is(tok::l_paren))
1731  return TT_BinaryOperator;
1732 
1733  // This catches some cases where evaluation order is used as control flow:
1734  // aaa && aaa->f();
1735  const FormatToken *NextNextToken = NextToken->getNextNonComment();
1736  if (NextNextToken && NextNextToken->is(tok::arrow))
1737  return TT_BinaryOperator;
1738 
1739  // It is very unlikely that we are going to find a pointer or reference type
1740  // definition on the RHS of an assignment.
1741  if (IsExpression && !Contexts.back().CaretFound)
1742  return TT_BinaryOperator;
1743 
1744  return TT_PointerOrReference;
1745  }
1746 
1747  TokenType determinePlusMinusCaretUsage(const FormatToken &Tok) {
1748  const FormatToken *PrevToken = Tok.getPreviousNonComment();
1749  if (!PrevToken)
1750  return TT_UnaryOperator;
1751 
1752  if (PrevToken->isOneOf(TT_CastRParen, TT_UnaryOperator))
1753  // This must be a sequence of leading unary operators.
1754  return TT_UnaryOperator;
1755 
1756  // Use heuristics to recognize unary operators.
1757  if (PrevToken->isOneOf(tok::equal, tok::l_paren, tok::comma, tok::l_square,
1758  tok::question, tok::colon, tok::kw_return,
1759  tok::kw_case, tok::at, tok::l_brace))
1760  return TT_UnaryOperator;
1761 
1762  // There can't be two consecutive binary operators.
1763  if (PrevToken->is(TT_BinaryOperator))
1764  return TT_UnaryOperator;
1765 
1766  // Fall back to marking the token as binary operator.
1767  return TT_BinaryOperator;
1768  }
1769 
1770  /// Determine whether ++/-- are pre- or post-increments/-decrements.
1771  TokenType determineIncrementUsage(const FormatToken &Tok) {
1772  const FormatToken *PrevToken = Tok.getPreviousNonComment();
1773  if (!PrevToken || PrevToken->is(TT_CastRParen))
1774  return TT_UnaryOperator;
1775  if (PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::identifier))
1776  return TT_TrailingUnaryOperator;
1777 
1778  return TT_UnaryOperator;
1779  }
1780 
1781  SmallVector<Context, 8> Contexts;
1782 
1783  const FormatStyle &Style;
1784  AnnotatedLine &Line;
1785  FormatToken *CurrentToken;
1786  bool AutoFound;
1787  const AdditionalKeywords &Keywords;
1788 
1789  // Set of "<" tokens that do not open a template parameter list. If parseAngle
1790  // determines that a specific token can't be a template opener, it will make
1791  // same decision irrespective of the decisions for tokens leading up to it.
1792  // Store this information to prevent this from causing exponential runtime.
1793  llvm::SmallPtrSet<FormatToken *, 16> NonTemplateLess;
1794 };
1795 
1796 static const int PrecedenceUnaryOperator = prec::PointerToMember + 1;
1797 static const int PrecedenceArrowAndPeriod = prec::PointerToMember + 2;
1798 
1799 /// Parses binary expressions by inserting fake parenthesis based on
1800 /// operator precedence.
1801 class ExpressionParser {
1802 public:
1803  ExpressionParser(const FormatStyle &Style, const AdditionalKeywords &Keywords,
1804  AnnotatedLine &Line)
1805  : Style(Style), Keywords(Keywords), Current(Line.First) {}
1806 
1807  /// Parse expressions with the given operator precedence.
1808  void parse(int Precedence = 0) {
1809  // Skip 'return' and ObjC selector colons as they are not part of a binary
1810  // expression.
1811  while (Current && (Current->is(tok::kw_return) ||
1812  (Current->is(tok::colon) &&
1813  Current->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral))))
1814  next();
1815 
1816  if (!Current || Precedence > PrecedenceArrowAndPeriod)
1817  return;
1818 
1819  // Conditional expressions need to be parsed separately for proper nesting.
1820  if (Precedence == prec::Conditional) {
1821  parseConditionalExpr();
1822  return;
1823  }
1824 
1825  // Parse unary operators, which all have a higher precedence than binary
1826  // operators.
1827  if (Precedence == PrecedenceUnaryOperator) {
1828  parseUnaryOperator();
1829  return;
1830  }
1831 
1832  FormatToken *Start = Current;
1833  FormatToken *LatestOperator = nullptr;
1834  unsigned OperatorIndex = 0;
1835 
1836  while (Current) {
1837  // Consume operators with higher precedence.
1838  parse(Precedence + 1);
1839 
1840  int CurrentPrecedence = getCurrentPrecedence();
1841 
1842  if (Current && Current->is(TT_SelectorName) &&
1843  Precedence == CurrentPrecedence) {
1844  if (LatestOperator)
1845  addFakeParenthesis(Start, prec::Level(Precedence));
1846  Start = Current;
1847  }
1848 
1849  // At the end of the line or when an operator with higher precedence is
1850  // found, insert fake parenthesis and return.
1851  if (!Current ||
1852  (Current->closesScope() &&
1853  (Current->MatchingParen || Current->is(TT_TemplateString))) ||
1854  (CurrentPrecedence != -1 && CurrentPrecedence < Precedence) ||
1855  (CurrentPrecedence == prec::Conditional &&
1856  Precedence == prec::Assignment && Current->is(tok::colon))) {
1857  break;
1858  }
1859 
1860  // Consume scopes: (), [], <> and {}
1861  if (Current->opensScope()) {
1862  // In fragment of a JavaScript template string can look like '}..${' and
1863  // thus close a scope and open a new one at the same time.
1864  while (Current && (!Current->closesScope() || Current->opensScope())) {
1865  next();
1866  parse();
1867  }
1868  next();
1869  } else {
1870  // Operator found.
1871  if (CurrentPrecedence == Precedence) {
1872  if (LatestOperator)
1873  LatestOperator->NextOperator = Current;
1874  LatestOperator = Current;
1875  Current->OperatorIndex = OperatorIndex;
1876  ++OperatorIndex;
1877  }
1878  next(/*SkipPastLeadingComments=*/Precedence > 0);
1879  }
1880  }
1881 
1882  if (LatestOperator && (Current || Precedence > 0)) {
1883  // LatestOperator->LastOperator = true;
1884  if (Precedence == PrecedenceArrowAndPeriod) {
1885  // Call expressions don't have a binary operator precedence.
1886  addFakeParenthesis(Start, prec::Unknown);
1887  } else {
1888  addFakeParenthesis(Start, prec::Level(Precedence));
1889  }
1890  }
1891  }
1892 
1893 private:
1894  /// Gets the precedence (+1) of the given token for binary operators
1895  /// and other tokens that we treat like binary operators.
1896  int getCurrentPrecedence() {
1897  if (Current) {
1898  const FormatToken *NextNonComment = Current->getNextNonComment();
1899  if (Current->is(TT_ConditionalExpr))
1900  return prec::Conditional;
1901  if (NextNonComment && Current->is(TT_SelectorName) &&
1902  (NextNonComment->isOneOf(TT_DictLiteral, TT_JsTypeColon) ||
1903  ((Style.Language == FormatStyle::LK_Proto ||
1904  Style.Language == FormatStyle::LK_TextProto) &&
1905  NextNonComment->is(tok::less))))
1906  return prec::Assignment;
1907  if (Current->is(TT_JsComputedPropertyName))
1908  return prec::Assignment;
1909  if (Current->is(TT_LambdaArrow))
1910  return prec::Comma;
1911  if (Current->is(TT_JsFatArrow))
1912  return prec::Assignment;
1913  if (Current->isOneOf(tok::semi, TT_InlineASMColon, TT_SelectorName) ||
1914  (Current->is(tok::comment) && NextNonComment &&
1915  NextNonComment->is(TT_SelectorName)))
1916  return 0;
1917  if (Current->is(TT_RangeBasedForLoopColon))
1918  return prec::Comma;
1919  if ((Style.Language == FormatStyle::LK_Java ||
1920  Style.Language == FormatStyle::LK_JavaScript) &&
1921  Current->is(Keywords.kw_instanceof))
1922  return prec::Relational;
1923  if (Style.Language == FormatStyle::LK_JavaScript &&
1924  Current->isOneOf(Keywords.kw_in, Keywords.kw_as))
1925  return prec::Relational;
1926  if (Current->is(TT_BinaryOperator) || Current->is(tok::comma))
1927  return Current->getPrecedence();
1928  if (Current->isOneOf(tok::period, tok::arrow))
1929  return PrecedenceArrowAndPeriod;
1930  if ((Style.Language == FormatStyle::LK_Java ||
1931  Style.Language == FormatStyle::LK_JavaScript) &&
1932  Current->isOneOf(Keywords.kw_extends, Keywords.kw_implements,
1933  Keywords.kw_throws))
1934  return 0;
1935  }
1936  return -1;
1937  }
1938 
1939  void addFakeParenthesis(FormatToken *Start, prec::Level Precedence) {
1940  Start->FakeLParens.push_back(Precedence);
1941  if (Precedence > prec::Unknown)
1942  Start->StartsBinaryExpression = true;
1943  if (Current) {
1944  FormatToken *Previous = Current->Previous;
1945  while (Previous->is(tok::comment) && Previous->Previous)
1946  Previous = Previous->Previous;
1947  ++Previous->FakeRParens;
1948  if (Precedence > prec::Unknown)
1949  Previous->EndsBinaryExpression = true;
1950  }
1951  }
1952 
1953  /// Parse unary operator expressions and surround them with fake
1954  /// parentheses if appropriate.
1955  void parseUnaryOperator() {
1957  while (Current && Current->is(TT_UnaryOperator)) {
1958  Tokens.push_back(Current);
1959  next();
1960  }
1961  parse(PrecedenceArrowAndPeriod);
1962  for (FormatToken *Token : llvm::reverse(Tokens))
1963  // The actual precedence doesn't matter.
1964  addFakeParenthesis(Token, prec::Unknown);
1965  }
1966 
1967  void parseConditionalExpr() {
1968  while (Current && Current->isTrailingComment()) {
1969  next();
1970  }
1971  FormatToken *Start = Current;
1972  parse(prec::LogicalOr);
1973  if (!Current || !Current->is(tok::question))
1974  return;
1975  next();
1976  parse(prec::Assignment);
1977  if (!Current || Current->isNot(TT_ConditionalExpr))
1978  return;
1979  next();
1980  parse(prec::Assignment);
1981  addFakeParenthesis(Start, prec::Conditional);
1982  }
1983 
1984  void next(bool SkipPastLeadingComments = true) {
1985  if (Current)
1986  Current = Current->Next;
1987  while (Current &&
1988  (Current->NewlinesBefore == 0 || SkipPastLeadingComments) &&
1989  Current->isTrailingComment())
1990  Current = Current->Next;
1991  }
1992 
1993  const FormatStyle &Style;
1994  const AdditionalKeywords &Keywords;
1995  FormatToken *Current;
1996 };
1997 
1998 } // end anonymous namespace
1999 
2002  const AnnotatedLine *NextNonCommentLine = nullptr;
2004  E = Lines.rend();
2005  I != E; ++I) {
2006  bool CommentLine = true;
2007  for (const FormatToken *Tok = (*I)->First; Tok; Tok = Tok->Next) {
2008  if (!Tok->is(tok::comment)) {
2009  CommentLine = false;
2010  break;
2011  }
2012  }
2013 
2014  // If the comment is currently aligned with the line immediately following
2015  // it, that's probably intentional and we should keep it.
2016  if (NextNonCommentLine && CommentLine &&
2017  NextNonCommentLine->First->NewlinesBefore <= 1 &&
2018  NextNonCommentLine->First->OriginalColumn ==
2019  (*I)->First->OriginalColumn) {
2020  // Align comments for preprocessor lines with the # in column 0 if
2021  // preprocessor lines are not indented. Otherwise, align with the next
2022  // line.
2023  (*I)->Level =
2024  (Style.IndentPPDirectives != FormatStyle::PPDIS_BeforeHash &&
2025  (NextNonCommentLine->Type == LT_PreprocessorDirective ||
2026  NextNonCommentLine->Type == LT_ImportStatement))
2027  ? 0
2028  : NextNonCommentLine->Level;
2029  } else {
2030  NextNonCommentLine = (*I)->First->isNot(tok::r_brace) ? (*I) : nullptr;
2031  }
2032 
2033  setCommentLineLevels((*I)->Children);
2034  }
2035 }
2036 
2037 static unsigned maxNestingDepth(const AnnotatedLine &Line) {
2038  unsigned Result = 0;
2039  for (const auto *Tok = Line.First; Tok != nullptr; Tok = Tok->Next)
2040  Result = std::max(Result, Tok->NestingLevel);
2041  return Result;
2042 }
2043 
2046  E = Line.Children.end();
2047  I != E; ++I) {
2048  annotate(**I);
2049  }
2050  AnnotatingParser Parser(Style, Line, Keywords);
2051  Line.Type = Parser.parseLine();
2052 
2053  // With very deep nesting, ExpressionParser uses lots of stack and the
2054  // formatting algorithm is very slow. We're not going to do a good job here
2055  // anyway - it's probably generated code being formatted by mistake.
2056  // Just skip the whole line.
2057  if (maxNestingDepth(Line) > 50)
2058  Line.Type = LT_Invalid;
2059 
2060  if (Line.Type == LT_Invalid)
2061  return;
2062 
2063  ExpressionParser ExprParser(Style, Keywords, Line);
2064  ExprParser.parse();
2065 
2066  if (Line.startsWith(TT_ObjCMethodSpecifier))
2067  Line.Type = LT_ObjCMethodDecl;
2068  else if (Line.startsWith(TT_ObjCDecl))
2069  Line.Type = LT_ObjCDecl;
2070  else if (Line.startsWith(TT_ObjCProperty))
2071  Line.Type = LT_ObjCProperty;
2072 
2073  Line.First->SpacesRequiredBefore = 1;
2074  Line.First->CanBreakBefore = Line.First->MustBreakBefore;
2075 }
2076 
2077 // This function heuristically determines whether 'Current' starts the name of a
2078 // function declaration.
2079 static bool isFunctionDeclarationName(const FormatToken &Current,
2080  const AnnotatedLine &Line) {
2081  auto skipOperatorName = [](const FormatToken *Next) -> const FormatToken * {
2082  for (; Next; Next = Next->Next) {
2083  if (Next->is(TT_OverloadedOperatorLParen))
2084  return Next;
2085  if (Next->is(TT_OverloadedOperator))
2086  continue;
2087  if (Next->isOneOf(tok::kw_new, tok::kw_delete)) {
2088  // For 'new[]' and 'delete[]'.
2089  if (Next->Next && Next->Next->is(tok::l_square) && Next->Next->Next &&
2090  Next->Next->Next->is(tok::r_square))
2091  Next = Next->Next->Next;
2092  continue;
2093  }
2094 
2095  break;
2096  }
2097  return nullptr;
2098  };
2099 
2100  // Find parentheses of parameter list.
2101  const FormatToken *Next = Current.Next;
2102  if (Current.is(tok::kw_operator)) {
2103  if (Current.Previous && Current.Previous->is(tok::coloncolon))
2104  return false;
2105  Next = skipOperatorName(Next);
2106  } else {
2107  if (!Current.is(TT_StartOfName) || Current.NestingLevel != 0)
2108  return false;
2109  for (; Next; Next = Next->Next) {
2110  if (Next->is(TT_TemplateOpener)) {
2111  Next = Next->MatchingParen;
2112  } else if (Next->is(tok::coloncolon)) {
2113  Next = Next->Next;
2114  if (!Next)
2115  return false;
2116  if (Next->is(tok::kw_operator)) {
2117  Next = skipOperatorName(Next->Next);
2118  break;
2119  }
2120  if (!Next->is(tok::identifier))
2121  return false;
2122  } else if (Next->is(tok::l_paren)) {
2123  break;
2124  } else {
2125  return false;
2126  }
2127  }
2128  }
2129 
2130  // Check whether parameter list can belong to a function declaration.
2131  if (!Next || !Next->is(tok::l_paren) || !Next->MatchingParen)
2132  return false;
2133  // If the lines ends with "{", this is likely an function definition.
2134  if (Line.Last->is(tok::l_brace))
2135  return true;
2136  if (Next->Next == Next->MatchingParen)
2137  return true; // Empty parentheses.
2138  // If there is an &/&& after the r_paren, this is likely a function.
2139  if (Next->MatchingParen->Next &&
2140  Next->MatchingParen->Next->is(TT_PointerOrReference))
2141  return true;
2142  for (const FormatToken *Tok = Next->Next; Tok && Tok != Next->MatchingParen;
2143  Tok = Tok->Next) {
2144  if (Tok->isOneOf(tok::l_paren, TT_TemplateOpener) && Tok->MatchingParen) {
2145  Tok = Tok->MatchingParen;
2146  continue;
2147  }
2148  if (Tok->is(tok::kw_const) || Tok->isSimpleTypeSpecifier() ||
2149  Tok->isOneOf(TT_PointerOrReference, TT_StartOfName, tok::ellipsis))
2150  return true;
2151  if (Tok->isOneOf(tok::l_brace, tok::string_literal, TT_ObjCMethodExpr) ||
2152  Tok->Tok.isLiteral())
2153  return false;
2154  }
2155  return false;
2156 }
2157 
2158 bool TokenAnnotator::mustBreakForReturnType(const AnnotatedLine &Line) const {
2159  assert(Line.MightBeFunctionDecl);
2160 
2161  if ((Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_TopLevel ||
2162  Style.AlwaysBreakAfterReturnType ==
2163  FormatStyle::RTBS_TopLevelDefinitions) &&
2164  Line.Level > 0)
2165  return false;
2166 
2167  switch (Style.AlwaysBreakAfterReturnType) {
2168  case FormatStyle::RTBS_None:
2169  return false;
2170  case FormatStyle::RTBS_All:
2171  case FormatStyle::RTBS_TopLevel:
2172  return true;
2173  case FormatStyle::RTBS_AllDefinitions:
2174  case FormatStyle::RTBS_TopLevelDefinitions:
2175  return Line.mightBeFunctionDefinition();
2176  }
2177 
2178  return false;
2179 }
2180 
2183  E = Line.Children.end();
2184  I != E; ++I) {
2185  calculateFormattingInformation(**I);
2186  }
2187 
2188  Line.First->TotalLength =
2189  Line.First->IsMultiline ? Style.ColumnLimit
2190  : Line.FirstStartColumn + Line.First->ColumnWidth;
2191  FormatToken *Current = Line.First->Next;
2192  bool InFunctionDecl = Line.MightBeFunctionDecl;
2193  while (Current) {
2194  if (isFunctionDeclarationName(*Current, Line))
2195  Current->Type = TT_FunctionDeclarationName;
2196  if (Current->is(TT_LineComment)) {
2197  if (Current->Previous->BlockKind == BK_BracedInit &&
2198  Current->Previous->opensScope())
2199  Current->SpacesRequiredBefore =
2200  (Style.Cpp11BracedListStyle && !Style.SpacesInParentheses) ? 0 : 1;
2201  else
2202  Current->SpacesRequiredBefore = Style.SpacesBeforeTrailingComments;
2203 
2204  // If we find a trailing comment, iterate backwards to determine whether
2205  // it seems to relate to a specific parameter. If so, break before that
2206  // parameter to avoid changing the comment's meaning. E.g. don't move 'b'
2207  // to the previous line in:
2208  // SomeFunction(a,
2209  // b, // comment
2210  // c);
2211  if (!Current->HasUnescapedNewline) {
2212  for (FormatToken *Parameter = Current->Previous; Parameter;
2213  Parameter = Parameter->Previous) {
2214  if (Parameter->isOneOf(tok::comment, tok::r_brace))
2215  break;
2216  if (Parameter->Previous && Parameter->Previous->is(tok::comma)) {
2217  if (!Parameter->Previous->is(TT_CtorInitializerComma) &&
2218  Parameter->HasUnescapedNewline)
2219  Parameter->MustBreakBefore = true;
2220  break;
2221  }
2222  }
2223  }
2224  } else if (Current->SpacesRequiredBefore == 0 &&
2225  spaceRequiredBefore(Line, *Current)) {
2226  Current->SpacesRequiredBefore = 1;
2227  }
2228 
2229  Current->MustBreakBefore =
2230  Current->MustBreakBefore || mustBreakBefore(Line, *Current);
2231 
2232  if (!Current->MustBreakBefore && InFunctionDecl &&
2233  Current->is(TT_FunctionDeclarationName))
2234  Current->MustBreakBefore = mustBreakForReturnType(Line);
2235 
2236  Current->CanBreakBefore =
2237  Current->MustBreakBefore || canBreakBefore(Line, *Current);
2238  unsigned ChildSize = 0;
2239  if (Current->Previous->Children.size() == 1) {
2240  FormatToken &LastOfChild = *Current->Previous->Children[0]->Last;
2241  ChildSize = LastOfChild.isTrailingComment() ? Style.ColumnLimit
2242  : LastOfChild.TotalLength + 1;
2243  }
2244  const FormatToken *Prev = Current->Previous;
2245  if (Current->MustBreakBefore || Prev->Children.size() > 1 ||
2246  (Prev->Children.size() == 1 &&
2247  Prev->Children[0]->First->MustBreakBefore) ||
2248  Current->IsMultiline)
2249  Current->TotalLength = Prev->TotalLength + Style.ColumnLimit;
2250  else
2251  Current->TotalLength = Prev->TotalLength + Current->ColumnWidth +
2252  ChildSize + Current->SpacesRequiredBefore;
2253 
2254  if (Current->is(TT_CtorInitializerColon))
2255  InFunctionDecl = false;
2256 
2257  // FIXME: Only calculate this if CanBreakBefore is true once static
2258  // initializers etc. are sorted out.
2259  // FIXME: Move magic numbers to a better place.
2260 
2261  // Reduce penalty for aligning ObjC method arguments using the colon
2262  // alignment as this is the canonical way (still prefer fitting everything
2263  // into one line if possible). Trying to fit a whole expression into one
2264  // line should not force other line breaks (e.g. when ObjC method
2265  // expression is a part of other expression).
2266  Current->SplitPenalty = splitPenalty(Line, *Current, InFunctionDecl);
2267  if (Style.Language == FormatStyle::LK_ObjC &&
2268  Current->is(TT_SelectorName) && Current->ParameterIndex > 0) {
2269  if (Current->ParameterIndex == 1)
2270  Current->SplitPenalty += 5 * Current->BindingStrength;
2271  } else {
2272  Current->SplitPenalty += 20 * Current->BindingStrength;
2273  }
2274 
2275  Current = Current->Next;
2276  }
2277 
2278  calculateUnbreakableTailLengths(Line);
2279  unsigned IndentLevel = Line.Level;
2280  for (Current = Line.First; Current != nullptr; Current = Current->Next) {
2281  if (Current->Role)
2282  Current->Role->precomputeFormattingInfos(Current);
2283  if (Current->MatchingParen &&
2285  assert(IndentLevel > 0);
2286  --IndentLevel;
2287  }
2288  Current->IndentLevel = IndentLevel;
2289  if (Current->opensBlockOrBlockTypeList(Style))
2290  ++IndentLevel;
2291  }
2292 
2293  LLVM_DEBUG({ printDebugInfo(Line); });
2294 }
2295 
2296 void TokenAnnotator::calculateUnbreakableTailLengths(AnnotatedLine &Line) {
2297  unsigned UnbreakableTailLength = 0;
2298  FormatToken *Current = Line.Last;
2299  while (Current) {
2300  Current->UnbreakableTailLength = UnbreakableTailLength;
2301  if (Current->CanBreakBefore ||
2302  Current->isOneOf(tok::comment, tok::string_literal)) {
2303  UnbreakableTailLength = 0;
2304  } else {
2305  UnbreakableTailLength +=
2306  Current->ColumnWidth + Current->SpacesRequiredBefore;
2307  }
2308  Current = Current->Previous;
2309  }
2310 }
2311 
2312 unsigned TokenAnnotator::splitPenalty(const AnnotatedLine &Line,
2313  const FormatToken &Tok,
2314  bool InFunctionDecl) {
2315  const FormatToken &Left = *Tok.Previous;
2316  const FormatToken &Right = Tok;
2317 
2318  if (Left.is(tok::semi))
2319  return 0;
2320 
2321  if (Style.Language == FormatStyle::LK_Java) {
2322  if (Right.isOneOf(Keywords.kw_extends, Keywords.kw_throws))
2323  return 1;
2324  if (Right.is(Keywords.kw_implements))
2325  return 2;
2326  if (Left.is(tok::comma) && Left.NestingLevel == 0)
2327  return 3;
2328  } else if (Style.Language == FormatStyle::LK_JavaScript) {
2329  if (Right.is(Keywords.kw_function) && Left.isNot(tok::comma))
2330  return 100;
2331  if (Left.is(TT_JsTypeColon))
2332  return 35;
2333  if ((Left.is(TT_TemplateString) && Left.TokenText.endswith("${")) ||
2334  (Right.is(TT_TemplateString) && Right.TokenText.startswith("}")))
2335  return 100;
2336  // Prefer breaking call chains (".foo") over empty "{}", "[]" or "()".
2337  if (Left.opensScope() && Right.closesScope())
2338  return 200;
2339  }
2340 
2341  if (Right.is(tok::identifier) && Right.Next && Right.Next->is(TT_DictLiteral))
2342  return 1;
2343  if (Right.is(tok::l_square)) {
2344  if (Style.Language == FormatStyle::LK_Proto)
2345  return 1;
2346  if (Left.is(tok::r_square))
2347  return 200;
2348  // Slightly prefer formatting local lambda definitions like functions.
2349  if (Right.is(TT_LambdaLSquare) && Left.is(tok::equal))
2350  return 35;
2351  if (!Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare,
2352  TT_ArrayInitializerLSquare,
2353  TT_DesignatedInitializerLSquare, TT_AttributeSquare))
2354  return 500;
2355  }
2356 
2357  if (Left.is(tok::coloncolon) ||
2358  (Right.is(tok::period) && Style.Language == FormatStyle::LK_Proto))
2359  return 500;
2360  if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
2361  Right.is(tok::kw_operator)) {
2362  if (Line.startsWith(tok::kw_for) && Right.PartOfMultiVariableDeclStmt)
2363  return 3;
2364  if (Left.is(TT_StartOfName))
2365  return 110;
2366  if (InFunctionDecl && Right.NestingLevel == 0)
2367  return Style.PenaltyReturnTypeOnItsOwnLine;
2368  return 200;
2369  }
2370  if (Right.is(TT_PointerOrReference))
2371  return 190;
2372  if (Right.is(TT_LambdaArrow))
2373  return 110;
2374  if (Left.is(tok::equal) && Right.is(tok::l_brace))
2375  return 160;
2376  if (Left.is(TT_CastRParen))
2377  return 100;
2378  if (Left.isOneOf(tok::kw_class, tok::kw_struct))
2379  return 5000;
2380  if (Left.is(tok::comment))
2381  return 1000;
2382 
2383  if (Left.isOneOf(TT_RangeBasedForLoopColon, TT_InheritanceColon,
2384  TT_CtorInitializerColon))
2385  return 2;
2386 
2387  if (Right.isMemberAccess()) {
2388  // Breaking before the "./->" of a chained call/member access is reasonably
2389  // cheap, as formatting those with one call per line is generally
2390  // desirable. In particular, it should be cheaper to break before the call
2391  // than it is to break inside a call's parameters, which could lead to weird
2392  // "hanging" indents. The exception is the very last "./->" to support this
2393  // frequent pattern:
2394  //
2395  // aaaaaaaa.aaaaaaaa.bbbbbbb().ccccccccccccccccccccc(
2396  // dddddddd);
2397  //
2398  // which might otherwise be blown up onto many lines. Here, clang-format
2399  // won't produce "hanging" indents anyway as there is no other trailing
2400  // call.
2401  //
2402  // Also apply higher penalty is not a call as that might lead to a wrapping
2403  // like:
2404  //
2405  // aaaaaaa
2406  // .aaaaaaaaa.bbbbbbbb(cccccccc);
2407  return !Right.NextOperator || !Right.NextOperator->Previous->closesScope()
2408  ? 150
2409  : 35;
2410  }
2411 
2412  if (Right.is(TT_TrailingAnnotation) &&
2413  (!Right.Next || Right.Next->isNot(tok::l_paren))) {
2414  // Moving trailing annotations to the next line is fine for ObjC method
2415  // declarations.
2416  if (Line.startsWith(TT_ObjCMethodSpecifier))
2417  return 10;
2418  // Generally, breaking before a trailing annotation is bad unless it is
2419  // function-like. It seems to be especially preferable to keep standard
2420  // annotations (i.e. "const", "final" and "override") on the same line.
2421  // Use a slightly higher penalty after ")" so that annotations like
2422  // "const override" are kept together.
2423  bool is_short_annotation = Right.TokenText.size() < 10;
2424  return (Left.is(tok::r_paren) ? 100 : 120) + (is_short_annotation ? 50 : 0);
2425  }
2426 
2427  // In for-loops, prefer breaking at ',' and ';'.
2428  if (Line.startsWith(tok::kw_for) && Left.is(tok::equal))
2429  return 4;
2430 
2431  // In Objective-C method expressions, prefer breaking before "param:" over
2432  // breaking after it.
2433  if (Right.is(TT_SelectorName))
2434  return 0;
2435  if (Left.is(tok::colon) && Left.is(TT_ObjCMethodExpr))
2436  return Line.MightBeFunctionDecl ? 50 : 500;
2437 
2438  // In Objective-C type declarations, avoid breaking after the category's
2439  // open paren (we'll prefer breaking after the protocol list's opening
2440  // angle bracket, if present).
2441  if (Line.Type == LT_ObjCDecl && Left.is(tok::l_paren) && Left.Previous &&
2442  Left.Previous->isOneOf(tok::identifier, tok::greater))
2443  return 500;
2444 
2445  if (Left.is(tok::l_paren) && InFunctionDecl &&
2447  return 100;
2448  if (Left.is(tok::l_paren) && Left.Previous &&
2449  (Left.Previous->is(tok::kw_for) || Left.Previous->isIf()))
2450  return 1000;
2451  if (Left.is(tok::equal) && InFunctionDecl)
2452  return 110;
2453  if (Right.is(tok::r_brace))
2454  return 1;
2455  if (Left.is(TT_TemplateOpener))
2456  return 100;
2457  if (Left.opensScope()) {
2459  return 0;
2460  if (Left.is(tok::l_brace) && !Style.Cpp11BracedListStyle)
2461  return 19;
2462  return Left.ParameterCount > 1 ? Style.PenaltyBreakBeforeFirstCallParameter
2463  : 19;
2464  }
2465  if (Left.is(TT_JavaAnnotation))
2466  return 50;
2467 
2468  if (Left.is(TT_UnaryOperator))
2469  return 60;
2470  if (Left.isOneOf(tok::plus, tok::comma) && Left.Previous &&
2471  Left.Previous->isLabelString() &&
2472  (Left.NextOperator || Left.OperatorIndex != 0))
2473  return 50;
2474  if (Right.is(tok::plus) && Left.isLabelString() &&
2475  (Right.NextOperator || Right.OperatorIndex != 0))
2476  return 25;
2477  if (Left.is(tok::comma))
2478  return 1;
2479  if (Right.is(tok::lessless) && Left.isLabelString() &&
2480  (Right.NextOperator || Right.OperatorIndex != 1))
2481  return 25;
2482  if (Right.is(tok::lessless)) {
2483  // Breaking at a << is really cheap.
2484  if (!Left.is(tok::r_paren) || Right.OperatorIndex > 0)
2485  // Slightly prefer to break before the first one in log-like statements.
2486  return 2;
2487  return 1;
2488  }
2489  if (Left.ClosesTemplateDeclaration)
2490  return Style.PenaltyBreakTemplateDeclaration;
2491  if (Left.is(TT_ConditionalExpr))
2492  return prec::Conditional;
2493  prec::Level Level = Left.getPrecedence();
2494  if (Level == prec::Unknown)
2495  Level = Right.getPrecedence();
2496  if (Level == prec::Assignment)
2497  return Style.PenaltyBreakAssignment;
2498  if (Level != prec::Unknown)
2499  return Level;
2500 
2501  return 3;
2502 }
2503 
2504 bool TokenAnnotator::spaceRequiredBeforeParens(const FormatToken &Right) const {
2505  return Style.SpaceBeforeParens == FormatStyle::SBPO_Always ||
2506  (Style.SpaceBeforeParens == FormatStyle::SBPO_NonEmptyParentheses &&
2507  Right.ParameterCount > 0);
2508 }
2509 
2510 bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
2511  const FormatToken &Left,
2512  const FormatToken &Right) {
2513  if (Left.is(tok::kw_return) && Right.isNot(tok::semi))
2514  return true;
2515  if (Left.is(Keywords.kw_assert) && Style.Language == FormatStyle::LK_Java)
2516  return true;
2517  if (Style.ObjCSpaceAfterProperty && Line.Type == LT_ObjCProperty &&
2518  Left.Tok.getObjCKeywordID() == tok::objc_property)
2519  return true;
2520  if (Right.is(tok::hashhash))
2521  return Left.is(tok::hash);
2522  if (Left.isOneOf(tok::hashhash, tok::hash))
2523  return Right.is(tok::hash);
2524  if ((Left.is(tok::l_paren) && Right.is(tok::r_paren)) ||
2525  (Left.is(tok::l_brace) && Left.BlockKind != BK_Block &&
2526  Right.is(tok::r_brace) && Right.BlockKind != BK_Block))
2527  return Style.SpaceInEmptyParentheses;
2528  if (Left.is(tok::l_paren) || Right.is(tok::r_paren))
2529  return (Right.is(TT_CastRParen) ||
2530  (Left.MatchingParen && Left.MatchingParen->is(TT_CastRParen)))
2531  ? Style.SpacesInCStyleCastParentheses
2532  : Style.SpacesInParentheses;
2533  if (Right.isOneOf(tok::semi, tok::comma))
2534  return false;
2535  if (Right.is(tok::less) && Line.Type == LT_ObjCDecl) {
2536  bool IsLightweightGeneric = Right.MatchingParen &&
2537  Right.MatchingParen->Next &&
2538  Right.MatchingParen->Next->is(tok::colon);
2539  return !IsLightweightGeneric && Style.ObjCSpaceBeforeProtocolList;
2540  }
2541  if (Right.is(tok::less) && Left.is(tok::kw_template))
2542  return Style.SpaceAfterTemplateKeyword;
2543  if (Left.isOneOf(tok::exclaim, tok::tilde))
2544  return false;
2545  if (Left.is(tok::at) &&
2546  Right.isOneOf(tok::identifier, tok::string_literal, tok::char_constant,
2547  tok::numeric_constant, tok::l_paren, tok::l_brace,
2548  tok::kw_true, tok::kw_false))
2549  return false;
2550  if (Left.is(tok::colon))
2551  return !Left.is(TT_ObjCMethodExpr);
2552  if (Left.is(tok::coloncolon))
2553  return false;
2554  if (Left.is(tok::less) || Right.isOneOf(tok::greater, tok::less)) {
2555  if (Style.Language == FormatStyle::LK_TextProto ||
2556  (Style.Language == FormatStyle::LK_Proto &&
2557  (Left.is(TT_DictLiteral) || Right.is(TT_DictLiteral)))) {
2558  // Format empty list as `<>`.
2559  if (Left.is(tok::less) && Right.is(tok::greater))
2560  return false;
2561  return !Style.Cpp11BracedListStyle;
2562  }
2563  return false;
2564  }
2565  if (Right.is(tok::ellipsis))
2566  return Left.Tok.isLiteral() || (Left.is(tok::identifier) && Left.Previous &&
2567  Left.Previous->is(tok::kw_case));
2568  if (Left.is(tok::l_square) && Right.is(tok::amp))
2569  return false;
2570  if (Right.is(TT_PointerOrReference)) {
2571  if (Left.is(tok::r_paren) && Line.MightBeFunctionDecl) {
2572  if (!Left.MatchingParen)
2573  return true;
2574  FormatToken *TokenBeforeMatchingParen =
2576  if (!TokenBeforeMatchingParen ||
2577  !TokenBeforeMatchingParen->isOneOf(tok::kw_typeof, tok::kw_decltype,
2578  TT_TypenameMacro))
2579  return true;
2580  }
2581  return (Left.Tok.isLiteral() ||
2582  (!Left.isOneOf(TT_PointerOrReference, tok::l_paren) &&
2583  (Style.PointerAlignment != FormatStyle::PAS_Left ||
2584  (Line.IsMultiVariableDeclStmt &&
2585  (Left.NestingLevel == 0 ||
2586  (Left.NestingLevel == 1 && Line.First->is(tok::kw_for)))))));
2587  }
2588  if (Right.is(TT_FunctionTypeLParen) && Left.isNot(tok::l_paren) &&
2589  (!Left.is(TT_PointerOrReference) ||
2590  (Style.PointerAlignment != FormatStyle::PAS_Right &&
2591  !Line.IsMultiVariableDeclStmt)))
2592  return true;
2593  if (Left.is(TT_PointerOrReference))
2594  return Right.Tok.isLiteral() || Right.is(TT_BlockComment) ||
2595  (Right.isOneOf(Keywords.kw_override, Keywords.kw_final) &&
2596  !Right.is(TT_StartOfName)) ||
2597  (Right.is(tok::l_brace) && Right.BlockKind == BK_Block) ||
2598  (!Right.isOneOf(TT_PointerOrReference, TT_ArraySubscriptLSquare,
2599  tok::l_paren) &&
2600  (Style.PointerAlignment != FormatStyle::PAS_Right &&
2601  !Line.IsMultiVariableDeclStmt) &&
2602  Left.Previous &&
2603  !Left.Previous->isOneOf(tok::l_paren, tok::coloncolon,
2604  tok::l_square));
2605  if (Right.is(tok::star) && Left.is(tok::l_paren))
2606  return false;
2607  const auto SpaceRequiredForArrayInitializerLSquare =
2608  [](const FormatToken &LSquareTok, const FormatStyle &Style) {
2609  return Style.SpacesInContainerLiterals ||
2610  ((Style.Language == FormatStyle::LK_Proto ||
2611  Style.Language == FormatStyle::LK_TextProto) &&
2612  !Style.Cpp11BracedListStyle &&
2613  LSquareTok.endsSequence(tok::l_square, tok::colon,
2614  TT_SelectorName));
2615  };
2616  if (Left.is(tok::l_square))
2617  return (Left.is(TT_ArrayInitializerLSquare) && Right.isNot(tok::r_square) &&
2618  SpaceRequiredForArrayInitializerLSquare(Left, Style)) ||
2619  (Left.isOneOf(TT_ArraySubscriptLSquare, TT_StructuredBindingLSquare,
2620  TT_LambdaLSquare) &&
2621  Style.SpacesInSquareBrackets && Right.isNot(tok::r_square));
2622  if (Right.is(tok::r_square))
2623  return Right.MatchingParen &&
2624  ((Right.MatchingParen->is(TT_ArrayInitializerLSquare) &&
2625  SpaceRequiredForArrayInitializerLSquare(*Right.MatchingParen,
2626  Style)) ||
2627  (Style.SpacesInSquareBrackets &&
2628  Right.MatchingParen->isOneOf(TT_ArraySubscriptLSquare,
2629  TT_StructuredBindingLSquare,
2630  TT_LambdaLSquare)) ||
2631  Right.MatchingParen->is(TT_AttributeParen));
2632  if (Right.is(tok::l_square) &&
2633  !Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare,
2634  TT_DesignatedInitializerLSquare,
2635  TT_StructuredBindingLSquare, TT_AttributeSquare) &&
2636  !Left.isOneOf(tok::numeric_constant, TT_DictLiteral))
2637  return false;
2638  if (Left.is(tok::l_brace) && Right.is(tok::r_brace))
2639  return !Left.Children.empty(); // No spaces in "{}".
2640  if ((Left.is(tok::l_brace) && Left.BlockKind != BK_Block) ||
2641  (Right.is(tok::r_brace) && Right.MatchingParen &&
2642  Right.MatchingParen->BlockKind != BK_Block))
2643  return Style.Cpp11BracedListStyle ? Style.SpacesInParentheses : true;
2644  if (Left.is(TT_BlockComment))
2645  // No whitespace in x(/*foo=*/1), except for JavaScript.
2646  return Style.Language == FormatStyle::LK_JavaScript ||
2647  !Left.TokenText.endswith("=*/");
2648  if (Right.is(tok::l_paren)) {
2649  if ((Left.is(tok::r_paren) && Left.is(TT_AttributeParen)) ||
2650  (Left.is(tok::r_square) && Left.is(TT_AttributeSquare)))
2651  return true;
2652  return Line.Type == LT_ObjCDecl || Left.is(tok::semi) ||
2653  (Style.SpaceBeforeParens != FormatStyle::SBPO_Never &&
2654  (Left.isOneOf(tok::pp_elif, tok::kw_for, tok::kw_while,
2655  tok::kw_switch, tok::kw_case, TT_ForEachMacro,
2656  TT_ObjCForIn) ||
2657  Left.isIf(Line.Type != LT_PreprocessorDirective) ||
2658  (Left.isOneOf(tok::kw_try, Keywords.kw___except, tok::kw_catch,
2659  tok::kw_new, tok::kw_delete) &&
2660  (!Left.Previous || Left.Previous->isNot(tok::period))))) ||
2661  (spaceRequiredBeforeParens(Right) &&
2662  (Left.is(tok::identifier) || Left.isFunctionLikeKeyword() ||
2663  Left.is(tok::r_paren) || Left.isSimpleTypeSpecifier() ||
2664  (Left.is(tok::r_square) && Left.MatchingParen &&
2665  Left.MatchingParen->is(TT_LambdaLSquare))) &&
2666  Line.Type != LT_PreprocessorDirective);
2667  }
2668  if (Left.is(tok::at) && Right.Tok.getObjCKeywordID() != tok::objc_not_keyword)
2669  return false;
2670  if (Right.is(TT_UnaryOperator))
2671  return !Left.isOneOf(tok::l_paren, tok::l_square, tok::at) &&
2672  (Left.isNot(tok::colon) || Left.isNot(TT_ObjCMethodExpr));
2673  if ((Left.isOneOf(tok::identifier, tok::greater, tok::r_square,
2674  tok::r_paren) ||
2675  Left.isSimpleTypeSpecifier()) &&
2676  Right.is(tok::l_brace) && Right.getNextNonComment() &&
2677  Right.BlockKind != BK_Block)
2678  return false;
2679  if (Left.is(tok::period) || Right.is(tok::period))
2680  return false;
2681  if (Right.is(tok::hash) && Left.is(tok::identifier) && Left.TokenText == "L")
2682  return false;
2683  if (Left.is(TT_TemplateCloser) && Left.MatchingParen &&
2684  Left.MatchingParen->Previous &&
2685  (Left.MatchingParen->Previous->is(tok::period) ||
2686  Left.MatchingParen->Previous->is(tok::coloncolon)))
2687  // Java call to generic function with explicit type:
2688  // A.<B<C<...>>>DoSomething();
2689  // A::<B<C<...>>>DoSomething(); // With a Java 8 method reference.
2690  return false;
2691  if (Left.is(TT_TemplateCloser) && Right.is(tok::l_square))
2692  return false;
2693  if (Left.is(tok::l_brace) && Left.endsSequence(TT_DictLiteral, tok::at))
2694  // Objective-C dictionary literal -> no space after opening brace.
2695  return false;
2696  if (Right.is(tok::r_brace) && Right.MatchingParen &&
2697  Right.MatchingParen->endsSequence(TT_DictLiteral, tok::at))
2698  // Objective-C dictionary literal -> no space before closing brace.
2699  return false;
2700  if (Right.Type == TT_TrailingAnnotation &&
2701  Right.isOneOf(tok::amp, tok::ampamp) &&
2702  Left.isOneOf(tok::kw_const, tok::kw_volatile) &&
2703  (!Right.Next || Right.Next->is(tok::semi)))
2704  // Match const and volatile ref-qualifiers without any additional
2705  // qualifiers such as
2706  // void Fn() const &;
2707  return Style.PointerAlignment != FormatStyle::PAS_Left;
2708  return true;
2709 }
2710 
2711 bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
2712  const FormatToken &Right) {
2713  const FormatToken &Left = *Right.Previous;
2714  if (Right.Tok.getIdentifierInfo() && Left.Tok.getIdentifierInfo())
2715  return true; // Never ever merge two identifiers.
2716  if (Style.isCpp()) {
2717  if (Left.is(tok::kw_operator))
2718  return Right.is(tok::coloncolon);
2719  if (Right.is(tok::l_brace) && Right.BlockKind == BK_BracedInit &&
2720  !Left.opensScope() && Style.SpaceBeforeCpp11BracedList)
2721  return true;
2722  } else if (Style.Language == FormatStyle::LK_Proto ||
2723  Style.Language == FormatStyle::LK_TextProto) {
2724  if (Right.is(tok::period) &&
2725  Left.isOneOf(Keywords.kw_optional, Keywords.kw_required,
2726  Keywords.kw_repeated, Keywords.kw_extend))
2727  return true;
2728  if (Right.is(tok::l_paren) &&
2729  Left.isOneOf(Keywords.kw_returns, Keywords.kw_option))
2730  return true;
2731  if (Right.isOneOf(tok::l_brace, tok::less) && Left.is(TT_SelectorName))
2732  return true;
2733  // Slashes occur in text protocol extension syntax: [type/type] { ... }.
2734  if (Left.is(tok::slash) || Right.is(tok::slash))
2735  return false;
2736  if (Left.MatchingParen &&
2737  Left.MatchingParen->is(TT_ProtoExtensionLSquare) &&
2738  Right.isOneOf(tok::l_brace, tok::less))
2739  return !Style.Cpp11BracedListStyle;
2740  // A percent is probably part of a formatting specification, such as %lld.
2741  if (Left.is(tok::percent))
2742  return false;
2743  // Preserve the existence of a space before a percent for cases like 0x%04x
2744  // and "%d %d"
2745  if (Left.is(tok::numeric_constant) && Right.is(tok::percent))
2746  return Right.WhitespaceRange.getEnd() != Right.WhitespaceRange.getBegin();
2747  } else if (Style.isCSharp()) {
2748  // space between type and variable e.g. Dictionary<string,string> foo;
2749  if (Left.is(TT_TemplateCloser) && Right.is(TT_StartOfName))
2750  return true;
2751  // space between keywords and paren e.g. "using ("
2752  if (Right.is(tok::l_paren))
2753  if (Left.is(tok::kw_using))
2754  return spaceRequiredBeforeParens(Left);
2755  } else if (Style.Language == FormatStyle::LK_JavaScript) {
2756  if (Left.is(TT_JsFatArrow))
2757  return true;
2758  // for await ( ...
2759  if (Right.is(tok::l_paren) && Left.is(Keywords.kw_await) && Left.Previous &&
2760  Left.Previous->is(tok::kw_for))
2761  return true;
2762  if (Left.is(Keywords.kw_async) && Right.is(tok::l_paren) &&
2763  Right.MatchingParen) {
2764  const FormatToken *Next = Right.MatchingParen->getNextNonComment();
2765  // An async arrow function, for example: `x = async () => foo();`,
2766  // as opposed to calling a function called async: `x = async();`
2767  if (Next && Next->is(TT_JsFatArrow))
2768  return true;
2769  }
2770  if ((Left.is(TT_TemplateString) && Left.TokenText.endswith("${")) ||
2771  (Right.is(TT_TemplateString) && Right.TokenText.startswith("}")))
2772  return false;
2773  // In tagged template literals ("html`bar baz`"), there is no space between
2774  // the tag identifier and the template string. getIdentifierInfo makes sure
2775  // that the identifier is not a pseudo keyword like `yield`, either.
2776  if (Left.is(tok::identifier) && Keywords.IsJavaScriptIdentifier(Left) &&
2777  Right.is(TT_TemplateString))
2778  return false;
2779  if (Right.is(tok::star) &&
2780  Left.isOneOf(Keywords.kw_function, Keywords.kw_yield))
2781  return false;
2782  if (Right.isOneOf(tok::l_brace, tok::l_square) &&
2783  Left.isOneOf(Keywords.kw_function, Keywords.kw_yield,
2784  Keywords.kw_extends, Keywords.kw_implements))
2785  return true;
2786  if (Right.is(tok::l_paren)) {
2787  // JS methods can use some keywords as names (e.g. `delete()`).
2788  if (Line.MustBeDeclaration && Left.Tok.getIdentifierInfo())
2789  return false;
2790  // Valid JS method names can include keywords, e.g. `foo.delete()` or
2791  // `bar.instanceof()`. Recognize call positions by preceding period.
2792  if (Left.Previous && Left.Previous->is(tok::period) &&
2793  Left.Tok.getIdentifierInfo())
2794  return false;
2795  // Additional unary JavaScript operators that need a space after.
2796  if (Left.isOneOf(tok::kw_throw, Keywords.kw_await, Keywords.kw_typeof,
2797  tok::kw_void))
2798  return true;
2799  }
2800  // `foo as const;` casts into a const type.
2801  if (Left.endsSequence(tok::kw_const, Keywords.kw_as)) {
2802  return false;
2803  }
2804  if ((Left.isOneOf(Keywords.kw_let, Keywords.kw_var, Keywords.kw_in,
2805  tok::kw_const) ||
2806  // "of" is only a keyword if it appears after another identifier
2807  // (e.g. as "const x of y" in a for loop), or after a destructuring
2808  // operation (const [x, y] of z, const {a, b} of c).
2809  (Left.is(Keywords.kw_of) && Left.Previous &&
2810  (Left.Previous->Tok.is(tok::identifier) ||
2811  Left.Previous->isOneOf(tok::r_square, tok::r_brace)))) &&
2812  (!Left.Previous || !Left.Previous->is(tok::period)))
2813  return true;
2814  if (Left.isOneOf(tok::kw_for, Keywords.kw_as) && Left.Previous &&
2815  Left.Previous->is(tok::period) && Right.is(tok::l_paren))
2816  return false;
2817  if (Left.is(Keywords.kw_as) &&
2818  Right.isOneOf(tok::l_square, tok::l_brace, tok::l_paren))
2819  return true;
2820  if (Left.is(tok::kw_default) && Left.Previous &&
2821  Left.Previous->is(tok::kw_export))
2822  return true;
2823  if (Left.is(Keywords.kw_is) && Right.is(tok::l_brace))
2824  return true;
2825  if (Right.isOneOf(TT_JsTypeColon, TT_JsTypeOptionalQuestion))
2826  return false;
2827  if (Left.is(TT_JsTypeOperator) || Right.is(TT_JsTypeOperator))
2828  return false;
2829  if ((Left.is(tok::l_brace) || Right.is(tok::r_brace)) &&
2830  Line.First->isOneOf(Keywords.kw_import, tok::kw_export))
2831  return false;
2832  if (Left.is(tok::ellipsis))
2833  return false;
2834  if (Left.is(TT_TemplateCloser) &&
2835  !Right.isOneOf(tok::equal, tok::l_brace, tok::comma, tok::l_square,
2836  Keywords.kw_implements, Keywords.kw_extends))
2837  // Type assertions ('<type>expr') are not followed by whitespace. Other
2838  // locations that should have whitespace following are identified by the
2839  // above set of follower tokens.
2840  return false;
2841  if (Right.is(TT_JsNonNullAssertion))
2842  return false;
2843  if (Left.is(TT_JsNonNullAssertion) &&
2844  Right.isOneOf(Keywords.kw_as, Keywords.kw_in))
2845  return true; // "x! as string", "x! in y"
2846  } else if (Style.Language == FormatStyle::LK_Java) {
2847  if (Left.is(tok::r_square) && Right.is(tok::l_brace))
2848  return true;
2849  if (Left.is(Keywords.kw_synchronized) && Right.is(tok::l_paren))
2850  return Style.SpaceBeforeParens != FormatStyle::SBPO_Never;
2851  if ((Left.isOneOf(tok::kw_static, tok::kw_public, tok::kw_private,
2852  tok::kw_protected) ||
2853  Left.isOneOf(Keywords.kw_final, Keywords.kw_abstract,
2854  Keywords.kw_native)) &&
2855  Right.is(TT_TemplateOpener))
2856  return true;
2857  }
2858  if (Left.is(TT_ImplicitStringLiteral))
2859  return Right.WhitespaceRange.getBegin() != Right.WhitespaceRange.getEnd();
2860  if (Line.Type == LT_ObjCMethodDecl) {
2861  if (Left.is(TT_ObjCMethodSpecifier))
2862  return true;
2863  if (Left.is(tok::r_paren) && canBeObjCSelectorComponent(Right))
2864  // Don't space between ')' and <id> or ')' and 'new'. 'new' is not a
2865  // keyword in Objective-C, and '+ (instancetype)new;' is a standard class
2866  // method declaration.
2867  return false;
2868  }
2869  if (Line.Type == LT_ObjCProperty &&
2870  (Right.is(tok::equal) || Left.is(tok::equal)))
2871  return false;
2872 
2873  if (Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow) ||
2874  Left.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow))
2875  return true;
2876  if (Right.is(TT_OverloadedOperatorLParen))
2877  return spaceRequiredBeforeParens(Right);
2878  if (Left.is(tok::comma))
2879  return true;
2880  if (Right.is(tok::comma))
2881  return false;
2882  if (Right.is(TT_ObjCBlockLParen))
2883  return true;
2884  if (Right.is(TT_CtorInitializerColon))
2885  return Style.SpaceBeforeCtorInitializerColon;
2886  if (Right.is(TT_InheritanceColon) && !Style.SpaceBeforeInheritanceColon)
2887  return false;
2888  if (Right.is(TT_RangeBasedForLoopColon) &&
2889  !Style.SpaceBeforeRangeBasedForLoopColon)
2890  return false;
2891  if (Right.is(tok::colon)) {
2892  if (Line.First->isOneOf(tok::kw_case, tok::kw_default) ||
2893  !Right.getNextNonComment() || Right.getNextNonComment()->is(tok::semi))
2894  return false;
2895  if (Right.is(TT_ObjCMethodExpr))
2896  return false;
2897  if (Left.is(tok::question))
2898  return false;
2899  if (Right.is(TT_InlineASMColon) && Left.is(tok::coloncolon))
2900  return false;
2901  if (Right.is(TT_DictLiteral))
2902  return Style.SpacesInContainerLiterals;
2903  if (Right.is(TT_AttributeColon))
2904  return false;
2905  return true;
2906  }
2907  if (Left.is(TT_UnaryOperator)) {
2908  // The alternative operators for ~ and ! are "compl" and "not".
2909  // If they are used instead, we do not want to combine them with
2910  // the token to the right, unless that is a left paren.
2911  if (!Right.is(tok::l_paren)) {
2912  if (Left.is(tok::exclaim) && Left.TokenText == "not")
2913  return true;
2914  if (Left.is(tok::tilde) && Left.TokenText == "compl")
2915  return true;
2916  }
2917  return (Style.SpaceAfterLogicalNot && Left.is(tok::exclaim)) ||
2918  Right.is(TT_BinaryOperator);
2919  }
2920 
2921  // If the next token is a binary operator or a selector name, we have
2922  // incorrectly classified the parenthesis as a cast. FIXME: Detect correctly.
2923  if (Left.is(TT_CastRParen))
2924  return Style.SpaceAfterCStyleCast ||
2925  Right.isOneOf(TT_BinaryOperator, TT_SelectorName);
2926 
2927  if (Left.is(tok::greater) && Right.is(tok::greater)) {
2928  if (Style.Language == FormatStyle::LK_TextProto ||
2929  (Style.Language == FormatStyle::LK_Proto && Left.is(TT_DictLiteral)))
2930  return !Style.Cpp11BracedListStyle;
2931  return Right.is(TT_TemplateCloser) && Left.is(TT_TemplateCloser) &&
2932  (Style.Standard < FormatStyle::LS_Cpp11 || Style.SpacesInAngles);
2933  }
2934  if (Right.isOneOf(tok::arrow, tok::arrowstar, tok::periodstar) ||
2935  Left.isOneOf(tok::arrow, tok::period, tok::arrowstar, tok::periodstar) ||
2936  (Right.is(tok::period) && Right.isNot(TT_DesignatedInitializerPeriod)))
2937  return false;
2938  if (!Style.SpaceBeforeAssignmentOperators && Left.isNot(TT_TemplateCloser) &&
2939  Right.getPrecedence() == prec::Assignment)
2940  return false;
2941  if (Style.Language == FormatStyle::LK_Java && Right.is(tok::coloncolon) &&
2942  (Left.is(tok::identifier) || Left.is(tok::kw_this)))
2943  return false;
2944  if (Right.is(tok::coloncolon) && Left.is(tok::identifier))
2945  // Generally don't remove existing spaces between an identifier and "::".
2946  // The identifier might actually be a macro name such as ALWAYS_INLINE. If
2947  // this turns out to be too lenient, add analysis of the identifier itself.
2948  return Right.WhitespaceRange.getBegin() != Right.WhitespaceRange.getEnd();
2949  if (Right.is(tok::coloncolon) && !Left.isOneOf(tok::l_brace, tok::comment))
2950  return (Left.is(TT_TemplateOpener) &&
2951  Style.Standard < FormatStyle::LS_Cpp11) ||
2952  !(Left.isOneOf(tok::l_paren, tok::r_paren, tok::l_square,
2953  tok::kw___super, TT_TemplateCloser,
2954  TT_TemplateOpener)) ||
2955  (Left.is(tok ::l_paren) && Style.SpacesInParentheses);
2956  if ((Left.is(TT_TemplateOpener)) != (Right.is(TT_TemplateCloser)))
2957  return Style.SpacesInAngles;
2958  // Space before TT_StructuredBindingLSquare.
2959  if (Right.is(TT_StructuredBindingLSquare))
2960  return !Left.isOneOf(tok::amp, tok::ampamp) ||
2961  Style.PointerAlignment != FormatStyle::PAS_Right;
2962  // Space before & or && following a TT_StructuredBindingLSquare.
2963  if (Right.Next && Right.Next->is(TT_StructuredBindingLSquare) &&
2964  Right.isOneOf(tok::amp, tok::ampamp))
2965  return Style.PointerAlignment != FormatStyle::PAS_Left;
2966  if ((Right.is(TT_BinaryOperator) && !Left.is(tok::l_paren)) ||
2967  (Left.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) &&
2968  !Right.is(tok::r_paren)))
2969  return true;
2970  if (Left.is(TT_TemplateCloser) && Right.is(tok::l_paren) &&
2971  Right.isNot(TT_FunctionTypeLParen))
2972  return spaceRequiredBeforeParens(Right);
2973  if (Right.is(TT_TemplateOpener) && Left.is(tok::r_paren) &&
2974  Left.MatchingParen && Left.MatchingParen->is(TT_OverloadedOperatorLParen))
2975  return false;
2976  if (Right.is(tok::less) && Left.isNot(tok::l_paren) &&
2977  Line.startsWith(tok::hash))
2978  return true;
2979  if (Right.is(TT_TrailingUnaryOperator))
2980  return false;
2981  if (Left.is(TT_RegexLiteral))
2982  return false;
2983  return spaceRequiredBetween(Line, Left, Right);
2984 }
2985 
2986 // Returns 'true' if 'Tok' is a brace we'd want to break before in Allman style.
2987 static bool isAllmanBrace(const FormatToken &Tok) {
2988  return Tok.is(tok::l_brace) && Tok.BlockKind == BK_Block &&
2989  !Tok.isOneOf(TT_ObjCBlockLBrace, TT_LambdaLBrace, TT_DictLiteral);
2990 }
2991 
2992 bool TokenAnnotator::mustBreakBefore(const AnnotatedLine &Line,
2993  const FormatToken &Right) {
2994  const FormatToken &Left = *Right.Previous;
2995  if (Right.NewlinesBefore > 1 && Style.MaxEmptyLinesToKeep > 0)
2996  return true;
2997 
2998  if (Style.Language == FormatStyle::LK_JavaScript) {
2999  // FIXME: This might apply to other languages and token kinds.
3000  if (Right.is(tok::string_literal) && Left.is(tok::plus) && Left.Previous &&
3001  Left.Previous->is(tok::string_literal))
3002  return true;
3003  if (Left.is(TT_DictLiteral) && Left.is(tok::l_brace) && Line.Level == 0 &&
3004  Left.Previous && Left.Previous->is(tok::equal) &&
3005  Line.First->isOneOf(tok::identifier, Keywords.kw_import, tok::kw_export,
3006  tok::kw_const) &&
3007  // kw_var/kw_let are pseudo-tokens that are tok::identifier, so match
3008  // above.
3009  !Line.First->isOneOf(Keywords.kw_var, Keywords.kw_let))
3010  // Object literals on the top level of a file are treated as "enum-style".
3011  // Each key/value pair is put on a separate line, instead of bin-packing.
3012  return true;
3013  if (Left.is(tok::l_brace) && Line.Level == 0 &&
3014  (Line.startsWith(tok::kw_enum) ||
3015  Line.startsWith(tok::kw_const, tok::kw_enum) ||
3016  Line.startsWith(tok::kw_export, tok::kw_enum) ||
3017  Line.startsWith(tok::kw_export, tok::kw_const, tok::kw_enum)))
3018  // JavaScript top-level enum key/value pairs are put on separate lines
3019  // instead of bin-packing.
3020  return true;
3021  if (Right.is(tok::r_brace) && Left.is(tok::l_brace) &&
3022  !Left.Children.empty())
3023  // Support AllowShortFunctionsOnASingleLine for JavaScript.
3024  return Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_None ||
3025  Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_Empty ||
3026  (Left.NestingLevel == 0 && Line.Level == 0 &&
3027  Style.AllowShortFunctionsOnASingleLine &
3028  FormatStyle::SFS_InlineOnly);
3029  } else if (Style.Language == FormatStyle::LK_Java) {
3030  if (Right.is(tok::plus) && Left.is(tok::string_literal) && Right.Next &&
3031  Right.Next->is(tok::string_literal))
3032  return true;
3033  } else if (Style.Language == FormatStyle::LK_Cpp ||
3034  Style.Language == FormatStyle::LK_ObjC ||
3035  Style.Language == FormatStyle::LK_Proto ||
3036  Style.Language == FormatStyle::LK_TableGen ||
3037  Style.Language == FormatStyle::LK_TextProto) {
3038  if (Left.isStringLiteral() && Right.isStringLiteral())
3039  return true;
3040  }
3041 
3042  // If the last token before a '}', ']', or ')' is a comma or a trailing
3043  // comment, the intention is to insert a line break after it in order to make
3044  // shuffling around entries easier. Import statements, especially in
3045  // JavaScript, can be an exception to this rule.
3046  if (Style.JavaScriptWrapImports || Line.Type != LT_ImportStatement) {
3047  const FormatToken *BeforeClosingBrace = nullptr;
3048  if ((Left.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) ||
3049  (Style.Language == FormatStyle::LK_JavaScript &&
3050  Left.is(tok::l_paren))) &&
3051  Left.BlockKind != BK_Block && Left.MatchingParen)
3052  BeforeClosingBrace = Left.MatchingParen->Previous;
3053  else if (Right.MatchingParen &&
3054  (Right.MatchingParen->isOneOf(tok::l_brace,
3055  TT_ArrayInitializerLSquare) ||
3056  (Style.Language == FormatStyle::LK_JavaScript &&
3057  Right.MatchingParen->is(tok::l_paren))))
3058  BeforeClosingBrace = &Left;
3059  if (BeforeClosingBrace && (BeforeClosingBrace->is(tok::comma) ||
3060  BeforeClosingBrace->isTrailingComment()))
3061  return true;
3062  }
3063 
3064  if (Right.is(tok::comment))
3065  return Left.BlockKind != BK_BracedInit &&
3066  Left.isNot(TT_CtorInitializerColon) &&
3067  (Right.NewlinesBefore > 0 && Right.HasUnescapedNewline);
3068  if (Left.isTrailingComment())
3069  return true;
3070  if (Right.Previous->IsUnterminatedLiteral)
3071  return true;
3072  if (Right.is(tok::lessless) && Right.Next &&
3073  Right.Previous->is(tok::string_literal) &&
3074  Right.Next->is(tok::string_literal))
3075  return true;
3076  if (Right.Previous->ClosesTemplateDeclaration &&
3077  Right.Previous->MatchingParen &&
3078  Right.Previous->MatchingParen->NestingLevel == 0 &&
3079  Style.AlwaysBreakTemplateDeclarations == FormatStyle::BTDS_Yes)
3080  return true;
3081  if (Right.is(TT_CtorInitializerComma) &&
3082  Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma &&
3083  !Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
3084  return true;
3085  if (Right.is(TT_CtorInitializerColon) &&
3086  Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma &&
3087  !Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
3088  return true;
3089  // Break only if we have multiple inheritance.
3090  if (Style.BreakInheritanceList == FormatStyle::BILS_BeforeComma &&
3091  Right.is(TT_InheritanceComma))
3092  return true;
3093  if (Right.is(tok::string_literal) && Right.TokenText.startswith("R\""))
3094  // Multiline raw string literals are special wrt. line breaks. The author
3095  // has made a deliberate choice and might have aligned the contents of the
3096  // string literal accordingly. Thus, we try keep existing line breaks.
3097  return Right.IsMultiline && Right.NewlinesBefore > 0;
3098  if ((Right.Previous->is(tok::l_brace) ||
3099  (Right.Previous->is(tok::less) && Right.Previous->Previous &&
3100  Right.Previous->Previous->is(tok::equal))) &&
3101  Right.NestingLevel == 1 && Style.Language == FormatStyle::LK_Proto) {
3102  // Don't put enums or option definitions onto single lines in protocol
3103  // buffers.
3104  return true;
3105  }
3106  if (Right.is(TT_InlineASMBrace))
3107  return Right.HasUnescapedNewline;
3108  if (isAllmanBrace(Left) || isAllmanBrace(Right))
3109  return (Line.startsWith(tok::kw_enum) && Style.BraceWrapping.AfterEnum) ||
3110  (Line.startsWith(tok::kw_typedef, tok::kw_enum) &&
3111  Style.BraceWrapping.AfterEnum) ||
3112  (Line.startsWith(tok::kw_class) && Style.BraceWrapping.AfterClass) ||
3113  (Line.startsWith(tok::kw_struct) && Style.BraceWrapping.AfterStruct);
3114  if (Left.is(TT_ObjCBlockLBrace) &&
3115  Style.AllowShortBlocksOnASingleLine == FormatStyle::SBS_Never)
3116  return true;
3117 
3118  if (Left.is(TT_LambdaLBrace)) {
3119  if (Left.MatchingParen && Left.MatchingParen->Next &&
3120  Left.MatchingParen->Next->isOneOf(tok::comma, tok::r_paren) &&
3121  Style.AllowShortLambdasOnASingleLine == FormatStyle::SLS_Inline)
3122  return false;
3123 
3124  if (Style.AllowShortLambdasOnASingleLine == FormatStyle::SLS_None ||
3125  Style.AllowShortLambdasOnASingleLine == FormatStyle::SLS_Inline ||
3126  (!Left.Children.empty() &&
3127  Style.AllowShortLambdasOnASingleLine == FormatStyle::SLS_Empty))
3128  return true;
3129  }
3130 
3131  // Put multiple C# attributes on a new line.
3132  if (Style.isCSharp() &&
3133  ((Left.is(TT_AttributeSquare) && Left.is(tok::r_square)) ||
3134  (Left.is(tok::r_square) && Right.is(TT_AttributeSquare) &&
3135  Right.is(tok::l_square))))
3136  return true;
3137 
3138  // Put multiple Java annotation on a new line.
3139  if ((Style.Language == FormatStyle::LK_Java ||
3140  Style.Language == FormatStyle::LK_JavaScript) &&
3141  Left.is(TT_LeadingJavaAnnotation) &&
3142  Right.isNot(TT_LeadingJavaAnnotation) && Right.isNot(tok::l_paren) &&
3143  (Line.Last->is(tok::l_brace) || Style.BreakAfterJavaFieldAnnotations))
3144  return true;
3145 
3146  if (Right.is(TT_ProtoExtensionLSquare))
3147  return true;
3148 
3149  // In text proto instances if a submessage contains at least 2 entries and at
3150  // least one of them is a submessage, like A { ... B { ... } ... },
3151  // put all of the entries of A on separate lines by forcing the selector of
3152  // the submessage B to be put on a newline.
3153  //
3154  // Example: these can stay on one line:
3155  // a { scalar_1: 1 scalar_2: 2 }
3156  // a { b { key: value } }
3157  //
3158  // and these entries need to be on a new line even if putting them all in one
3159  // line is under the column limit:
3160  // a {
3161  // scalar: 1
3162  // b { key: value }
3163  // }
3164  //
3165  // We enforce this by breaking before a submessage field that has previous
3166  // siblings, *and* breaking before a field that follows a submessage field.
3167  //
3168  // Be careful to exclude the case [proto.ext] { ... } since the `]` is
3169  // the TT_SelectorName there, but we don't want to break inside the brackets.
3170  //
3171  // Another edge case is @submessage { key: value }, which is a common
3172  // substitution placeholder. In this case we want to keep `@` and `submessage`
3173  // together.
3174  //
3175  // We ensure elsewhere that extensions are always on their own line.
3176  if ((Style.Language == FormatStyle::LK_Proto ||
3177  Style.Language == FormatStyle::LK_TextProto) &&
3178  Right.is(TT_SelectorName) && !Right.is(tok::r_square) && Right.Next) {
3179  // Keep `@submessage` together in:
3180  // @submessage { key: value }
3181  if (Right.Previous && Right.Previous->is(tok::at))
3182  return false;
3183  // Look for the scope opener after selector in cases like:
3184  // selector { ...
3185  // selector: { ...
3186  // selector: @base { ...
3187  FormatToken *LBrace = Right.Next;
3188  if (LBrace && LBrace->is(tok::colon)) {
3189  LBrace = LBrace->Next;
3190  if (LBrace && LBrace->is(tok::at)) {
3191  LBrace = LBrace->Next;
3192  if (LBrace)
3193  LBrace = LBrace->Next;
3194  }
3195  }
3196  if (LBrace &&
3197  // The scope opener is one of {, [, <:
3198  // selector { ... }
3199  // selector [ ... ]
3200  // selector < ... >
3201  //
3202  // In case of selector { ... }, the l_brace is TT_DictLiteral.
3203  // In case of an empty selector {}, the l_brace is not TT_DictLiteral,
3204  // so we check for immediately following r_brace.
3205  ((LBrace->is(tok::l_brace) &&
3206  (LBrace->is(TT_DictLiteral) ||
3207  (LBrace->Next && LBrace->Next->is(tok::r_brace)))) ||
3208  LBrace->is(TT_ArrayInitializerLSquare) || LBrace->is(tok::less))) {
3209  // If Left.ParameterCount is 0, then this submessage entry is not the
3210  // first in its parent submessage, and we want to break before this entry.
3211  // If Left.ParameterCount is greater than 0, then its parent submessage
3212  // might contain 1 or more entries and we want to break before this entry
3213  // if it contains at least 2 entries. We deal with this case later by
3214  // detecting and breaking before the next entry in the parent submessage.
3215  if (Left.ParameterCount == 0)
3216  return true;
3217  // However, if this submessage is the first entry in its parent
3218  // submessage, Left.ParameterCount might be 1 in some cases.
3219  // We deal with this case later by detecting an entry
3220  // following a closing paren of this submessage.
3221  }
3222 
3223  // If this is an entry immediately following a submessage, it will be
3224  // preceded by a closing paren of that submessage, like in:
3225  // left---. .---right
3226  // v v
3227  // sub: { ... } key: value
3228  // If there was a comment between `}` an `key` above, then `key` would be
3229  // put on a new line anyways.
3230  if (Left.isOneOf(tok::r_brace, tok::greater, tok::r_square))
3231  return true;
3232  }
3233 
3234  // Deal with lambda arguments in C++ - we want consistent line breaks whether
3235  // they happen to be at arg0, arg1 or argN. The selection is a bit nuanced
3236  // as aggressive line breaks are placed when the lambda is not the last arg.
3237  if ((Style.Language == FormatStyle::LK_Cpp ||
3238  Style.Language == FormatStyle::LK_ObjC) &&
3239  Left.is(tok::l_paren) && Left.BlockParameterCount > 0 &&
3240  !Right.isOneOf(tok::l_paren, TT_LambdaLSquare)) {
3241  // Multiple lambdas in the same function call force line breaks.
3242  if (Left.BlockParameterCount > 1)
3243  return true;
3244 
3245  // A lambda followed by another arg forces a line break.
3246  if (!Left.Role)
3247  return false;
3248  auto Comma = Left.Role->lastComma();
3249  if (!Comma)
3250  return false;
3251  auto Next = Comma->getNextNonComment();
3252  if (!Next)
3253  return false;
3254  if (!Next->isOneOf(TT_LambdaLSquare, tok::l_brace, tok::caret))
3255  return true;
3256  }
3257 
3258  return false;
3259 }
3260 
3261 bool TokenAnnotator::canBreakBefore(const AnnotatedLine &Line,
3262  const FormatToken &Right) {
3263  const FormatToken &Left = *Right.Previous;
3264 
3265  // Language-specific stuff.
3266  if (Style.Language == FormatStyle::LK_Java) {
3267  if (Left.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
3268  Keywords.kw_implements))
3269  return false;
3270  if (Right.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
3271  Keywords.kw_implements))
3272  return true;
3273  } else if (Style.Language == FormatStyle::LK_JavaScript) {
3274  const FormatToken *NonComment = Right.getPreviousNonComment();
3275  if (NonComment &&
3276  NonComment->isOneOf(
3277  tok::kw_return, Keywords.kw_yield, tok::kw_continue, tok::kw_break,
3278  tok::kw_throw, Keywords.kw_interface, Keywords.kw_type,
3279  tok::kw_static, tok::kw_public, tok::kw_private, tok::kw_protected,
3280  Keywords.kw_readonly, Keywords.kw_abstract, Keywords.kw_get,
3281  Keywords.kw_set, Keywords.kw_async, Keywords.kw_await))
3282  return false; // Otherwise automatic semicolon insertion would trigger.
3283  if (Right.NestingLevel == 0 &&
3284  (Left.Tok.getIdentifierInfo() ||
3285  Left.isOneOf(tok::r_square, tok::r_paren)) &&
3286  Right.isOneOf(tok::l_square, tok::l_paren))
3287  return false; // Otherwise automatic semicolon insertion would trigger.
3288  if (Left.is(TT_JsFatArrow) && Right.is(tok::l_brace))
3289  return false;
3290  if (Left.is(TT_JsTypeColon))
3291  return true;
3292  // Don't wrap between ":" and "!" of a strict prop init ("field!: type;").
3293  if (Left.is(tok::exclaim) && Right.is(tok::colon))
3294  return false;
3295  // Look for is type annotations like:
3296  // function f(): a is B { ... }
3297  // Do not break before is in these cases.
3298  if (Right.is(Keywords.kw_is)) {
3299  const FormatToken *Next = Right.getNextNonComment();
3300  // If `is` is followed by a colon, it's likely that it's a dict key, so
3301  // ignore it for this check.
3302  // For example this is common in Polymer:
3303  // Polymer({
3304  // is: 'name',
3305  // ...
3306  // });
3307  if (!Next || !Next->is(tok::colon))
3308  return false;
3309  }
3310  if (Left.is(Keywords.kw_in))
3311  return Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None;
3312  if (Right.is(Keywords.kw_in))
3313  return Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None;
3314  if (Right.is(Keywords.kw_as))
3315  return false; // must not break before as in 'x as type' casts
3316  if (Right.isOneOf(Keywords.kw_extends, Keywords.kw_infer)) {
3317  // extends and infer can appear as keywords in conditional types:
3318  // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#conditional-types
3319  // do not break before them, as the expressions are subject to ASI.
3320  return false;
3321  }
3322  if (Left.is(Keywords.kw_as))
3323  return true;
3324  if (Left.is(TT_JsNonNullAssertion))
3325  return true;
3326  if (Left.is(Keywords.kw_declare) &&
3327  Right.isOneOf(Keywords.kw_module, tok::kw_namespace,
3328  Keywords.kw_function, tok::kw_class, tok::kw_enum,
3329  Keywords.kw_interface, Keywords.kw_type, Keywords.kw_var,
3330  Keywords.kw_let, tok::kw_const))
3331  // See grammar for 'declare' statements at:
3332  // https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md#A.10
3333  return false;
3334  if (Left.isOneOf(Keywords.kw_module, tok::kw_namespace) &&
3335  Right.isOneOf(tok::identifier, tok::string_literal))
3336  return false; // must not break in "module foo { ...}"
3337  if (Right.is(TT_TemplateString) && Right.closesScope())
3338  return false;
3339  // Don't split tagged template literal so there is a break between the tag
3340  // identifier and template string.
3341  if (Left.is(tok::identifier) && Right.is(TT_TemplateString)) {
3342  return false;
3343  }
3344  if (Left.is(TT_TemplateString) && Left.opensScope())
3345  return true;
3346  }
3347 
3348  if (Left.is(tok::at))
3349  return false;
3350  if (Left.Tok.getObjCKeywordID() == tok::objc_interface)
3351  return false;
3352  if (Left.isOneOf(TT_JavaAnnotation, TT_LeadingJavaAnnotation))
3353  return !Right.is(tok::l_paren);
3354  if (Right.is(TT_PointerOrReference))
3355  return Line.IsMultiVariableDeclStmt ||
3356  (Style.PointerAlignment == FormatStyle::PAS_Right &&
3357  (!Right.Next || Right.Next->isNot(TT_FunctionDeclarationName)));
3358  if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
3359  Right.is(tok::kw_operator))
3360  return true;
3361  if (Left.is(TT_PointerOrReference))
3362  return false;
3363  if (Right.isTrailingComment())
3364  // We rely on MustBreakBefore being set correctly here as we should not
3365  // change the "binding" behavior of a comment.
3366  // The first comment in a braced lists is always interpreted as belonging to
3367  // the first list element. Otherwise, it should be placed outside of the
3368  // list.
3369  return Left.BlockKind == BK_BracedInit ||
3370  (Left.is(TT_CtorInitializerColon) &&
3371  Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon);
3372  if (Left.is(tok::question) && Right.is(tok::colon))
3373  return false;
3374  if (Right.is(TT_ConditionalExpr) || Right.is(tok::question))
3375  return Style.BreakBeforeTernaryOperators;
3376  if (Left.is(TT_ConditionalExpr) || Left.is(tok::question))
3377  return !Style.BreakBeforeTernaryOperators;
3378  if (Left.is(TT_InheritanceColon))
3379  return Style.BreakInheritanceList == FormatStyle::BILS_AfterColon;
3380  if (Right.is(TT_InheritanceColon))
3381  return Style.BreakInheritanceList != FormatStyle::BILS_AfterColon;
3382  if (Right.is(TT_ObjCMethodExpr) && !Right.is(tok::r_square) &&
3383  Left.isNot(TT_SelectorName))
3384  return true;
3385 
3386  if (Right.is(tok::colon) &&
3387  !Right.isOneOf(TT_CtorInitializerColon, TT_InlineASMColon))
3388  return false;
3389  if (Left.is(tok::colon) && Left.isOneOf(TT_DictLiteral, TT_ObjCMethodExpr)) {
3390  if (Style.Language == FormatStyle::LK_Proto ||
3391  Style.Language == FormatStyle::LK_TextProto) {
3392  if (!Style.AlwaysBreakBeforeMultilineStrings && Right.isStringLiteral())
3393  return false;
3394  // Prevent cases like:
3395  //
3396  // submessage:
3397  // { key: valueeeeeeeeeeee }
3398  //
3399  // when the snippet does not fit into one line.
3400  // Prefer:
3401  //
3402  // submessage: {
3403  // key: valueeeeeeeeeeee
3404  // }
3405  //
3406  // instead, even if it is longer by one line.
3407  //
3408  // Note that this allows allows the "{" to go over the column limit
3409  // when the column limit is just between ":" and "{", but that does
3410  // not happen too often and alternative formattings in this case are
3411  // not much better.
3412  //
3413  // The code covers the cases:
3414  //
3415  // submessage: { ... }
3416  // submessage: < ... >
3417  // repeated: [ ... ]
3418  if (((Right.is(tok::l_brace) || Right.is(tok::less)) &&
3419  Right.is(TT_DictLiteral)) ||
3420  Right.is(TT_ArrayInitializerLSquare))
3421  return false;
3422  }
3423  return true;
3424  }
3425  if (Right.is(tok::r_square) && Right.MatchingParen &&
3426  Right.MatchingParen->is(TT_ProtoExtensionLSquare))
3427  return false;
3428  if (Right.is(TT_SelectorName) || (Right.is(tok::identifier) && Right.Next &&
3429  Right.Next->is(TT_ObjCMethodExpr)))
3430  return Left.isNot(tok::period); // FIXME: Properly parse ObjC calls.
3431  if (Left.is(tok::r_paren) && Line.Type == LT_ObjCProperty)
3432  return true;
3433  if (Left.ClosesTemplateDeclaration || Left.is(TT_FunctionAnnotationRParen))
3434  return true;
3435  if (Right.isOneOf(TT_RangeBasedForLoopColon, TT_OverloadedOperatorLParen,
3436  TT_OverloadedOperator))
3437  return false;
3438  if (Left.is(TT_RangeBasedForLoopColon))
3439  return true;
3440  if (Right.is(TT_RangeBasedForLoopColon))
3441  return false;
3442  if (Left.is(TT_TemplateCloser) && Right.is(TT_TemplateOpener))
3443  return true;
3444  if (Left.isOneOf(TT_TemplateCloser, TT_UnaryOperator) ||
3445  Left.is(tok::kw_operator))
3446  return false;
3447  if (Left.is(tok::equal) && !Right.isOneOf(tok::kw_default, tok::kw_delete) &&
3448  Line.Type == LT_VirtualFunctionDecl && Left.NestingLevel == 0)
3449  return false;
3450  if (Left.is(tok::equal) && Right.is(tok::l_brace) &&
3451  !Style.Cpp11BracedListStyle)
3452  return false;
3453  if (Left.is(tok::l_paren) && Left.is(TT_AttributeParen))
3454  return false;
3455  if (Left.is(tok::l_paren) && Left.Previous &&
3456  (Left.Previous->isOneOf(TT_BinaryOperator, TT_CastRParen)))
3457  return false;
3458  if (Right.is(TT_ImplicitStringLiteral))
3459  return false;
3460 
3461  if (Right.is(tok::r_paren) || Right.is(TT_TemplateCloser))
3462  return false;
3463  if (Right.is(tok::r_square) && Right.MatchingParen &&
3464  Right.MatchingParen->is(TT_LambdaLSquare))
3465  return false;
3466 
3467  // We only break before r_brace if there was a corresponding break before
3468  // the l_brace, which is tracked by BreakBeforeClosingBrace.
3469  if (Right.is(tok::r_brace))
3470  return Right.MatchingParen && Right.MatchingParen->BlockKind == BK_Block;
3471 
3472  // Allow breaking after a trailing annotation, e.g. after a method
3473  // declaration.
3474  if (Left.is(TT_TrailingAnnotation))
3475  return !Right.isOneOf(tok::l_brace, tok::semi, tok::equal, tok::l_paren,
3476  tok::less, tok::coloncolon);
3477 
3478  if (Right.is(tok::kw___attribute) ||
3479  (Right.is(tok::l_square) && Right.is(TT_AttributeSquare)))
3480  return true;
3481 
3482  if (Left.is(tok::identifier) && Right.is(tok::string_literal))
3483  return true;
3484 
3485  if (Right.is(tok::identifier) && Right.Next && Right.Next->is(TT_DictLiteral))
3486  return true;
3487 
3488  if (Left.is(TT_CtorInitializerColon))
3489  return Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon;
3490  if (Right.is(TT_CtorInitializerColon))
3491  return Style.BreakConstructorInitializers != FormatStyle::BCIS_AfterColon;
3492  if (Left.is(TT_CtorInitializerComma) &&
3493  Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma)
3494  return false;
3495  if (Right.is(TT_CtorInitializerComma) &&
3496  Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma)
3497  return true;
3498  if (Left.is(TT_InheritanceComma) &&
3499  Style.BreakInheritanceList == FormatStyle::BILS_BeforeComma)
3500  return false;
3501  if (Right.is(TT_InheritanceComma) &&
3502  Style.BreakInheritanceList == FormatStyle::BILS_BeforeComma)
3503  return true;
3504  if ((Left.is(tok::greater) && Right.is(tok::greater)) ||
3505  (Left.is(tok::less) && Right.is(tok::less)))
3506  return false;
3507  if (Right.is(TT_BinaryOperator) &&
3508  Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None &&
3509  (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_All ||
3510  Right.getPrecedence() != prec::Assignment))
3511  return true;
3512  if (Left.is(TT_ArrayInitializerLSquare))
3513  return true;
3514  if (Right.is(tok::kw_typename) && Left.isNot(tok::kw_const))
3515  return true;
3516  if ((Left.isBinaryOperator() || Left.is(TT_BinaryOperator)) &&
3517  !Left.isOneOf(tok::arrowstar, tok::lessless) &&
3518  Style.BreakBeforeBinaryOperators != FormatStyle::BOS_All &&
3519  (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None ||
3520  Left.getPrecedence() == prec::Assignment))
3521  return true;
3522  if ((Left.is(TT_AttributeSquare) && Right.is(tok::l_square)) ||
3523  (Left.is(tok::r_square) && Right.is(TT_AttributeSquare)))
3524  return false;
3525  return Left.isOneOf(tok::comma, tok::coloncolon, tok::semi, tok::l_brace,
3526  tok::kw_class, tok::kw_struct, tok::comment) ||
3527  Right.isMemberAccess() ||
3528  Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow, tok::lessless,
3529  tok::colon, tok::l_square, tok::at) ||
3530  (Left.is(tok::r_paren) &&
3531  Right.isOneOf(tok::identifier, tok::kw_const)) ||
3532  (Left.is(tok::l_paren) && !Right.is(tok::r_paren)) ||
3533  (Left.is(TT_TemplateOpener) && !Right.is(TT_TemplateCloser));
3534 }
3535 
3536 void TokenAnnotator::printDebugInfo(const AnnotatedLine &Line) {
3537  llvm::errs() << "AnnotatedTokens(L=" << Line.Level << "):\n";
3538  const FormatToken *Tok = Line.First;
3539  while (Tok) {
3540  llvm::errs() << " M=" << Tok->MustBreakBefore
3541  << " C=" << Tok->CanBreakBefore
3542  << " T=" << getTokenTypeName(Tok->Type)
3543  << " S=" << Tok->SpacesRequiredBefore
3544  << " B=" << Tok->BlockParameterCount
3545  << " BK=" << Tok->BlockKind << " P=" << Tok->SplitPenalty
3546  << " Name=" << Tok->Tok.getName() << " L=" << Tok->TotalLength
3547  << " PPK=" << Tok->PackingKind << " FakeLParens=";
3548  for (unsigned i = 0, e = Tok->FakeLParens.size(); i != e; ++i)
3549  llvm::errs() << Tok->FakeLParens[i] << "/";
3550  llvm::errs() << " FakeRParens=" << Tok->FakeRParens;
3551  llvm::errs() << " II=" << Tok->Tok.getIdentifierInfo();
3552  llvm::errs() << " Text='" << Tok->TokenText << "'\n";
3553  if (!Tok->Next)
3554  assert(Tok == Line.Last);
3555  Tok = Tok->Next;
3556  }
3557  llvm::errs() << "----\n";
3558 }
3559 
3560 } // namespace format
3561 } // namespace clang
bool endsSequence(A K1, Ts... Tokens) const
true if this token ends a sequence with the given tokens in order, following the Previous pointers...
Definition: FormatToken.h:357
if(T->getSizeExpr()) TRY_TO(TraverseStmt(T -> getSizeExpr()))
unsigned NestingLevel
The nesting level of this token, i.e.
Definition: FormatToken.h:233
Token Tok
The Token.
Definition: FormatToken.h:133
bool is(tok::TokenKind K) const
is/isNot - Predicates to check if this token is a specific kind, as in "if (Tok.is(tok::l_brace)) {...
Definition: Token.h:97
Defines the SourceManager interface.
std::unique_ptr< TokenRole > Role
A token can have a special role that can carry extra information about the token&#39;s formatting...
Definition: FormatToken.h:209
unsigned OriginalColumn
The original 0-based column of this token, including expanded tabs.
Definition: FormatToken.h:220
static LLVM_ATTRIBUTE_UNUSED void printDebugInfo(const UnwrappedLine &Line, StringRef Prefix="")
bool isMemberAccess() const
Returns true if this is a "." or "->" accessing a member.
Definition: FormatToken.h:405
bool isFunctionLikeKeyword() const
Returns true if this is a keyword that can be used like a function call (e.g.
Definition: FormatToken.h:439
const FormatToken * getNextNonComment() const
Returns the next token ignoring comments.
Definition: FormatToken.h:495
Parser - This implements a parser for the C family of languages.
Definition: Parser.h:57
bool IsMultiline
Whether the token text contains newlines (escaped or not).
Definition: FormatToken.h:162
unsigned TotalLength
The total length of the unwrapped line up to and including this token.
Definition: FormatToken.h:216
bool isBinaryOperator() const
Definition: FormatToken.h:427
bool isIf(bool AllowConstexprMacro=true) const
Definition: FormatToken.h:330
unsigned NewlinesBefore
The number of newlines immediately before the Token.
Definition: FormatToken.h:139
FormatToken * Next
The next token in the unwrapped line.
Definition: FormatToken.h:298
bool isLiteral() const
Return true if this is a "literal", like a numeric constant, string, etc.
Definition: Token.h:115
bool CanBeExpression
tok::TokenKind ContextKind
unsigned UnbreakableTailLength
The length of following tokens until the next natural split point, or the next token that can be brok...
Definition: FormatToken.h:224
bool closesScope() const
Returns whether Tok is )]} or a closing > of a template or in protos.
Definition: FormatToken.h:395
unsigned SplitPenalty
Penalty for inserting a line break before this token.
Definition: FormatToken.h:239
bool ColonIsForRangeExpr
prec::Level getPrecedence() const
Definition: FormatToken.h:481
unsigned ParameterCount
Number of parameters, if this is "(", "[" or "<".
Definition: FormatToken.h:197
unsigned FakeRParens
Insert this many fake ) after this token for correct indentation.
Definition: FormatToken.h:265
bool CanBreakBefore
true if it is allowed to break before this token.
Definition: FormatToken.h:191
FormatToken * Previous
The previous token in the unwrapped line.
Definition: FormatToken.h:295
This file implements a token annotator, i.e.
__DEVICE__ int max(int __a, int __b)
unsigned OperatorIndex
If this is an operator (or "."/"->") in a sequence of operators with the same precedence, contains the 0-based operator index.
Definition: FormatToken.h:275
unsigned SpacesRequiredBefore
The number of spaces that should be inserted before this token.
Definition: FormatToken.h:188
bool isNot(T Kind) const
Definition: FormatToken.h:328
const FormatToken & Tok
unsigned BlockParameterCount
Number of parameters that are nested blocks, if this is "(", "[" or "<".
Definition: FormatToken.h:201
bool InCSharpAttributeSpecifier
bool InInheritanceList
const char * getName() const
Definition: Token.h:168
bool mightBeFunctionDefinition() const
true if this line looks like a function definition instead of a function declaration.
FormatToken * getPreviousNonComment() const
Returns the previous token ignoring comments.
Definition: FormatToken.h:487
AnnotatingParser & P
BracketAlignmentStyle AlignAfterOpenBracket
If true, horizontally aligns arguments after an open bracket.
Definition: Format.h:80
NodeId Parent
Definition: ASTDiff.cpp:191
bool isLabelString() const
Returns true if this is a string literal that&#39;s like a label, e.g.
Definition: FormatToken.h:459
bool isOneOf(A K1, B K2) const
Definition: FormatToken.h:321
const AnnotatedLine * Line
StateNode * Previous
SmallVector< AnnotatedLine *, 0 > Children
ParameterPackingKind PackingKind
If this is an opening parenthesis, how are the parameters packed?
Definition: FormatToken.h:212
A wrapper around a Token storing information about the whitespace characters preceding it...
Definition: FormatToken.h:129
void setCommentLineLevels(SmallVectorImpl< AnnotatedLine *> &Lines)
Adapts the indent levels of comment lines to the indent of the subsequent line.
static unsigned maxNestingDepth(const AnnotatedLine &Line)
FormatToken * FirstStartOfName
SourceLocation getEnd() const
bool isTrailingComment() const
Definition: FormatToken.h:432
void annotate(AnnotatedLine &Line)
Don&#39;t align, instead use ContinuationIndentWidth, e.g.
Definition: Format.h:66
const char * getTokenTypeName(TokenType Type)
Determines the name of a token type.
Definition: FormatToken.cpp:24
static bool isAllmanBrace(const FormatToken &Tok)
bool is(tok::TokenKind Kind) const
Definition: FormatToken.h:312
bool InCpp11AttributeSpecifier
IdentifierInfo * getIdentifierInfo() const
Definition: Token.h:179
SourceRange WhitespaceRange
The range of the whitespace immediately preceding the Token.
Definition: FormatToken.h:146
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
Definition: TokenKinds.h:24
bool IsUnterminatedLiteral
Set to true if this token is an unterminated literal.
Definition: FormatToken.h:180
bool startsWith(Ts... Tokens) const
true if this line starts with the given tokens in order, ignoring comments.
StringRef TokenText
The raw text of the token.
Definition: FormatToken.h:177
SmallVector< prec::Level, 4 > FakeLParens
Stores the number of required fake parentheses and the corresponding operator precedence.
Definition: FormatToken.h:263
tok::ObjCKeywordKind getObjCKeywordID() const
Return the ObjC keyword kind.
Definition: Lexer.cpp:66
bool isSimpleTypeSpecifier() const
Determine whether the token is a simple-type-specifier.
Definition: FormatToken.cpp:39
The FormatStyle is used to configure the formatting to follow specific guidelines.
Definition: Format.h:49
unsigned IndentLevel
The indent level of this token. Copied from the surrounding line.
Definition: FormatToken.h:236
Optional< types::ID > Type
bool ColonIsObjCMethodExpr
Dataflow Directional Tag Classes.
unsigned ColumnWidth
The width of the non-whitespace parts of the token (or its first line for multi-line tokens) in colum...
Definition: FormatToken.h:155
bool IsExpression
static bool isFunctionDeclarationName(const FormatToken &Current, const AnnotatedLine &Line)
void calculateFormattingInformation(AnnotatedLine &Line)
FormatToken * NextOperator
If this is an operator (or "."/"->") in a sequence of operators with the same precedence, points to the next operator.
Definition: FormatToken.h:279
Defines the clang::TokenKind enum and support functions.
unsigned BindingStrength
bool ClosesTemplateDeclaration
true if this is the ">" of "template<..>".
Definition: FormatToken.h:194
FormatToken * MatchingParen
If this is a bracket, this points to the matching one.
Definition: FormatToken.h:292
SmallVector< AnnotatedLine *, 1 > Children
If this token starts a block, this contains all the unwrapped lines in it.
Definition: FormatToken.h:302
FormatToken * FirstObjCSelectorName
bool InTemplateArgument
bool ColonIsDictLiteral
The parameter type of a method or function.
bool opensBlockOrBlockTypeList(const FormatStyle &Style) const
Returns true if this tokens starts a block-type list, i.e.
Definition: FormatToken.h:504
bool opensScope() const
Returns whether Tok is ([{ or an opening < of a template or in protos.
Definition: FormatToken.h:385
unsigned LongestObjCSelectorName
bool MustBreakBefore
Whether there must be a line break before this token.
Definition: FormatToken.h:171
This file contains the declaration of the FormatToken, a wrapper around Token with additional informa...
prec::Level getBinOpPrecedence(tok::TokenKind Kind, bool GreaterThanIsOperator, bool CPlusPlus11)
Return the precedence of the specified binary operator token.
unsigned BindingStrength
The binding strength of a token.
Definition: FormatToken.h:229
bool CaretFound
bool InCtorInitializer
bool isStringLiteral() const
Definition: FormatToken.h:361
SourceLocation getBegin() const
bool HasUnescapedNewline
Whether there is at least one unescaped newline before the Token.
Definition: FormatToken.h:143
BraceBlockKind BlockKind
Contains the kind of block if this token is a brace.
Definition: FormatToken.h:183
bool PartOfMultiVariableDeclStmt
Is this token part of a DeclStmt defining multiple variables?
Definition: FormatToken.h:284
unsigned ParameterIndex
The 0-based index of the parameter/argument.
Definition: FormatToken.h:256
bool IsForEachMacro
const FormatStyle & Style