blob: 5273791114b94c74d60ae9cdd2990847761b7603 [file] [log] [blame]
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001//===--- TokenAnnotator.cpp - Format C++ code -----------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// \brief This file implements a token annotator, i.e. creates
12/// \c AnnotatedTokens out of \c FormatTokens with required extra information.
13///
14//===----------------------------------------------------------------------===//
15
16#include "TokenAnnotator.h"
17#include "clang/Basic/SourceManager.h"
Daniel Jasper4d9ec172015-05-06 08:38:24 +000018#include "llvm/ADT/SmallPtrSet.h"
Daniel Jasper6bee6822013-04-08 20:33:42 +000019#include "llvm/Support/Debug.h"
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000020
Chandler Carruth57f5fbe2014-04-21 22:55:36 +000021#define DEBUG_TYPE "format-token-annotator"
22
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000023namespace clang {
24namespace format {
25
Craig Topper318ed7c2013-07-01 04:03:19 +000026namespace {
27
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000028/// \brief A parser that gathers additional information about tokens.
29///
Alexander Kornienkoa5151272013-03-12 16:28:18 +000030/// The \c TokenAnnotator tries to match parenthesis and square brakets and
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000031/// store a parenthesis levels. It also tries to resolve matching "<" and ">"
32/// into template parameter lists.
33class AnnotatingParser {
34public:
Daniel Jasper8de9ed02013-08-22 15:00:41 +000035 AnnotatingParser(const FormatStyle &Style, AnnotatedLine &Line,
Daniel Jasperd0ec0d62014-11-04 12:41:02 +000036 const AdditionalKeywords &Keywords)
Daniel Jasper616de8642014-11-23 16:46:28 +000037 : Style(Style), Line(Line), CurrentToken(Line.First), AutoFound(false),
38 Keywords(Keywords) {
Nico Weber9096fc02013-06-26 00:30:14 +000039 Contexts.push_back(Context(tok::unknown, 1, /*IsExpression=*/false));
Manuel Klimek819788d2014-03-18 11:22:45 +000040 resetTokenMetadata(CurrentToken);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000041 }
42
Nico Weber44449172013-02-12 16:17:07 +000043private:
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000044 bool parseAngle() {
Daniel Jasper0c9772e2016-02-05 14:17:16 +000045 if (!CurrentToken || !CurrentToken->Previous)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000046 return false;
Daniel Jasper0c9772e2016-02-05 14:17:16 +000047 if (NonTemplateLess.count(CurrentToken->Previous))
48 return false;
49
50 const FormatToken& Previous = *CurrentToken->Previous;
51 if (Previous.Previous) {
52 if (Previous.Previous->Tok.isLiteral())
53 return false;
54 if (Previous.Previous->is(tok::r_paren) && Contexts.size() > 1 &&
55 (!Previous.Previous->MatchingParen ||
56 !Previous.Previous->MatchingParen->is(TT_OverloadedOperatorLParen)))
57 return false;
58 }
59
Manuel Klimek6e6310e2013-05-29 14:47:47 +000060 FormatToken *Left = CurrentToken->Previous;
Daniel Jasperde7ca752015-05-04 07:39:00 +000061 Left->ParentBracket = Contexts.back().ContextKind;
Daniel Jasper88db7602016-02-11 06:43:01 +000062 ScopedContextCreator ContextCreator(*this, tok::less, 12);
Daniel Jasper112b50e2015-05-06 14:53:50 +000063
64 // If this angle is in the context of an expression, we need to be more
Daniel Jasper9c950132015-05-07 14:19:59 +000065 // hesitant to detect it as opening template parameters.
Daniel Jasper112b50e2015-05-06 14:53:50 +000066 bool InExprContext = Contexts.back().IsExpression;
67
Daniel Jasperc697ad22013-02-06 10:05:46 +000068 Contexts.back().IsExpression = false;
Manuel Klimekf81e5c02014-03-27 11:17:36 +000069 // If there's a template keyword before the opening angle bracket, this is a
70 // template parameter, not an argument.
71 Contexts.back().InTemplateArgument =
Craig Topper2145bc02014-05-09 08:15:10 +000072 Left->Previous && Left->Previous->Tok.isNot(tok::kw_template);
Manuel Klimekf81e5c02014-03-27 11:17:36 +000073
Daniel Jasper16b107e2014-10-21 09:57:09 +000074 if (Style.Language == FormatStyle::LK_Java &&
75 CurrentToken->is(tok::question))
76 next();
77
Craig Topper2145bc02014-05-09 08:15:10 +000078 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000079 if (CurrentToken->is(tok::greater)) {
80 Left->MatchingParen = CurrentToken;
81 CurrentToken->MatchingParen = Left;
82 CurrentToken->Type = TT_TemplateCloser;
83 next();
84 return true;
85 }
Daniel Jasper7bd618f2014-11-02 21:52:57 +000086 if (CurrentToken->is(tok::question) &&
Daniel Jasper61d81972014-11-14 08:22:46 +000087 Style.Language == FormatStyle::LK_Java) {
88 next();
89 continue;
90 }
Daniel Jasper112b50e2015-05-06 14:53:50 +000091 if (CurrentToken->isOneOf(tok::r_paren, tok::r_square, tok::r_brace) ||
92 (CurrentToken->isOneOf(tok::colon, tok::question) && InExprContext))
Daniel Jasper6f05e592013-05-15 13:46:48 +000093 return false;
Daniel Jasperd5893912013-06-01 18:56:00 +000094 // If a && or || is found and interpreted as a binary operator, this set
Daniel Jasper1027c6e2013-06-03 16:16:41 +000095 // of angles is likely part of something like "a < b && c > d". If the
Daniel Jasperd5893912013-06-01 18:56:00 +000096 // angles are inside an expression, the ||/&& might also be a binary
97 // operator that was misinterpreted because we are parsing template
98 // parameters.
99 // FIXME: This is getting out of hand, write a decent parser.
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000100 if (CurrentToken->Previous->isOneOf(tok::pipepipe, tok::ampamp) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000101 CurrentToken->Previous->is(TT_BinaryOperator) &&
Daniel Jasper6ba16382014-07-28 13:19:58 +0000102 Contexts[Contexts.size() - 2].IsExpression &&
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000103 !Line.startsWith(tok::kw_template))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000104 return false;
Daniel Jaspere11095a2013-02-14 15:01:34 +0000105 updateParameterCount(Left, CurrentToken);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000106 if (!consumeToken())
107 return false;
108 }
109 return false;
110 }
111
112 bool parseParens(bool LookForDecls = false) {
Craig Topper2145bc02014-05-09 08:15:10 +0000113 if (!CurrentToken)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000114 return false;
Daniel Jasperde7ca752015-05-04 07:39:00 +0000115 FormatToken *Left = CurrentToken->Previous;
116 Left->ParentBracket = Contexts.back().ContextKind;
Daniel Jasper40aacf42013-03-14 13:45:21 +0000117 ScopedContextCreator ContextCreator(*this, tok::l_paren, 1);
Daniel Jasperc697ad22013-02-06 10:05:46 +0000118
119 // FIXME: This is a bit of a hack. Do better.
120 Contexts.back().ColonIsForRangeExpr =
121 Contexts.size() == 2 && Contexts[0].ColonIsForRangeExpr;
122
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000123 bool StartsObjCMethodExpr = false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000124 if (CurrentToken->is(tok::caret)) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000125 // (^ can start a block type.
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000126 Left->Type = TT_ObjCBlockLParen;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000127 } else if (FormatToken *MaybeSel = Left->Previous) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000128 // @selector( starts a selector.
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000129 if (MaybeSel->isObjCAtKeyword(tok::objc_selector) && MaybeSel->Previous &&
130 MaybeSel->Previous->is(tok::at)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000131 StartsObjCMethodExpr = true;
132 }
133 }
134
Daniel Jasperdf51f2e62016-01-11 12:55:33 +0000135 if (Left->is(TT_OverloadedOperatorLParen)) {
136 Contexts.back().IsExpression = false;
Martin Probst1b7f9802016-06-23 19:52:32 +0000137 } else if (Style.Language == FormatStyle::LK_JavaScript &&
138 Line.startsWith(Keywords.kw_type, tok::identifier)) {
139 // type X = (...);
140 Contexts.back().IsExpression = false;
Daniel Jasperdf51f2e62016-01-11 12:55:33 +0000141 } else if (Left->Previous &&
Daniel Jasper033181b2015-08-13 13:43:51 +0000142 (Left->Previous->isOneOf(tok::kw_static_assert, tok::kw_decltype,
143 tok::kw_if, tok::kw_while, tok::l_paren,
144 tok::comma) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000145 Left->Previous->is(TT_BinaryOperator))) {
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000146 // static_assert, if and while usually contain expressions.
Daniel Jasper8b1c6352013-08-01 17:58:23 +0000147 Contexts.back().IsExpression = true;
Daniel Jasper91b1d1a2016-03-21 17:57:31 +0000148 } else if (Style.Language == FormatStyle::LK_JavaScript && Left->Previous &&
Martin Probst2ec23242016-06-09 22:49:04 +0000149 (Left->Previous->is(Keywords.kw_function) ||
150 (Left->Previous->endsSequence(tok::identifier,
151 Keywords.kw_function)))) {
152 // function(...) or function f(...)
Daniel Jasper91b1d1a2016-03-21 17:57:31 +0000153 Contexts.back().IsExpression = false;
Martin Probst1b7f9802016-06-23 19:52:32 +0000154 } else if (Style.Language == FormatStyle::LK_JavaScript && Left->Previous &&
155 Left->Previous->is(TT_JsTypeColon)) {
156 // let x: (SomeType);
157 Contexts.back().IsExpression = false;
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000158 } else if (Left->Previous && Left->Previous->is(tok::r_square) &&
159 Left->Previous->MatchingParen &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000160 Left->Previous->MatchingParen->is(TT_LambdaLSquare)) {
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000161 // This is a parameter list of a lambda expression.
162 Contexts.back().IsExpression = false;
Daniel Jasper99b5a462015-05-12 10:20:32 +0000163 } else if (Line.InPPDirective &&
Daniel Jasperdf51f2e62016-01-11 12:55:33 +0000164 (!Left->Previous || !Left->Previous->is(tok::identifier))) {
Daniel Jasper99b5a462015-05-12 10:20:32 +0000165 Contexts.back().IsExpression = true;
Daniel Jasperc13ee342014-03-27 09:43:54 +0000166 } else if (Contexts[Contexts.size() - 2].CaretFound) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000167 // This is the parameter list of an ObjC block.
168 Contexts.back().IsExpression = false;
Daniel Jasper559b63c2014-01-28 20:13:43 +0000169 } else if (Left->Previous && Left->Previous->is(tok::kw___attribute)) {
170 Left->Type = TT_AttributeParen;
Daniel Jasper66cb8c52015-05-04 09:22:29 +0000171 } else if (Left->Previous && Left->Previous->is(TT_ForEachMacro)) {
Daniel Jaspere1e43192014-04-01 12:55:11 +0000172 // The first argument to a foreach macro is a declaration.
173 Contexts.back().IsForEachMacro = true;
174 Contexts.back().IsExpression = false;
Daniel Jasperf1f267b2014-10-21 07:57:50 +0000175 } else if (Left->Previous && Left->Previous->MatchingParen &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000176 Left->Previous->MatchingParen->is(TT_ObjCBlockLParen)) {
Daniel Jasperf1f267b2014-10-21 07:57:50 +0000177 Contexts.back().IsExpression = false;
Daniel Jaspera85c3312015-12-28 07:44:25 +0000178 } else if (!Line.MustBeDeclaration && !Line.InPPDirective) {
179 bool IsForOrCatch =
180 Left->Previous && Left->Previous->isOneOf(tok::kw_for, tok::kw_catch);
181 Contexts.back().IsExpression = !IsForOrCatch;
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000182 }
Daniel Jasper8b1c6352013-08-01 17:58:23 +0000183
Daniel Jasperc697ad22013-02-06 10:05:46 +0000184 if (StartsObjCMethodExpr) {
185 Contexts.back().ColonIsObjCMethodExpr = true;
186 Left->Type = TT_ObjCMethodExpr;
187 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000188
Daniel Jasper21561662016-06-13 07:49:35 +0000189 bool MightBeFunctionType = !Contexts[Contexts.size() - 2].IsExpression;
190 bool ProbablyFunctionType = CurrentToken->isOneOf(tok::star, tok::amp);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000191 bool HasMultipleLines = false;
192 bool HasMultipleParametersOnALine = false;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000193 bool MightBeObjCForRangeLoop =
194 Left->Previous && Left->Previous->is(tok::kw_for);
Craig Topper2145bc02014-05-09 08:15:10 +0000195 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000196 // LookForDecls is set when "if (" has been seen. Check for
197 // 'identifier' '*' 'identifier' followed by not '=' -- this
198 // '*' has to be a binary operator but determineStarAmpUsage() will
199 // categorize it as an unary operator, so set the right type here.
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000200 if (LookForDecls && CurrentToken->Next) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000201 FormatToken *Prev = CurrentToken->getPreviousNonComment();
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000202 if (Prev) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000203 FormatToken *PrevPrev = Prev->getPreviousNonComment();
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000204 FormatToken *Next = CurrentToken->Next;
205 if (PrevPrev && PrevPrev->is(tok::identifier) &&
206 Prev->isOneOf(tok::star, tok::amp, tok::ampamp) &&
207 CurrentToken->is(tok::identifier) && Next->isNot(tok::equal)) {
208 Prev->Type = TT_BinaryOperator;
209 LookForDecls = false;
210 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000211 }
212 }
213
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000214 if (CurrentToken->Previous->is(TT_PointerOrReference) &&
Daniel Jasper59036852013-08-12 12:16:34 +0000215 CurrentToken->Previous->Previous->isOneOf(tok::l_paren,
216 tok::coloncolon))
Daniel Jasper21561662016-06-13 07:49:35 +0000217 ProbablyFunctionType = true;
218 if (CurrentToken->is(tok::comma))
219 MightBeFunctionType = false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000220 if (CurrentToken->Previous->is(TT_BinaryOperator))
Daniel Jasper91beebd2014-06-30 13:44:47 +0000221 Contexts.back().IsExpression = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000222 if (CurrentToken->is(tok::r_paren)) {
Daniel Jasper21561662016-06-13 07:49:35 +0000223 if (MightBeFunctionType && ProbablyFunctionType && CurrentToken->Next &&
Daniel Jasper655d96a2013-07-16 11:37:21 +0000224 (CurrentToken->Next->is(tok::l_paren) ||
Daniel Jasper21561662016-06-13 07:49:35 +0000225 (CurrentToken->Next->is(tok::l_square) && Line.MustBeDeclaration)))
Daniel Jasper37194282013-05-28 08:33:00 +0000226 Left->Type = TT_FunctionTypeLParen;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000227 Left->MatchingParen = CurrentToken;
228 CurrentToken->MatchingParen = Left;
229
Daniel Jasper54353da2016-01-07 14:36:11 +0000230 if (CurrentToken->Next && CurrentToken->Next->is(tok::l_brace) &&
231 Left->Previous && Left->Previous->is(tok::l_paren)) {
232 // Detect the case where macros are used to generate lambdas or
233 // function bodies, e.g.:
234 // auto my_lambda = MARCO((Type *type, int i) { .. body .. });
235 for (FormatToken *Tok = Left; Tok != CurrentToken; Tok = Tok->Next) {
236 if (Tok->is(TT_BinaryOperator) &&
237 Tok->isOneOf(tok::star, tok::amp, tok::ampamp))
238 Tok->Type = TT_PointerOrReference;
239 }
240 }
241
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000242 if (StartsObjCMethodExpr) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000243 CurrentToken->Type = TT_ObjCMethodExpr;
Craig Topper2145bc02014-05-09 08:15:10 +0000244 if (Contexts.back().FirstObjCSelectorName) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000245 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
246 Contexts.back().LongestObjCSelectorName;
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000247 }
248 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000249
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000250 if (Left->is(TT_AttributeParen))
Daniel Jasper559b63c2014-01-28 20:13:43 +0000251 CurrentToken->Type = TT_AttributeParen;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000252 if (Left->Previous && Left->Previous->is(TT_JavaAnnotation))
Daniel Jasperf1f0c352014-10-21 09:25:39 +0000253 CurrentToken->Type = TT_JavaAnnotation;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000254 if (Left->Previous && Left->Previous->is(TT_LeadingJavaAnnotation))
Daniel Jaspere9ab42d2014-10-31 18:23:49 +0000255 CurrentToken->Type = TT_LeadingJavaAnnotation;
Daniel Jasper559b63c2014-01-28 20:13:43 +0000256
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000257 if (!HasMultipleLines)
258 Left->PackingKind = PPK_Inconclusive;
259 else if (HasMultipleParametersOnALine)
260 Left->PackingKind = PPK_BinPacked;
261 else
262 Left->PackingKind = PPK_OnePerLine;
263
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000264 next();
265 return true;
266 }
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000267 if (CurrentToken->isOneOf(tok::r_square, tok::r_brace))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000268 return false;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000269
270 if (CurrentToken->is(tok::l_brace))
Daniel Jasper31745732014-01-19 07:46:32 +0000271 Left->Type = TT_Unknown; // Not TT_ObjCBlockLParen
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000272 if (CurrentToken->is(tok::comma) && CurrentToken->Next &&
273 !CurrentToken->Next->HasUnescapedNewline &&
274 !CurrentToken->Next->isTrailingComment())
275 HasMultipleParametersOnALine = true;
Daniel Jasperd0d27aa2016-11-01 06:23:14 +0000276 if ((CurrentToken->Previous->isOneOf(tok::kw_const, tok::kw_auto) ||
277 CurrentToken->Previous->isSimpleTypeSpecifier()) &&
278 !CurrentToken->is(tok::l_brace))
Daniel Jasperc580af92014-03-11 09:29:46 +0000279 Contexts.back().IsExpression = false;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000280 if (CurrentToken->isOneOf(tok::semi, tok::colon))
281 MightBeObjCForRangeLoop = false;
282 if (MightBeObjCForRangeLoop && CurrentToken->is(Keywords.kw_in))
283 CurrentToken->Type = TT_ObjCForIn;
Daniel Jasper3a26a8d2015-05-13 12:54:30 +0000284 // When we discover a 'new', we set CanBeExpression to 'false' in order to
285 // parse the type correctly. Reset that after a comma.
286 if (CurrentToken->is(tok::comma))
287 Contexts.back().CanBeExpression = true;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000288
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000289 FormatToken *Tok = CurrentToken;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000290 if (!consumeToken())
291 return false;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000292 updateParameterCount(Left, Tok);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000293 if (CurrentToken && CurrentToken->HasUnescapedNewline)
294 HasMultipleLines = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000295 }
296 return false;
297 }
298
299 bool parseSquare() {
300 if (!CurrentToken)
301 return false;
302
Alexander Kornienkoafaa8f52013-06-17 13:19:53 +0000303 // A '[' could be an index subscript (after an identifier or after
Nico Weber2a726b62013-02-10 02:08:05 +0000304 // ')' or ']'), it could be the start of an Objective-C method
Eric Christopher2c4555a2015-06-19 01:52:53 +0000305 // expression, or it could the start of an Objective-C array literal.
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000306 FormatToken *Left = CurrentToken->Previous;
Daniel Jasperde7ca752015-05-04 07:39:00 +0000307 Left->ParentBracket = Contexts.back().ContextKind;
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000308 FormatToken *Parent = Left->getPreviousNonComment();
Nico Weberb2673a12016-11-10 21:49:25 +0000309
310 // Cases where '>' is followed by '['.
311 // In C++, this can happen either in array of templates (foo<int>[10])
312 // or when array is a nested template type (unique_ptr<type1<type2>[]>).
313 bool CppArrayTemplates =
Daniel Jasper1dbc2102017-03-31 13:30:24 +0000314 Style.isCpp() && Parent &&
Nico Weberb2673a12016-11-10 21:49:25 +0000315 Parent->is(TT_TemplateCloser) &&
316 (Contexts.back().CanBeExpression || Contexts.back().IsExpression ||
317 Contexts.back().InTemplateArgument);
318
Daniel Jasperfd36f0b2016-11-12 07:38:22 +0000319 bool StartsObjCMethodExpr =
Daniel Jasper1dbc2102017-03-31 13:30:24 +0000320 !CppArrayTemplates && Style.isCpp() &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000321 Contexts.back().CanBeExpression && Left->isNot(TT_LambdaLSquare) &&
Daniel Jasper89519082014-05-09 10:26:08 +0000322 CurrentToken->isNot(tok::l_brace) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000323 (!Parent ||
324 Parent->isOneOf(tok::colon, tok::l_square, tok::l_paren,
325 tok::kw_return, tok::kw_throw) ||
326 Parent->isUnaryOperator() ||
327 Parent->isOneOf(TT_ObjCForIn, TT_CastRParen) ||
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000328 getBinOpPrecedence(Parent->Tok.getKind(), true, true) > prec::Unknown);
Daniel Jaspera1ea4cb2013-10-26 17:00:22 +0000329 bool ColonFound = false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000330
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000331 unsigned BindingIncrease = 1;
332 if (Left->is(TT_Unknown)) {
333 if (StartsObjCMethodExpr) {
334 Left->Type = TT_ObjCMethodExpr;
Daniel Jasper8c42d442015-05-29 06:19:49 +0000335 } else if (Style.Language == FormatStyle::LK_JavaScript && Parent &&
Daniel Jasper4284e362015-06-02 14:20:08 +0000336 Contexts.back().ContextKind == tok::l_brace &&
Daniel Jasper8c42d442015-05-29 06:19:49 +0000337 Parent->isOneOf(tok::l_brace, tok::comma)) {
338 Left->Type = TT_JsComputedPropertyName;
Daniel Jasper3d934d32017-02-20 12:43:41 +0000339 } else if (CurrentToken->is(tok::r_square) && Parent &&
340 Parent->is(TT_TemplateCloser)) {
341 Left->Type = TT_ArraySubscriptLSquare;
Daniel Jasperccff4d12016-01-04 07:27:33 +0000342 } else if (Style.Language == FormatStyle::LK_Proto ||
Nico Weberb2673a12016-11-10 21:49:25 +0000343 (!CppArrayTemplates && Parent &&
Daniel Jasper887a3992016-06-14 13:54:38 +0000344 Parent->isOneOf(TT_BinaryOperator, TT_TemplateCloser, tok::at,
345 tok::comma, tok::l_paren, tok::l_square,
346 tok::question, tok::colon, tok::kw_return,
Daniel Jasperb14f6672016-01-04 15:51:56 +0000347 // Should only be relevant to JavaScript:
348 tok::kw_default))) {
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000349 Left->Type = TT_ArrayInitializerLSquare;
350 } else {
351 BindingIncrease = 10;
352 Left->Type = TT_ArraySubscriptLSquare;
353 }
Daniel Jasperc697ad22013-02-06 10:05:46 +0000354 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000355
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000356 ScopedContextCreator ContextCreator(*this, tok::l_square, BindingIncrease);
357 Contexts.back().IsExpression = true;
358 Contexts.back().ColonIsObjCMethodExpr = StartsObjCMethodExpr;
359
Craig Topper2145bc02014-05-09 08:15:10 +0000360 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000361 if (CurrentToken->is(tok::r_square)) {
Daniel Jasper9a8d48b2013-09-05 10:04:31 +0000362 if (CurrentToken->Next && CurrentToken->Next->is(tok::l_paren) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000363 Left->is(TT_ObjCMethodExpr)) {
Nico Weber5d2624e2013-02-06 06:20:11 +0000364 // An ObjC method call is rarely followed by an open parenthesis.
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000365 // FIXME: Do we incorrectly label ":" with this?
366 StartsObjCMethodExpr = false;
367 Left->Type = TT_Unknown;
368 }
Daniel Jasper139d4a32014-04-08 13:07:41 +0000369 if (StartsObjCMethodExpr && CurrentToken->Previous != Left) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000370 CurrentToken->Type = TT_ObjCMethodExpr;
Nico Weber5d2624e2013-02-06 06:20:11 +0000371 // determineStarAmpUsage() thinks that '*' '[' is allocating an
372 // array of pointers, but if '[' starts a selector then '*' is a
373 // binary operator.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000374 if (Parent && Parent->is(TT_PointerOrReference))
Nico Weberac9bde22013-02-06 16:54:35 +0000375 Parent->Type = TT_BinaryOperator;
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000376 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000377 Left->MatchingParen = CurrentToken;
378 CurrentToken->MatchingParen = Left;
Craig Topper2145bc02014-05-09 08:15:10 +0000379 if (Contexts.back().FirstObjCSelectorName) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000380 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
381 Contexts.back().LongestObjCSelectorName;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000382 if (Left->BlockParameterCount > 1)
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000383 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName = 0;
384 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000385 next();
386 return true;
387 }
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000388 if (CurrentToken->isOneOf(tok::r_paren, tok::r_brace))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000389 return false;
Daniel Jasperea772b4d2014-10-16 08:38:51 +0000390 if (CurrentToken->is(tok::colon)) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000391 if (Left->is(TT_ArraySubscriptLSquare)) {
Daniel Jasperea772b4d2014-10-16 08:38:51 +0000392 Left->Type = TT_ObjCMethodExpr;
393 StartsObjCMethodExpr = true;
394 Contexts.back().ColonIsObjCMethodExpr = true;
395 if (Parent && Parent->is(tok::r_paren))
396 Parent->Type = TT_CastRParen;
397 }
Daniel Jaspera1ea4cb2013-10-26 17:00:22 +0000398 ColonFound = true;
Daniel Jasperea772b4d2014-10-16 08:38:51 +0000399 }
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000400 if (CurrentToken->is(tok::comma) && Left->is(TT_ObjCMethodExpr) &&
401 !ColonFound)
Daniel Jasper1db6c382013-10-22 15:30:28 +0000402 Left->Type = TT_ArrayInitializerLSquare;
Nico Weberbeb03932015-01-09 23:25:06 +0000403 FormatToken *Tok = CurrentToken;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000404 if (!consumeToken())
405 return false;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000406 updateParameterCount(Left, Tok);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000407 }
408 return false;
409 }
410
411 bool parseBrace() {
Craig Topper2145bc02014-05-09 08:15:10 +0000412 if (CurrentToken) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000413 FormatToken *Left = CurrentToken->Previous;
Daniel Jasperde7ca752015-05-04 07:39:00 +0000414 Left->ParentBracket = Contexts.back().ContextKind;
Daniel Jasperc13ee342014-03-27 09:43:54 +0000415
416 if (Contexts.back().CaretFound)
417 Left->Type = TT_ObjCBlockLBrace;
418 Contexts.back().CaretFound = false;
419
Daniel Jasperb596fb22013-10-24 10:31:50 +0000420 ScopedContextCreator ContextCreator(*this, tok::l_brace, 1);
421 Contexts.back().ColonIsDictLiteral = true;
Daniel Jasper39485162014-05-22 09:00:33 +0000422 if (Left->BlockKind == BK_BracedInit)
423 Contexts.back().IsExpression = true;
Nico Weberced7d412013-05-26 05:39:26 +0000424
Craig Topper2145bc02014-05-09 08:15:10 +0000425 while (CurrentToken) {
Daniel Jasper8e357692013-05-06 08:27:33 +0000426 if (CurrentToken->is(tok::r_brace)) {
427 Left->MatchingParen = CurrentToken;
428 CurrentToken->MatchingParen = Left;
429 next();
430 return true;
431 }
432 if (CurrentToken->isOneOf(tok::r_paren, tok::r_square))
433 return false;
434 updateParameterCount(Left, CurrentToken);
Daniel Jasper497d9fd2014-08-15 05:00:35 +0000435 if (CurrentToken->isOneOf(tok::colon, tok::l_brace)) {
436 FormatToken *Previous = CurrentToken->getPreviousNonComment();
Daniel Jasper4d724492015-10-12 03:19:07 +0000437 if (((CurrentToken->is(tok::colon) &&
Daniel Jasper1dbc2102017-03-31 13:30:24 +0000438 (!Contexts.back().ColonIsDictLiteral || !Style.isCpp())) ||
Daniel Jasper168c8aa2014-08-27 11:53:26 +0000439 Style.Language == FormatStyle::LK_Proto) &&
Daniel Jasperb18425b2016-03-01 04:19:47 +0000440 (Previous->Tok.getIdentifierInfo() ||
Daniel Jasperabd1f572016-03-02 22:44:03 +0000441 Previous->is(tok::string_literal)))
Daniel Jasper497d9fd2014-08-15 05:00:35 +0000442 Previous->Type = TT_SelectorName;
Daniel Jasper739ec532015-04-04 07:56:55 +0000443 if (CurrentToken->is(tok::colon) ||
444 Style.Language == FormatStyle::LK_JavaScript)
Daniel Jasper497d9fd2014-08-15 05:00:35 +0000445 Left->Type = TT_DictLiteral;
Daniel Jasper17062ff2014-06-10 14:44:02 +0000446 }
Daniel Jaspere98e5812016-11-29 09:40:36 +0000447 if (CurrentToken->is(tok::comma) &&
448 Style.Language == FormatStyle::LK_JavaScript)
449 Left->Type = TT_DictLiteral;
Daniel Jasper8e357692013-05-06 08:27:33 +0000450 if (!consumeToken())
451 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000452 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000453 }
454 return true;
455 }
Daniel Jasperdc7d5812013-02-20 12:56:39 +0000456
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000457 void updateParameterCount(FormatToken *Left, FormatToken *Current) {
Daniel Jasper9f4c9d42016-02-07 22:17:13 +0000458 if (Current->is(tok::l_brace) && Current->BlockKind == BK_Block)
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000459 ++Left->BlockParameterCount;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000460 if (Current->is(tok::comma)) {
Daniel Jaspere11095a2013-02-14 15:01:34 +0000461 ++Left->ParameterCount;
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000462 if (!Left->Role)
463 Left->Role.reset(new CommaSeparatedList(Style));
464 Left->Role->CommaFound(Current);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000465 } else if (Left->ParameterCount == 0 && Current->isNot(tok::comment)) {
Daniel Jaspere11095a2013-02-14 15:01:34 +0000466 Left->ParameterCount = 1;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000467 }
Daniel Jaspere11095a2013-02-14 15:01:34 +0000468 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000469
470 bool parseConditional() {
Craig Topper2145bc02014-05-09 08:15:10 +0000471 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000472 if (CurrentToken->is(tok::colon)) {
473 CurrentToken->Type = TT_ConditionalExpr;
474 next();
475 return true;
476 }
477 if (!consumeToken())
478 return false;
479 }
480 return false;
481 }
482
483 bool parseTemplateDeclaration() {
Craig Topper2145bc02014-05-09 08:15:10 +0000484 if (CurrentToken && CurrentToken->is(tok::less)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000485 CurrentToken->Type = TT_TemplateOpener;
486 next();
487 if (!parseAngle())
488 return false;
Craig Topper2145bc02014-05-09 08:15:10 +0000489 if (CurrentToken)
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000490 CurrentToken->Previous->ClosesTemplateDeclaration = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000491 return true;
492 }
493 return false;
494 }
495
496 bool consumeToken() {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000497 FormatToken *Tok = CurrentToken;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000498 next();
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000499 switch (Tok->Tok.getKind()) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000500 case tok::plus:
501 case tok::minus:
Craig Topper2145bc02014-05-09 08:15:10 +0000502 if (!Tok->Previous && Line.MustBeDeclaration)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000503 Tok->Type = TT_ObjCMethodSpecifier;
504 break;
505 case tok::colon:
Craig Topper2145bc02014-05-09 08:15:10 +0000506 if (!Tok->Previous)
Daniel Jasper850677d2013-03-18 12:50:26 +0000507 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000508 // Colons from ?: are handled in parseConditional().
Daniel Jaspera74f5072015-04-13 15:01:40 +0000509 if (Style.Language == FormatStyle::LK_JavaScript) {
Daniel Jasper9326f912015-05-05 08:40:32 +0000510 if (Contexts.back().ColonIsForRangeExpr || // colon in for loop
511 (Contexts.size() == 1 && // switch/case labels
Daniel Jaspera74f5072015-04-13 15:01:40 +0000512 !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) ||
Daniel Jasper9326f912015-05-05 08:40:32 +0000513 Contexts.back().ContextKind == tok::l_paren || // function params
514 Contexts.back().ContextKind == tok::l_square || // array type
Daniel Jasper81dbb562015-06-03 08:43:18 +0000515 (Contexts.size() == 1 &&
516 Line.MustBeDeclaration)) { // method/property declaration
Daniel Jaspera74f5072015-04-13 15:01:40 +0000517 Tok->Type = TT_JsTypeColon;
518 break;
519 }
520 }
Daniel Jasperffbad0e2016-01-04 07:28:12 +0000521 if (Contexts.back().ColonIsDictLiteral ||
522 Style.Language == FormatStyle::LK_Proto) {
Daniel Jasperb596fb22013-10-24 10:31:50 +0000523 Tok->Type = TT_DictLiteral;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000524 } else if (Contexts.back().ColonIsObjCMethodExpr ||
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000525 Line.startsWith(TT_ObjCMethodSpecifier)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000526 Tok->Type = TT_ObjCMethodExpr;
Daniel Jasperfd36f0b2016-11-12 07:38:22 +0000527 const FormatToken *BeforePrevious = Tok->Previous->Previous;
528 if (!BeforePrevious ||
529 !(BeforePrevious->is(TT_CastRParen) ||
530 (BeforePrevious->is(TT_ObjCMethodExpr) &&
531 BeforePrevious->is(tok::colon))) ||
532 BeforePrevious->is(tok::r_square) ||
533 Contexts.back().LongestObjCSelectorName == 0) {
534 Tok->Previous->Type = TT_SelectorName;
535 if (Tok->Previous->ColumnWidth >
536 Contexts.back().LongestObjCSelectorName)
537 Contexts.back().LongestObjCSelectorName =
538 Tok->Previous->ColumnWidth;
539 if (!Contexts.back().FirstObjCSelectorName)
540 Contexts.back().FirstObjCSelectorName = Tok->Previous;
541 }
Daniel Jasperc697ad22013-02-06 10:05:46 +0000542 } else if (Contexts.back().ColonIsForRangeExpr) {
Daniel Jaspera74f5072015-04-13 15:01:40 +0000543 Tok->Type = TT_RangeBasedForLoopColon;
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000544 } else if (CurrentToken && CurrentToken->is(tok::numeric_constant)) {
Alexander Kornienko60d1b042013-10-10 13:36:20 +0000545 Tok->Type = TT_BitFieldColon;
Daniel Jasperd39312ec2014-05-28 10:09:11 +0000546 } else if (Contexts.size() == 1 &&
547 !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) {
Malcolm Parsons5d8cdb82016-10-20 14:58:45 +0000548 if (Tok->getPreviousNonComment()->isOneOf(tok::r_paren,
549 tok::kw_noexcept))
Daniel Jasperb10bdff2015-02-18 17:09:53 +0000550 Tok->Type = TT_CtorInitializerColon;
551 else
552 Tok->Type = TT_InheritanceColon;
Daniel Jasper78580792014-10-20 12:01:45 +0000553 } else if (Tok->Previous->is(tok::identifier) && Tok->Next &&
554 Tok->Next->isOneOf(tok::r_paren, tok::comma)) {
555 // This handles a special macro in ObjC code where selectors including
556 // the colon are passed as macro arguments.
557 Tok->Type = TT_ObjCMethodExpr;
Daniel Jasper40aacf42013-03-14 13:45:21 +0000558 } else if (Contexts.back().ContextKind == tok::l_paren) {
Daniel Jaspera74f5072015-04-13 15:01:40 +0000559 Tok->Type = TT_InlineASMColon;
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000560 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000561 break;
Daniel Jasper91b1d1a2016-03-21 17:57:31 +0000562 case tok::pipe:
563 case tok::amp:
564 // | and & in declarations/type expressions represent union and
565 // intersection types, respectively.
566 if (Style.Language == FormatStyle::LK_JavaScript &&
567 !Contexts.back().IsExpression)
568 Tok->Type = TT_JsTypeOperator;
569 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000570 case tok::kw_if:
571 case tok::kw_while:
Craig Topper2145bc02014-05-09 08:15:10 +0000572 if (CurrentToken && CurrentToken->is(tok::l_paren)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000573 next();
Nico Weber9096fc02013-06-26 00:30:14 +0000574 if (!parseParens(/*LookForDecls=*/true))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000575 return false;
576 }
577 break;
578 case tok::kw_for:
Martin Probstbd49e322017-05-15 19:33:20 +0000579 if (Style.Language == FormatStyle::LK_JavaScript)
580 if (Tok->Previous && Tok->Previous->is(tok::period))
581 break;
Martin Probsta050f412017-05-18 21:19:29 +0000582 // JS' for await ( ...
583 if (CurrentToken && CurrentToken->is(Keywords.kw_await))
Martin Probstbd49e322017-05-15 19:33:20 +0000584 next();
Daniel Jasperc697ad22013-02-06 10:05:46 +0000585 Contexts.back().ColonIsForRangeExpr = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000586 next();
587 if (!parseParens())
588 return false;
589 break;
590 case tok::l_paren:
Birunthan Mohanathas525579d2015-07-15 19:11:58 +0000591 // When faced with 'operator()()', the kw_operator handler incorrectly
592 // marks the first l_paren as a OverloadedOperatorLParen. Here, we make
593 // the first two parens OverloadedOperators and the second l_paren an
594 // OverloadedOperatorLParen.
595 if (Tok->Previous &&
596 Tok->Previous->is(tok::r_paren) &&
597 Tok->Previous->MatchingParen &&
598 Tok->Previous->MatchingParen->is(TT_OverloadedOperatorLParen)) {
599 Tok->Previous->Type = TT_OverloadedOperator;
600 Tok->Previous->MatchingParen->Type = TT_OverloadedOperator;
601 Tok->Type = TT_OverloadedOperatorLParen;
602 }
603
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000604 if (!parseParens())
605 return false;
Daniel Jasperbc5cb4e2013-11-07 17:43:07 +0000606 if (Line.MustBeDeclaration && Contexts.size() == 1 &&
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000607 !Contexts.back().IsExpression && !Line.startsWith(TT_ObjCProperty) &&
Daniel Jaspera831c582015-01-14 09:47:57 +0000608 (!Tok->Previous ||
Daniel Jaspera5fa4d12015-07-06 11:30:34 +0000609 !Tok->Previous->isOneOf(tok::kw_decltype, tok::kw___attribute,
610 TT_LeadingJavaAnnotation)))
Daniel Jasper26d1b1d2013-02-24 18:54:32 +0000611 Line.MightBeFunctionDecl = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000612 break;
613 case tok::l_square:
614 if (!parseSquare())
615 return false;
616 break;
617 case tok::l_brace:
618 if (!parseBrace())
619 return false;
620 break;
621 case tok::less:
Daniel Jasper0c9772e2016-02-05 14:17:16 +0000622 if (parseAngle()) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000623 Tok->Type = TT_TemplateOpener;
Daniel Jasperb13135b2015-01-08 08:48:21 +0000624 } else {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000625 Tok->Type = TT_BinaryOperator;
Daniel Jasper4d9ec172015-05-06 08:38:24 +0000626 NonTemplateLess.insert(Tok);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000627 CurrentToken = Tok;
628 next();
629 }
630 break;
631 case tok::r_paren:
632 case tok::r_square:
633 return false;
634 case tok::r_brace:
635 // Lines can start with '}'.
Craig Topper2145bc02014-05-09 08:15:10 +0000636 if (Tok->Previous)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000637 return false;
638 break;
639 case tok::greater:
640 Tok->Type = TT_BinaryOperator;
641 break;
642 case tok::kw_operator:
Daniel Jasper42401c82013-09-02 09:20:39 +0000643 while (CurrentToken &&
644 !CurrentToken->isOneOf(tok::l_paren, tok::semi, tok::r_paren)) {
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000645 if (CurrentToken->isOneOf(tok::star, tok::amp))
Daniel Jasper35d2dc72013-02-11 08:01:18 +0000646 CurrentToken->Type = TT_PointerOrReference;
647 consumeToken();
Daniel Jasper804a2762016-01-09 15:56:40 +0000648 if (CurrentToken &&
649 CurrentToken->Previous->isOneOf(TT_BinaryOperator, tok::comma))
Daniel Jasperd215b8b2013-08-28 07:27:35 +0000650 CurrentToken->Previous->Type = TT_OverloadedOperator;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000651 }
Daniel Jasper8f9624b2013-05-10 07:59:58 +0000652 if (CurrentToken) {
Daniel Jasper35d2dc72013-02-11 08:01:18 +0000653 CurrentToken->Type = TT_OverloadedOperatorLParen;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000654 if (CurrentToken->Previous->is(TT_BinaryOperator))
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000655 CurrentToken->Previous->Type = TT_OverloadedOperator;
Daniel Jasper8f9624b2013-05-10 07:59:58 +0000656 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000657 break;
658 case tok::question:
Daniel Jaspera74f5072015-04-13 15:01:40 +0000659 if (Style.Language == FormatStyle::LK_JavaScript && Tok->Next &&
Daniel Jasper56691b82015-06-11 13:29:20 +0000660 Tok->Next->isOneOf(tok::semi, tok::comma, tok::colon, tok::r_paren,
Daniel Jaspera74f5072015-04-13 15:01:40 +0000661 tok::r_brace)) {
Daniel Jasper9326f912015-05-05 08:40:32 +0000662 // Question marks before semicolons, colons, etc. indicate optional
663 // types (fields, parameters), e.g.
664 // function(x?: string, y?) {...}
665 // class X { y?; }
Daniel Jaspera74f5072015-04-13 15:01:40 +0000666 Tok->Type = TT_JsTypeOptionalQuestion;
667 break;
668 }
Daniel Jasper9326f912015-05-05 08:40:32 +0000669 // Declarations cannot be conditional expressions, this can only be part
670 // of a type declaration.
Daniel Jasperd9d8da22016-07-12 15:45:53 +0000671 if (Line.MustBeDeclaration && !Contexts.back().IsExpression &&
Daniel Jasper9326f912015-05-05 08:40:32 +0000672 Style.Language == FormatStyle::LK_JavaScript)
673 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000674 parseConditional();
675 break;
676 case tok::kw_template:
677 parseTemplateDeclaration();
678 break;
Daniel Jaspera628c982013-04-03 13:36:17 +0000679 case tok::comma:
Daniel Jaspere4ab49e2015-04-20 12:54:29 +0000680 if (Contexts.back().InCtorInitializer)
681 Tok->Type = TT_CtorInitializerComma;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +0000682 else if (Contexts.back().InInheritanceList)
683 Tok->Type = TT_InheritanceComma;
Daniel Jasperd6e09e82015-05-19 11:51:39 +0000684 else if (Contexts.back().FirstStartOfName &&
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000685 (Contexts.size() == 1 || Line.startsWith(tok::kw_for))) {
Daniel Jaspera628c982013-04-03 13:36:17 +0000686 Contexts.back().FirstStartOfName->PartOfMultiVariableDeclStmt = true;
Daniel Jasperbea1ab42015-03-01 18:55:26 +0000687 Line.IsMultiVariableDeclStmt = true;
688 }
Daniel Jaspere1e43192014-04-01 12:55:11 +0000689 if (Contexts.back().IsForEachMacro)
690 Contexts.back().IsExpression = true;
Daniel Jaspera628c982013-04-03 13:36:17 +0000691 break;
Nico Weber21088802017-02-10 19:36:52 +0000692 case tok::identifier:
693 if (Tok->isOneOf(Keywords.kw___has_include,
694 Keywords.kw___has_include_next)) {
695 parseHasInclude();
696 }
697 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000698 default:
699 break;
700 }
701 return true;
702 }
703
704 void parseIncludeDirective() {
Craig Topper2145bc02014-05-09 08:15:10 +0000705 if (CurrentToken && CurrentToken->is(tok::less)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000706 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000707 while (CurrentToken) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000708 if (CurrentToken->isNot(tok::comment) || CurrentToken->Next)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000709 CurrentToken->Type = TT_ImplicitStringLiteral;
710 next();
711 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000712 }
713 }
714
715 void parseWarningOrError() {
716 next();
717 // We still want to format the whitespace left of the first token of the
718 // warning or error.
719 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000720 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000721 CurrentToken->Type = TT_ImplicitStringLiteral;
722 next();
723 }
724 }
725
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000726 void parsePragma() {
727 next(); // Consume "pragma".
Daniel Jasperee4a8a12015-04-22 09:45:42 +0000728 if (CurrentToken &&
729 CurrentToken->isOneOf(Keywords.kw_mark, Keywords.kw_option)) {
730 bool IsMark = CurrentToken->is(Keywords.kw_mark);
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000731 next(); // Consume "mark".
732 next(); // Consume first token (so we fix leading whitespace).
Craig Topper2145bc02014-05-09 08:15:10 +0000733 while (CurrentToken) {
Daniel Jasperee4a8a12015-04-22 09:45:42 +0000734 if (IsMark || CurrentToken->Previous->is(TT_BinaryOperator))
735 CurrentToken->Type = TT_ImplicitStringLiteral;
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000736 next();
737 }
738 }
739 }
740
Nico Weber21088802017-02-10 19:36:52 +0000741 void parseHasInclude() {
742 if (!CurrentToken || !CurrentToken->is(tok::l_paren))
743 return;
744 next(); // '('
745 parseIncludeDirective();
746 next(); // ')'
747 }
748
Daniel Jasper616de8642014-11-23 16:46:28 +0000749 LineType parsePreprocessorDirective() {
Martin Probst7ea9b6d2016-05-29 14:41:36 +0000750 bool IsFirstToken = CurrentToken->IsFirst;
Daniel Jasper616de8642014-11-23 16:46:28 +0000751 LineType Type = LT_PreprocessorDirective;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000752 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000753 if (!CurrentToken)
Daniel Jasper616de8642014-11-23 16:46:28 +0000754 return Type;
Martin Probst7ea9b6d2016-05-29 14:41:36 +0000755
756 if (Style.Language == FormatStyle::LK_JavaScript && IsFirstToken) {
757 // JavaScript files can contain shebang lines of the form:
758 // #!/usr/bin/env node
759 // Treat these like C++ #include directives.
760 while (CurrentToken) {
761 // Tokens cannot be comments here.
762 CurrentToken->Type = TT_ImplicitStringLiteral;
763 next();
764 }
765 return LT_ImportStatement;
766 }
767
Alexander Kornienko384b40b2013-10-11 21:43:05 +0000768 if (CurrentToken->Tok.is(tok::numeric_constant)) {
769 CurrentToken->SpacesRequiredBefore = 1;
Daniel Jasper616de8642014-11-23 16:46:28 +0000770 return Type;
Alexander Kornienko384b40b2013-10-11 21:43:05 +0000771 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000772 // Hashes in the middle of a line can lead to any strange token
773 // sequence.
Craig Topper2145bc02014-05-09 08:15:10 +0000774 if (!CurrentToken->Tok.getIdentifierInfo())
Daniel Jasper616de8642014-11-23 16:46:28 +0000775 return Type;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000776 switch (CurrentToken->Tok.getIdentifierInfo()->getPPKeywordID()) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000777 case tok::pp_include:
Daniel Jasperfa3f8fb2015-05-19 11:22:29 +0000778 case tok::pp_include_next:
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000779 case tok::pp_import:
Daniel Jasper343643b2014-08-13 08:29:18 +0000780 next();
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000781 parseIncludeDirective();
Daniel Jasper616de8642014-11-23 16:46:28 +0000782 Type = LT_ImportStatement;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000783 break;
784 case tok::pp_error:
785 case tok::pp_warning:
786 parseWarningOrError();
787 break;
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000788 case tok::pp_pragma:
789 parsePragma();
790 break;
Daniel Jasper4431aa92013-04-23 13:54:04 +0000791 case tok::pp_if:
792 case tok::pp_elif:
Daniel Jasper7cfde412014-01-21 08:56:09 +0000793 Contexts.back().IsExpression = true;
Daniel Jasper4431aa92013-04-23 13:54:04 +0000794 parseLine();
795 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000796 default:
797 break;
798 }
Nico Weber21088802017-02-10 19:36:52 +0000799 while (CurrentToken) {
800 FormatToken *Tok = CurrentToken;
Daniel Jaspera885dbe2013-02-05 09:34:14 +0000801 next();
Daniel Jasper47d58ea2017-04-19 06:06:38 +0000802 if (Tok->is(tok::l_paren))
803 parseParens();
804 else if (Tok->isOneOf(Keywords.kw___has_include,
805 Keywords.kw___has_include_next))
Nico Weber21088802017-02-10 19:36:52 +0000806 parseHasInclude();
Nico Weber21088802017-02-10 19:36:52 +0000807 }
Daniel Jasper616de8642014-11-23 16:46:28 +0000808 return Type;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000809 }
810
Nico Weber44449172013-02-12 16:17:07 +0000811public:
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000812 LineType parseLine() {
Daniel Jasper4d9ec172015-05-06 08:38:24 +0000813 NonTemplateLess.clear();
Daniel Jasper1b998812015-04-23 09:54:10 +0000814 if (CurrentToken->is(tok::hash))
Daniel Jasper616de8642014-11-23 16:46:28 +0000815 return parsePreprocessorDirective();
Daniel Jasper7cfde412014-01-21 08:56:09 +0000816
Daniel Jasper47ef6dd2014-01-17 16:21:39 +0000817 // Directly allow to 'import <string-literal>' to support protocol buffer
818 // definitions (code.google.com/p/protobuf) or missing "#" (either way we
819 // should not break the line).
820 IdentifierInfo *Info = CurrentToken->Tok.getIdentifierInfo();
Daniel Jasper9b9e0762014-11-26 18:03:42 +0000821 if ((Style.Language == FormatStyle::LK_Java &&
822 CurrentToken->is(Keywords.kw_package)) ||
823 (Info && Info->getPPKeywordID() == tok::pp_import &&
Daniel Jasper86ee0b62014-12-04 08:57:27 +0000824 CurrentToken->Next &&
Daniel Jasper16dbe0b2015-01-14 10:02:49 +0000825 CurrentToken->Next->isOneOf(tok::string_literal, tok::identifier,
826 tok::kw_static))) {
Daniel Jasper343643b2014-08-13 08:29:18 +0000827 next();
Daniel Jasper47ef6dd2014-01-17 16:21:39 +0000828 parseIncludeDirective();
Daniel Jasper616de8642014-11-23 16:46:28 +0000829 return LT_ImportStatement;
Daniel Jasper343643b2014-08-13 08:29:18 +0000830 }
831
832 // If this line starts and ends in '<' and '>', respectively, it is likely
833 // part of "#define <a/b.h>".
834 if (CurrentToken->is(tok::less) && Line.Last->is(tok::greater)) {
835 parseIncludeDirective();
Daniel Jasper616de8642014-11-23 16:46:28 +0000836 return LT_ImportStatement;
Daniel Jasper343643b2014-08-13 08:29:18 +0000837 }
Daniel Jasper47ef6dd2014-01-17 16:21:39 +0000838
Daniel Jasper1b998812015-04-23 09:54:10 +0000839 // In .proto files, top-level options are very similar to import statements
840 // and should not be line-wrapped.
841 if (Style.Language == FormatStyle::LK_Proto && Line.Level == 0 &&
842 CurrentToken->is(Keywords.kw_option)) {
843 next();
844 if (CurrentToken && CurrentToken->is(tok::identifier))
845 return LT_ImportStatement;
846 }
847
Martin Probst0cd74ee2016-06-13 16:39:50 +0000848 bool KeywordVirtualFound = false;
849 bool ImportStatement = false;
850
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +0000851 // import {...} from '...';
852 if (Style.Language == FormatStyle::LK_JavaScript &&
853 CurrentToken->is(Keywords.kw_import))
Martin Probst0cd74ee2016-06-13 16:39:50 +0000854 ImportStatement = true;
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +0000855
Craig Topper2145bc02014-05-09 08:15:10 +0000856 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000857 if (CurrentToken->is(tok::kw_virtual))
858 KeywordVirtualFound = true;
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +0000859 if (Style.Language == FormatStyle::LK_JavaScript) {
860 // export {...} from '...';
861 // An export followed by "from 'some string';" is a re-export from
862 // another module identified by a URI and is treated as a
863 // LT_ImportStatement (i.e. prevent wraps on it for long URIs).
864 // Just "export {...};" or "export class ..." should not be treated as
865 // an import in this sense.
866 if (Line.First->is(tok::kw_export) &&
867 CurrentToken->is(Keywords.kw_from) && CurrentToken->Next &&
868 CurrentToken->Next->isStringLiteral())
869 ImportStatement = true;
870 if (isClosureImportStatement(*CurrentToken))
871 ImportStatement = true;
872 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000873 if (!consumeToken())
874 return LT_Invalid;
875 }
876 if (KeywordVirtualFound)
877 return LT_VirtualFunctionDecl;
Daniel Jasper616de8642014-11-23 16:46:28 +0000878 if (ImportStatement)
879 return LT_ImportStatement;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000880
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000881 if (Line.startsWith(TT_ObjCMethodSpecifier)) {
Craig Topper2145bc02014-05-09 08:15:10 +0000882 if (Contexts.back().FirstObjCSelectorName)
Daniel Jasperc697ad22013-02-06 10:05:46 +0000883 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
884 Contexts.back().LongestObjCSelectorName;
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000885 return LT_ObjCMethodDecl;
886 }
887
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000888 return LT_Other;
889 }
890
Nico Weber44449172013-02-12 16:17:07 +0000891private:
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +0000892 bool isClosureImportStatement(const FormatToken &Tok) {
Daniel Jasper616de8642014-11-23 16:46:28 +0000893 // FIXME: Closure-library specific stuff should not be hard-coded but be
894 // configurable.
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +0000895 return Tok.TokenText == "goog" && Tok.Next && Tok.Next->is(tok::period) &&
Daniel Jasper616de8642014-11-23 16:46:28 +0000896 Tok.Next->Next && (Tok.Next->Next->TokenText == "module" ||
Daniel Jasperb488a742015-10-29 19:05:20 +0000897 Tok.Next->Next->TokenText == "provide" ||
Daniel Jasper616de8642014-11-23 16:46:28 +0000898 Tok.Next->Next->TokenText == "require" ||
Daniel Jasper02cbeb22016-02-22 15:06:53 +0000899 Tok.Next->Next->TokenText == "setTestOnly" ||
900 Tok.Next->Next->TokenText == "forwardDeclare") &&
Daniel Jasper53c38f42014-11-27 14:46:03 +0000901 Tok.Next->Next->Next && Tok.Next->Next->Next->is(tok::l_paren);
Daniel Jasper616de8642014-11-23 16:46:28 +0000902 }
903
Manuel Klimek819788d2014-03-18 11:22:45 +0000904 void resetTokenMetadata(FormatToken *Token) {
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000905 if (!Token)
906 return;
Manuel Klimek819788d2014-03-18 11:22:45 +0000907
908 // Reset token type in case we have already looked at it and then
909 // recovered from an error (e.g. failure to find the matching >).
Daniel Jasper66cb8c52015-05-04 09:22:29 +0000910 if (!CurrentToken->isOneOf(TT_LambdaLSquare, TT_ForEachMacro,
911 TT_FunctionLBrace, TT_ImplicitStringLiteral,
Daniel Jasper6f2b88a2015-06-05 13:18:09 +0000912 TT_InlineASMBrace, TT_JsFatArrow, TT_LambdaArrow,
Daniel Jasper71e50af2016-11-01 06:22:59 +0000913 TT_OverloadedOperator, TT_RegexLiteral,
Alexander Kornienkod4fa2e62017-04-11 09:55:00 +0000914 TT_TemplateString, TT_ObjCStringLiteral))
Manuel Klimek819788d2014-03-18 11:22:45 +0000915 CurrentToken->Type = TT_Unknown;
David Blaikie3875a822014-07-19 01:06:45 +0000916 CurrentToken->Role.reset();
Daniel Jasperd1debfc2015-01-21 18:04:02 +0000917 CurrentToken->MatchingParen = nullptr;
Manuel Klimek819788d2014-03-18 11:22:45 +0000918 CurrentToken->FakeLParens.clear();
919 CurrentToken->FakeRParens = 0;
920 }
921
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000922 void next() {
Craig Topper2145bc02014-05-09 08:15:10 +0000923 if (CurrentToken) {
Daniel Jasper63af7c42013-12-09 14:40:19 +0000924 CurrentToken->NestingLevel = Contexts.size() - 1;
Daniel Jasper78b45332014-08-14 10:52:56 +0000925 CurrentToken->BindingStrength = Contexts.back().BindingStrength;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000926 modifyContext(*CurrentToken);
Daniel Jasper78b45332014-08-14 10:52:56 +0000927 determineTokenType(*CurrentToken);
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000928 CurrentToken = CurrentToken->Next;
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000929 }
Daniel Jasper5065bc42013-02-18 12:44:35 +0000930
Manuel Klimek819788d2014-03-18 11:22:45 +0000931 resetTokenMetadata(CurrentToken);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000932 }
933
Daniel Jasperc697ad22013-02-06 10:05:46 +0000934 /// \brief A struct to hold information valid in a specific context, e.g.
935 /// a pair of parenthesis.
936 struct Context {
Daniel Jasper40aacf42013-03-14 13:45:21 +0000937 Context(tok::TokenKind ContextKind, unsigned BindingStrength,
938 bool IsExpression)
939 : ContextKind(ContextKind), BindingStrength(BindingStrength),
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000940 IsExpression(IsExpression) {}
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000941
Daniel Jasper40aacf42013-03-14 13:45:21 +0000942 tok::TokenKind ContextKind;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000943 unsigned BindingStrength;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000944 bool IsExpression;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000945 unsigned LongestObjCSelectorName = 0;
946 bool ColonIsForRangeExpr = false;
947 bool ColonIsDictLiteral = false;
948 bool ColonIsObjCMethodExpr = false;
949 FormatToken *FirstObjCSelectorName = nullptr;
950 FormatToken *FirstStartOfName = nullptr;
951 bool CanBeExpression = true;
952 bool InTemplateArgument = false;
953 bool InCtorInitializer = false;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +0000954 bool InInheritanceList = false;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000955 bool CaretFound = false;
956 bool IsForEachMacro = false;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000957 };
958
959 /// \brief Puts a new \c Context onto the stack \c Contexts for the lifetime
960 /// of each instance.
961 struct ScopedContextCreator {
962 AnnotatingParser &P;
963
Daniel Jasper40aacf42013-03-14 13:45:21 +0000964 ScopedContextCreator(AnnotatingParser &P, tok::TokenKind ContextKind,
965 unsigned Increase)
966 : P(P) {
Daniel Jasper3ac9b9e2013-07-08 14:34:09 +0000967 P.Contexts.push_back(Context(ContextKind,
968 P.Contexts.back().BindingStrength + Increase,
969 P.Contexts.back().IsExpression));
Daniel Jasperc697ad22013-02-06 10:05:46 +0000970 }
971
972 ~ScopedContextCreator() { P.Contexts.pop_back(); }
973 };
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000974
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000975 void modifyContext(const FormatToken &Current) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000976 if (Current.getPrecedence() == prec::Assignment &&
Daniel Jasper95516cd2015-12-23 18:01:29 +0000977 !Line.First->isOneOf(tok::kw_template, tok::kw_using, tok::kw_return) &&
Martin Probst1b7f9802016-06-23 19:52:32 +0000978 // Type aliases use `type X = ...;` in TypeScript.
979 !(Style.Language == FormatStyle::LK_JavaScript &&
980 Line.startsWith(Keywords.kw_type, tok::identifier)) &&
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000981 (!Current.Previous || Current.Previous->isNot(tok::kw_operator))) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000982 Contexts.back().IsExpression = true;
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000983 if (!Line.startsWith(TT_UnaryOperator)) {
Daniel Jasper75092162015-01-23 19:04:49 +0000984 for (FormatToken *Previous = Current.Previous;
Daniel Jasperbcad0662015-07-21 22:51:00 +0000985 Previous && Previous->Previous &&
986 !Previous->Previous->isOneOf(tok::comma, tok::semi);
Daniel Jasper75092162015-01-23 19:04:49 +0000987 Previous = Previous->Previous) {
988 if (Previous->isOneOf(tok::r_square, tok::r_paren)) {
989 Previous = Previous->MatchingParen;
990 if (!Previous)
991 break;
992 }
Daniel Jasperdc4f7252015-03-11 12:59:49 +0000993 if (Previous->opensScope())
994 break;
Daniel Jasper75092162015-01-23 19:04:49 +0000995 if (Previous->isOneOf(TT_BinaryOperator, TT_UnaryOperator) &&
Daniel Jasper1c220482015-02-25 10:30:06 +0000996 Previous->isOneOf(tok::star, tok::amp, tok::ampamp) &&
997 Previous->Previous && Previous->Previous->isNot(tok::equal))
Daniel Jasper75092162015-01-23 19:04:49 +0000998 Previous->Type = TT_PointerOrReference;
Manuel Klimek5f594f82014-08-13 14:00:41 +0000999 }
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001000 }
Daniel Jasper93101662015-05-19 12:29:27 +00001001 } else if (Current.is(tok::lessless) &&
1002 (!Current.Previous || !Current.Previous->is(tok::kw_operator))) {
1003 Contexts.back().IsExpression = true;
Daniel Jasper3682fcd2013-12-16 08:36:18 +00001004 } else if (Current.isOneOf(tok::kw_return, tok::kw_throw)) {
Daniel Jasperc697ad22013-02-06 10:05:46 +00001005 Contexts.back().IsExpression = true;
Daniel Jasperbcb55ee2014-11-21 14:08:38 +00001006 } else if (Current.is(TT_TrailingReturnArrow)) {
1007 Contexts.back().IsExpression = false;
Nico Weber4f113492015-09-15 23:48:17 +00001008 } else if (Current.is(TT_LambdaArrow) || Current.is(Keywords.kw_assert)) {
Daniel Jasper6f2b88a2015-06-05 13:18:09 +00001009 Contexts.back().IsExpression = Style.Language == FormatStyle::LK_Java;
Eric Liuce5e4bc2016-05-18 08:02:56 +00001010 } else if (Current.Previous &&
1011 Current.Previous->is(TT_CtorInitializerColon)) {
1012 Contexts.back().IsExpression = true;
1013 Contexts.back().InCtorInitializer = true;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +00001014 } else if (Current.Previous &&
1015 Current.Previous->is(TT_InheritanceColon)) {
1016 Contexts.back().InInheritanceList = true;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001017 } else if (Current.isOneOf(tok::r_paren, tok::greater, tok::comma)) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001018 for (FormatToken *Previous = Current.Previous;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001019 Previous && Previous->isOneOf(tok::star, tok::amp);
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001020 Previous = Previous->Previous)
Nico Weber44449172013-02-12 16:17:07 +00001021 Previous->Type = TT_PointerOrReference;
Daniel Jasperd27df3d2016-02-01 11:21:07 +00001022 if (Line.MustBeDeclaration && !Contexts.front().InCtorInitializer)
1023 Contexts.back().IsExpression = false;
Daniel Jasper97b89482013-03-13 07:49:51 +00001024 } else if (Current.is(tok::kw_new)) {
1025 Contexts.back().CanBeExpression = false;
Daniel Marjamakie59f8d72015-06-18 10:59:26 +00001026 } else if (Current.isOneOf(tok::semi, tok::exclaim)) {
Daniel Jasperc37de302013-05-03 14:41:24 +00001027 // This should be the condition or increment in a for-loop.
1028 Contexts.back().IsExpression = true;
Nico Weber44449172013-02-12 16:17:07 +00001029 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001030 }
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001031
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001032 void determineTokenType(FormatToken &Current) {
1033 if (!Current.is(TT_Unknown))
1034 // The token type is already known.
1035 return;
1036
Martin Probst22b8d2692017-03-13 09:14:23 +00001037 if (Style.Language == FormatStyle::LK_JavaScript) {
1038 if (Current.is(tok::exclaim)) {
1039 if (Current.Previous &&
Martin Probst82b3d902017-05-15 08:15:53 +00001040 (Current.Previous->isOneOf(tok::identifier, tok::kw_namespace,
1041 tok::r_paren, tok::r_square,
1042 tok::r_brace) ||
Martin Probst22b8d2692017-03-13 09:14:23 +00001043 Current.Previous->Tok.isLiteral())) {
1044 Current.Type = TT_JsNonNullAssertion;
1045 return;
1046 }
1047 if (Current.Next &&
1048 Current.Next->isOneOf(TT_BinaryOperator, Keywords.kw_as)) {
1049 Current.Type = TT_JsNonNullAssertion;
1050 return;
1051 }
1052 }
1053 }
1054
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001055 // Line.MightBeFunctionDecl can only be true after the parentheses of a
1056 // function declaration have been found. In this case, 'Current' is a
1057 // trailing token of this declaration and thus cannot be a name.
1058 if (Current.is(Keywords.kw_instanceof)) {
1059 Current.Type = TT_BinaryOperator;
1060 } else if (isStartOfName(Current) &&
1061 (!Line.MightBeFunctionDecl || Current.NestingLevel != 0)) {
1062 Contexts.back().FirstStartOfName = &Current;
1063 Current.Type = TT_StartOfName;
Richard Smithe301ba22015-11-11 02:02:15 +00001064 } else if (Current.isOneOf(tok::kw_auto, tok::kw___auto_type)) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001065 AutoFound = true;
1066 } else if (Current.is(tok::arrow) &&
1067 Style.Language == FormatStyle::LK_Java) {
1068 Current.Type = TT_LambdaArrow;
1069 } else if (Current.is(tok::arrow) && AutoFound && Line.MustBeDeclaration &&
1070 Current.NestingLevel == 0) {
1071 Current.Type = TT_TrailingReturnArrow;
1072 } else if (Current.isOneOf(tok::star, tok::amp, tok::ampamp)) {
1073 Current.Type =
1074 determineStarAmpUsage(Current, Contexts.back().CanBeExpression &&
1075 Contexts.back().IsExpression,
1076 Contexts.back().InTemplateArgument);
1077 } else if (Current.isOneOf(tok::minus, tok::plus, tok::caret)) {
1078 Current.Type = determinePlusMinusCaretUsage(Current);
1079 if (Current.is(TT_UnaryOperator) && Current.is(tok::caret))
1080 Contexts.back().CaretFound = true;
1081 } else if (Current.isOneOf(tok::minusminus, tok::plusplus)) {
1082 Current.Type = determineIncrementUsage(Current);
1083 } else if (Current.isOneOf(tok::exclaim, tok::tilde)) {
1084 Current.Type = TT_UnaryOperator;
1085 } else if (Current.is(tok::question)) {
Daniel Jasper9326f912015-05-05 08:40:32 +00001086 if (Style.Language == FormatStyle::LK_JavaScript &&
Martin Probst31d6da72016-06-23 21:51:49 +00001087 Line.MustBeDeclaration && !Contexts.back().IsExpression) {
Daniel Jasper9326f912015-05-05 08:40:32 +00001088 // In JavaScript, `interface X { foo?(): bar; }` is an optional method
1089 // on the interface, not a ternary expression.
1090 Current.Type = TT_JsTypeOptionalQuestion;
1091 } else {
1092 Current.Type = TT_ConditionalExpr;
1093 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001094 } else if (Current.isBinaryOperator() &&
1095 (!Current.Previous || Current.Previous->isNot(tok::l_square))) {
1096 Current.Type = TT_BinaryOperator;
1097 } else if (Current.is(tok::comment)) {
Daniel Jasper62c78f52015-05-06 08:58:57 +00001098 if (Current.TokenText.startswith("/*")) {
1099 if (Current.TokenText.endswith("*/"))
1100 Current.Type = TT_BlockComment;
1101 else
1102 // The lexer has for some reason determined a comment here. But we
1103 // cannot really handle it, if it isn't properly terminated.
1104 Current.Tok.setKind(tok::unknown);
1105 } else {
1106 Current.Type = TT_LineComment;
1107 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001108 } else if (Current.is(tok::r_paren)) {
1109 if (rParenEndsCast(Current))
1110 Current.Type = TT_CastRParen;
Daniel Jasper47bbda02015-05-18 13:47:23 +00001111 if (Current.MatchingParen && Current.Next &&
1112 !Current.Next->isBinaryOperator() &&
Daniel Jasper19bc1d02016-04-06 13:58:09 +00001113 !Current.Next->isOneOf(tok::semi, tok::colon, tok::l_brace,
Daniel Jaspere1540202017-02-28 18:28:15 +00001114 tok::comma, tok::period, tok::arrow,
1115 tok::coloncolon))
Daniel Jaspere31388a2016-09-26 22:19:08 +00001116 if (FormatToken *AfterParen = Current.MatchingParen->Next) {
1117 // Make sure this isn't the return type of an Obj-C block declaration
1118 if (AfterParen->Tok.isNot(tok::caret)) {
1119 if (FormatToken *BeforeParen = Current.MatchingParen->Previous)
1120 if (BeforeParen->is(tok::identifier) &&
1121 BeforeParen->TokenText == BeforeParen->TokenText.upper() &&
1122 (!BeforeParen->Previous ||
1123 BeforeParen->Previous->ClosesTemplateDeclaration))
1124 Current.Type = TT_FunctionAnnotationRParen;
1125 }
1126 }
Martin Probstad063912017-04-26 12:36:49 +00001127 } else if (Current.is(tok::at) && Current.Next &&
1128 Style.Language != FormatStyle::LK_JavaScript &&
1129 Style.Language != FormatStyle::LK_Java) {
1130 // In Java & JavaScript, "@..." is a decorator or annotation. In ObjC, it
1131 // marks declarations and properties that need special formatting.
Alexander Kornienkod4fa2e62017-04-11 09:55:00 +00001132 switch (Current.Next->Tok.getObjCKeywordID()) {
1133 case tok::objc_interface:
1134 case tok::objc_implementation:
1135 case tok::objc_protocol:
1136 Current.Type = TT_ObjCDecl;
1137 break;
1138 case tok::objc_property:
1139 Current.Type = TT_ObjCProperty;
1140 break;
1141 default:
1142 break;
Aaron Ballman484ee9b2014-11-24 15:42:34 +00001143 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001144 } else if (Current.is(tok::period)) {
1145 FormatToken *PreviousNoComment = Current.getPreviousNonComment();
1146 if (PreviousNoComment &&
1147 PreviousNoComment->isOneOf(tok::comma, tok::l_brace))
1148 Current.Type = TT_DesignatedInitializerPeriod;
Nico Weberbeb03932015-01-09 23:25:06 +00001149 else if (Style.Language == FormatStyle::LK_Java && Current.Previous &&
1150 Current.Previous->isOneOf(TT_JavaAnnotation,
1151 TT_LeadingJavaAnnotation)) {
1152 Current.Type = Current.Previous->Type;
1153 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001154 } else if (Current.isOneOf(tok::identifier, tok::kw_const) &&
1155 Current.Previous &&
1156 !Current.Previous->isOneOf(tok::equal, tok::at) &&
1157 Line.MightBeFunctionDecl && Contexts.size() == 1) {
1158 // Line.MightBeFunctionDecl can only be true after the parentheses of a
1159 // function declaration have been found.
1160 Current.Type = TT_TrailingAnnotation;
Daniel Jasper3c42dba2015-02-18 17:17:15 +00001161 } else if ((Style.Language == FormatStyle::LK_Java ||
1162 Style.Language == FormatStyle::LK_JavaScript) &&
1163 Current.Previous) {
Nico Weberbeb03932015-01-09 23:25:06 +00001164 if (Current.Previous->is(tok::at) &&
1165 Current.isNot(Keywords.kw_interface)) {
1166 const FormatToken &AtToken = *Current.Previous;
1167 const FormatToken *Previous = AtToken.getPreviousNonComment();
1168 if (!Previous || Previous->is(TT_LeadingJavaAnnotation))
1169 Current.Type = TT_LeadingJavaAnnotation;
1170 else
1171 Current.Type = TT_JavaAnnotation;
1172 } else if (Current.Previous->is(tok::period) &&
1173 Current.Previous->isOneOf(TT_JavaAnnotation,
1174 TT_LeadingJavaAnnotation)) {
1175 Current.Type = Current.Previous->Type;
1176 }
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001177 }
1178 }
1179
Daniel Jasperdba1c552013-07-02 09:47:29 +00001180 /// \brief Take a guess at whether \p Tok starts a name of a function or
1181 /// variable declaration.
1182 ///
1183 /// This is a heuristic based on whether \p Tok is an identifier following
1184 /// something that is likely a type.
1185 bool isStartOfName(const FormatToken &Tok) {
Craig Topper2145bc02014-05-09 08:15:10 +00001186 if (Tok.isNot(tok::identifier) || !Tok.Previous)
Daniel Jasperdba1c552013-07-02 09:47:29 +00001187 return false;
1188
Daniel Jasper01b87832017-03-01 19:26:12 +00001189 if (Tok.Previous->isOneOf(TT_LeadingJavaAnnotation, Keywords.kw_instanceof,
1190 Keywords.kw_as))
Jacques Pienaarfc275112015-02-18 23:48:37 +00001191 return false;
Daniel Jasper1ce41112016-02-01 11:20:47 +00001192 if (Style.Language == FormatStyle::LK_JavaScript &&
1193 Tok.Previous->is(Keywords.kw_in))
1194 return false;
Daniel Jasper404658a2015-01-14 10:00:20 +00001195
Daniel Jasperdba1c552013-07-02 09:47:29 +00001196 // Skip "const" as it does not have an influence on whether this is a name.
Andi-Bogdan Postelnicu67329892017-03-07 14:48:02 +00001197 FormatToken *PreviousNotConst = Tok.getPreviousNonComment();
Craig Topper2145bc02014-05-09 08:15:10 +00001198 while (PreviousNotConst && PreviousNotConst->is(tok::kw_const))
Andi-Bogdan Postelnicu67329892017-03-07 14:48:02 +00001199 PreviousNotConst = PreviousNotConst->getPreviousNonComment();
Daniel Jasperdba1c552013-07-02 09:47:29 +00001200
Craig Topper2145bc02014-05-09 08:15:10 +00001201 if (!PreviousNotConst)
Daniel Jasperdba1c552013-07-02 09:47:29 +00001202 return false;
1203
Daniel Jasper3ac9b9e2013-07-08 14:34:09 +00001204 bool IsPPKeyword = PreviousNotConst->is(tok::identifier) &&
1205 PreviousNotConst->Previous &&
1206 PreviousNotConst->Previous->is(tok::hash);
Daniel Jasperdba1c552013-07-02 09:47:29 +00001207
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001208 if (PreviousNotConst->is(TT_TemplateCloser))
Daniel Jasper53643062013-08-19 10:16:18 +00001209 return PreviousNotConst && PreviousNotConst->MatchingParen &&
1210 PreviousNotConst->MatchingParen->Previous &&
Daniel Jaspercaf86852014-11-20 09:48:11 +00001211 PreviousNotConst->MatchingParen->Previous->isNot(tok::period) &&
Daniel Jasper53643062013-08-19 10:16:18 +00001212 PreviousNotConst->MatchingParen->Previous->isNot(tok::kw_template);
1213
Daniel Jasperf10a28d2014-05-05 13:48:09 +00001214 if (PreviousNotConst->is(tok::r_paren) && PreviousNotConst->MatchingParen &&
1215 PreviousNotConst->MatchingParen->Previous &&
1216 PreviousNotConst->MatchingParen->Previous->is(tok::kw_decltype))
1217 return true;
1218
Daniel Jasperaf642c62015-08-25 13:40:51 +00001219 return (!IsPPKeyword &&
1220 PreviousNotConst->isOneOf(tok::identifier, tok::kw_auto)) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001221 PreviousNotConst->is(TT_PointerOrReference) ||
Daniel Jaspercb51cf42014-01-16 09:11:55 +00001222 PreviousNotConst->isSimpleTypeSpecifier();
Daniel Jasperdba1c552013-07-02 09:47:29 +00001223 }
1224
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001225 /// \brief Determine whether ')' is ending a cast.
1226 bool rParenEndsCast(const FormatToken &Tok) {
Daniel Jasper569369c2015-11-23 15:55:55 +00001227 // C-style casts are only used in C++ and Java.
Daniel Jasper1dbc2102017-03-31 13:30:24 +00001228 if (!Style.isCpp() && Style.Language != FormatStyle::LK_Java)
Daniel Jasper569369c2015-11-23 15:55:55 +00001229 return false;
Daniel Jasper9bb30012015-11-23 15:55:50 +00001230
Daniel Jasper569369c2015-11-23 15:55:55 +00001231 // Empty parens aren't casts and there are no casts at the end of the line.
1232 if (Tok.Previous == Tok.MatchingParen || !Tok.Next || !Tok.MatchingParen)
1233 return false;
1234
1235 FormatToken *LeftOfParens = Tok.MatchingParen->getPreviousNonComment();
Daniel Jasper9bb30012015-11-23 15:55:50 +00001236 if (LeftOfParens) {
Daniel Jasper594be2f2016-06-13 07:49:09 +00001237 // If there is a closing parenthesis left of the current parentheses,
Daniel Jasper8e8b4fb2015-11-23 19:11:45 +00001238 // look past it as these might be chained casts.
1239 if (LeftOfParens->is(tok::r_paren)) {
1240 if (!LeftOfParens->MatchingParen ||
1241 !LeftOfParens->MatchingParen->Previous)
1242 return false;
1243 LeftOfParens = LeftOfParens->MatchingParen->Previous;
1244 }
1245
Daniel Jasper569369c2015-11-23 15:55:55 +00001246 // If there is an identifier (or with a few exceptions a keyword) right
1247 // before the parentheses, this is unlikely to be a cast.
Daniel Jasper9bb30012015-11-23 15:55:50 +00001248 if (LeftOfParens->Tok.getIdentifierInfo() &&
1249 !LeftOfParens->isOneOf(Keywords.kw_in, tok::kw_return, tok::kw_case,
1250 tok::kw_delete))
1251 return false;
Daniel Jasper569369c2015-11-23 15:55:55 +00001252
1253 // Certain other tokens right before the parentheses are also signals that
1254 // this cannot be a cast.
1255 if (LeftOfParens->isOneOf(tok::at, tok::r_square, TT_OverloadedOperator,
Daniel Jasper594be2f2016-06-13 07:49:09 +00001256 TT_TemplateCloser, tok::ellipsis))
Daniel Jasper9bb30012015-11-23 15:55:50 +00001257 return false;
Daniel Jasper9bb30012015-11-23 15:55:50 +00001258 }
Daniel Jasper569369c2015-11-23 15:55:55 +00001259
1260 if (Tok.Next->is(tok::question))
1261 return false;
1262
1263 // As Java has no function types, a "(" after the ")" likely means that this
1264 // is a cast.
1265 if (Style.Language == FormatStyle::LK_Java && Tok.Next->is(tok::l_paren))
1266 return true;
1267
1268 // If a (non-string) literal follows, this is likely a cast.
1269 if (Tok.Next->isNot(tok::string_literal) &&
1270 (Tok.Next->Tok.isLiteral() ||
1271 Tok.Next->isOneOf(tok::kw_sizeof, tok::kw_alignof)))
1272 return true;
1273
1274 // Heuristically try to determine whether the parentheses contain a type.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001275 bool ParensAreType =
1276 !Tok.Previous ||
1277 Tok.Previous->isOneOf(TT_PointerOrReference, TT_TemplateCloser) ||
1278 Tok.Previous->isSimpleTypeSpecifier();
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001279 bool ParensCouldEndDecl =
Daniel Jasper74331d42015-10-26 12:08:47 +00001280 Tok.Next->isOneOf(tok::equal, tok::semi, tok::l_brace, tok::greater);
Daniel Jaspera85c3312015-12-28 07:44:25 +00001281 if (ParensAreType && !ParensCouldEndDecl)
Daniel Jasper569369c2015-11-23 15:55:55 +00001282 return true;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001283
Daniel Jasper569369c2015-11-23 15:55:55 +00001284 // At this point, we heuristically assume that there are no casts at the
1285 // start of the line. We assume that we have found most cases where there
1286 // are by the logic above, e.g. "(void)x;".
1287 if (!LeftOfParens)
1288 return false;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001289
Daniel Jasperfd36f0b2016-11-12 07:38:22 +00001290 // Certain token types inside the parentheses mean that this can't be a
1291 // cast.
1292 for (const FormatToken *Token = Tok.MatchingParen->Next; Token != &Tok;
1293 Token = Token->Next)
1294 if (Token->is(TT_BinaryOperator))
1295 return false;
1296
Daniel Jasper94b1bdf2016-04-05 11:46:06 +00001297 // If the following token is an identifier or 'this', this is a cast. All
1298 // cases where this can be something else are handled above.
1299 if (Tok.Next->isOneOf(tok::identifier, tok::kw_this))
Daniel Jasper569369c2015-11-23 15:55:55 +00001300 return true;
1301
1302 if (!Tok.Next->Next)
1303 return false;
1304
1305 // If the next token after the parenthesis is a unary operator, assume
1306 // that this is cast, unless there are unexpected tokens inside the
1307 // parenthesis.
1308 bool NextIsUnary =
1309 Tok.Next->isUnaryOperator() || Tok.Next->isOneOf(tok::amp, tok::star);
1310 if (!NextIsUnary || Tok.Next->is(tok::plus) ||
1311 !Tok.Next->Next->isOneOf(tok::identifier, tok::numeric_constant))
1312 return false;
1313 // Search for unexpected tokens.
1314 for (FormatToken *Prev = Tok.Previous; Prev != Tok.MatchingParen;
1315 Prev = Prev->Previous) {
1316 if (!Prev->isOneOf(tok::kw_const, tok::identifier, tok::coloncolon))
1317 return false;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001318 }
Daniel Jasper569369c2015-11-23 15:55:55 +00001319 return true;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001320 }
1321
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001322 /// \brief Return the type of the given token assuming it is * or &.
Manuel Klimekf81e5c02014-03-27 11:17:36 +00001323 TokenType determineStarAmpUsage(const FormatToken &Tok, bool IsExpression,
1324 bool InTemplateArgument) {
Daniel Jasper3a038de2014-09-05 08:53:45 +00001325 if (Style.Language == FormatStyle::LK_JavaScript)
1326 return TT_BinaryOperator;
1327
Alexander Kornienko1efe0a02013-07-04 14:47:51 +00001328 const FormatToken *PrevToken = Tok.getPreviousNonComment();
Craig Topper2145bc02014-05-09 08:15:10 +00001329 if (!PrevToken)
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001330 return TT_UnaryOperator;
1331
Alexander Kornienko1efe0a02013-07-04 14:47:51 +00001332 const FormatToken *NextToken = Tok.getNextNonComment();
Daniel Jasper628dd852017-03-08 09:49:12 +00001333 if (!NextToken ||
1334 NextToken->isOneOf(tok::arrow, tok::equal, tok::kw_const) ||
Daniel Jasperbcb55ee2014-11-21 14:08:38 +00001335 (NextToken->is(tok::l_brace) && !NextToken->getNextNonComment()))
Daniel Jasper5d7f06f2015-08-24 14:28:08 +00001336 return TT_PointerOrReference;
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001337
Daniel Jasper73e171f2014-08-29 12:54:38 +00001338 if (PrevToken->is(tok::coloncolon))
Daniel Jasper8eb371b2013-03-01 17:13:29 +00001339 return TT_PointerOrReference;
1340
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001341 if (PrevToken->isOneOf(tok::l_paren, tok::l_square, tok::l_brace,
Daniel Jasperae907642013-03-14 10:50:25 +00001342 tok::comma, tok::semi, tok::kw_return, tok::colon,
Aaron Ballman484ee9b2014-11-24 15:42:34 +00001343 tok::equal, tok::kw_delete, tok::kw_sizeof) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001344 PrevToken->isOneOf(TT_BinaryOperator, TT_ConditionalExpr,
1345 TT_UnaryOperator, TT_CastRParen))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001346 return TT_UnaryOperator;
1347
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001348 if (NextToken->is(tok::l_square) && NextToken->isNot(TT_LambdaLSquare))
Nico Weber5d2624e2013-02-06 06:20:11 +00001349 return TT_PointerOrReference;
Daniel Jasper0ea4d792015-10-07 01:41:14 +00001350 if (NextToken->is(tok::kw_operator) && !IsExpression)
1351 return TT_PointerOrReference;
1352 if (NextToken->isOneOf(tok::comma, tok::semi))
Daniel Jasper32ccb032014-06-23 07:36:18 +00001353 return TT_PointerOrReference;
Nico Weber5d2624e2013-02-06 06:20:11 +00001354
Daniel Jasper71665cd2013-09-10 10:26:38 +00001355 if (PrevToken->is(tok::r_paren) && PrevToken->MatchingParen &&
1356 PrevToken->MatchingParen->Previous &&
Daniel Jasper4ac7de72014-06-11 07:35:16 +00001357 PrevToken->MatchingParen->Previous->isOneOf(tok::kw_typeof,
1358 tok::kw_decltype))
Daniel Jasper71665cd2013-09-10 10:26:38 +00001359 return TT_PointerOrReference;
1360
Manuel Klimek94815562014-03-28 09:27:09 +00001361 if (PrevToken->Tok.isLiteral() ||
1362 PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::kw_true,
Daniel Jasperf0c809a2014-10-28 18:28:22 +00001363 tok::kw_false, tok::r_brace) ||
Manuel Klimek94815562014-03-28 09:27:09 +00001364 NextToken->Tok.isLiteral() ||
1365 NextToken->isOneOf(tok::kw_true, tok::kw_false) ||
1366 NextToken->isUnaryOperator() ||
Manuel Klimekf81e5c02014-03-27 11:17:36 +00001367 // If we know we're in a template argument, there are no named
1368 // declarations. Thus, having an identifier on the right-hand side
1369 // indicates a binary operator.
1370 (InTemplateArgument && NextToken->Tok.isAnyIdentifier()))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001371 return TT_BinaryOperator;
1372
Daniel Jasper13a7f462014-10-28 18:11:52 +00001373 // "&&(" is quite unlikely to be two successive unary "&".
1374 if (Tok.is(tok::ampamp) && NextToken && NextToken->is(tok::l_paren))
1375 return TT_BinaryOperator;
1376
Daniel Jasper7d028292014-06-02 11:54:20 +00001377 // This catches some cases where evaluation order is used as control flow:
1378 // aaa && aaa->f();
1379 const FormatToken *NextNextToken = NextToken->getNextNonComment();
1380 if (NextNextToken && NextNextToken->is(tok::arrow))
1381 return TT_BinaryOperator;
1382
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001383 // It is very unlikely that we are going to find a pointer or reference type
1384 // definition on the RHS of an assignment.
Daniel Jasperbb86d842014-11-23 19:15:35 +00001385 if (IsExpression && !Contexts.back().CaretFound)
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001386 return TT_BinaryOperator;
1387
1388 return TT_PointerOrReference;
1389 }
1390
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001391 TokenType determinePlusMinusCaretUsage(const FormatToken &Tok) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +00001392 const FormatToken *PrevToken = Tok.getPreviousNonComment();
Daniel Jasper8315ea12016-11-09 14:12:55 +00001393 if (!PrevToken)
1394 return TT_UnaryOperator;
1395
1396 if (PrevToken->isOneOf(TT_CastRParen, TT_UnaryOperator) &&
1397 !PrevToken->is(tok::exclaim))
1398 // There aren't any trailing unary operators except for TypeScript's
1399 // non-null operator (!). Thus, this must be squence of leading operators.
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001400 return TT_UnaryOperator;
1401
1402 // Use heuristics to recognize unary operators.
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001403 if (PrevToken->isOneOf(tok::equal, tok::l_paren, tok::comma, tok::l_square,
1404 tok::question, tok::colon, tok::kw_return,
1405 tok::kw_case, tok::at, tok::l_brace))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001406 return TT_UnaryOperator;
1407
Nico Weberb76de882013-02-05 16:21:00 +00001408 // There can't be two consecutive binary operators.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001409 if (PrevToken->is(TT_BinaryOperator))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001410 return TT_UnaryOperator;
1411
1412 // Fall back to marking the token as binary operator.
1413 return TT_BinaryOperator;
1414 }
1415
1416 /// \brief Determine whether ++/-- are pre- or post-increments/-decrements.
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001417 TokenType determineIncrementUsage(const FormatToken &Tok) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +00001418 const FormatToken *PrevToken = Tok.getPreviousNonComment();
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001419 if (!PrevToken || PrevToken->is(TT_CastRParen))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001420 return TT_UnaryOperator;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001421 if (PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::identifier))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001422 return TT_TrailingUnaryOperator;
1423
1424 return TT_UnaryOperator;
1425 }
Daniel Jasperc697ad22013-02-06 10:05:46 +00001426
1427 SmallVector<Context, 8> Contexts;
1428
Daniel Jasper8de9ed02013-08-22 15:00:41 +00001429 const FormatStyle &Style;
Daniel Jasperc697ad22013-02-06 10:05:46 +00001430 AnnotatedLine &Line;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001431 FormatToken *CurrentToken;
Daniel Jasper6cdec7c2013-07-09 14:36:48 +00001432 bool AutoFound;
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001433 const AdditionalKeywords &Keywords;
Daniel Jasper4d9ec172015-05-06 08:38:24 +00001434
1435 // Set of "<" tokens that do not open a template parameter list. If parseAngle
1436 // determines that a specific token can't be a template opener, it will make
1437 // same decision irrespective of the decisions for tokens leading up to it.
1438 // Store this information to prevent this from causing exponential runtime.
1439 llvm::SmallPtrSet<FormatToken *, 16> NonTemplateLess;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001440};
1441
Benjamin Kramer28b45ce2015-03-08 16:06:46 +00001442static const int PrecedenceUnaryOperator = prec::PointerToMember + 1;
1443static const int PrecedenceArrowAndPeriod = prec::PointerToMember + 2;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001444
Daniel Jasper400adc62013-02-08 15:28:42 +00001445/// \brief Parses binary expressions by inserting fake parenthesis based on
1446/// operator precedence.
1447class ExpressionParser {
1448public:
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001449 ExpressionParser(const FormatStyle &Style, const AdditionalKeywords &Keywords,
1450 AnnotatedLine &Line)
1451 : Style(Style), Keywords(Keywords), Current(Line.First) {}
Daniel Jasper400adc62013-02-08 15:28:42 +00001452
1453 /// \brief Parse expressions with the given operatore precedence.
Daniel Jaspercd8599e2013-02-23 21:01:55 +00001454 void parse(int Precedence = 0) {
Daniel Jasperf48b5ab2013-11-07 19:23:49 +00001455 // Skip 'return' and ObjC selector colons as they are not part of a binary
1456 // expression.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001457 while (Current && (Current->is(tok::kw_return) ||
1458 (Current->is(tok::colon) &&
1459 Current->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral))))
Daniel Jaspereabede62013-09-30 08:29:03 +00001460 next();
1461
Craig Topper2145bc02014-05-09 08:15:10 +00001462 if (!Current || Precedence > PrecedenceArrowAndPeriod)
Daniel Jasper0649d362013-08-23 15:14:03 +00001463 return;
1464
Daniel Jasper2c611c02013-05-31 14:56:12 +00001465 // Conditional expressions need to be parsed separately for proper nesting.
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001466 if (Precedence == prec::Conditional) {
Daniel Jasper2c611c02013-05-31 14:56:12 +00001467 parseConditionalExpr();
1468 return;
1469 }
Daniel Jasper0649d362013-08-23 15:14:03 +00001470
1471 // Parse unary operators, which all have a higher precedence than binary
1472 // operators.
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001473 if (Precedence == PrecedenceUnaryOperator) {
Daniel Jasper0649d362013-08-23 15:14:03 +00001474 parseUnaryOperator();
Daniel Jasper400adc62013-02-08 15:28:42 +00001475 return;
Daniel Jasper0649d362013-08-23 15:14:03 +00001476 }
Daniel Jasper400adc62013-02-08 15:28:42 +00001477
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001478 FormatToken *Start = Current;
Craig Topper2145bc02014-05-09 08:15:10 +00001479 FormatToken *LatestOperator = nullptr;
Daniel Jasper0e617842014-04-16 12:26:54 +00001480 unsigned OperatorIndex = 0;
Daniel Jasper400adc62013-02-08 15:28:42 +00001481
Daniel Jaspercd8599e2013-02-23 21:01:55 +00001482 while (Current) {
Daniel Jasper400adc62013-02-08 15:28:42 +00001483 // Consume operators with higher precedence.
Daniel Jasper6bee6822013-04-08 20:33:42 +00001484 parse(Precedence + 1);
Daniel Jasper400adc62013-02-08 15:28:42 +00001485
Daniel Jasper0649d362013-08-23 15:14:03 +00001486 int CurrentPrecedence = getCurrentPrecedence();
1487
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001488 if (Current && Current->is(TT_SelectorName) &&
Daniel Jasperb88b25f2013-12-23 07:29:06 +00001489 Precedence == CurrentPrecedence) {
1490 if (LatestOperator)
1491 addFakeParenthesis(Start, prec::Level(Precedence));
Daniel Jasper0649d362013-08-23 15:14:03 +00001492 Start = Current;
Daniel Jasperb88b25f2013-12-23 07:29:06 +00001493 }
Daniel Jaspercd8599e2013-02-23 21:01:55 +00001494
Daniel Jasper400adc62013-02-08 15:28:42 +00001495 // At the end of the line or when an operator with higher precedence is
1496 // found, insert fake parenthesis and return.
Daniel Jasperc06f6da2017-02-03 14:32:38 +00001497 if (!Current ||
1498 (Current->closesScope() &&
1499 (Current->MatchingParen || Current->is(TT_TemplateString))) ||
Daniel Jasper6c22c442014-11-14 13:03:40 +00001500 (CurrentPrecedence != -1 && CurrentPrecedence < Precedence) ||
1501 (CurrentPrecedence == prec::Conditional &&
1502 Precedence == prec::Assignment && Current->is(tok::colon))) {
Daniel Jasper83791072014-12-03 13:20:49 +00001503 break;
Daniel Jasper400adc62013-02-08 15:28:42 +00001504 }
1505
1506 // Consume scopes: (), [], <> and {}
Daniel Jasperc04baae2013-04-10 09:49:49 +00001507 if (Current->opensScope()) {
Daniel Jasper24de6fb2017-01-31 13:03:07 +00001508 // In fragment of a JavaScript template string can look like '}..${' and
1509 // thus close a scope and open a new one at the same time.
1510 while (Current && (!Current->closesScope() || Current->opensScope())) {
Daniel Jasper400adc62013-02-08 15:28:42 +00001511 next();
1512 parse();
1513 }
1514 next();
1515 } else {
1516 // Operator found.
Daniel Jasper0e617842014-04-16 12:26:54 +00001517 if (CurrentPrecedence == Precedence) {
Daniel Jasper00492f92016-01-05 13:03:50 +00001518 if (LatestOperator)
1519 LatestOperator->NextOperator = Current;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001520 LatestOperator = Current;
Daniel Jasper0e617842014-04-16 12:26:54 +00001521 Current->OperatorIndex = OperatorIndex;
1522 ++OperatorIndex;
1523 }
Daniel Jasper3eb341c2014-11-11 23:04:51 +00001524 next(/*SkipPastLeadingComments=*/Precedence > 0);
Daniel Jasper400adc62013-02-08 15:28:42 +00001525 }
1526 }
Daniel Jasper83791072014-12-03 13:20:49 +00001527
1528 if (LatestOperator && (Current || Precedence > 0)) {
Daniel Jasper00492f92016-01-05 13:03:50 +00001529 // LatestOperator->LastOperator = true;
Daniel Jasper83791072014-12-03 13:20:49 +00001530 if (Precedence == PrecedenceArrowAndPeriod) {
1531 // Call expressions don't have a binary operator precedence.
1532 addFakeParenthesis(Start, prec::Unknown);
1533 } else {
1534 addFakeParenthesis(Start, prec::Level(Precedence));
1535 }
1536 }
Daniel Jasper400adc62013-02-08 15:28:42 +00001537 }
1538
1539private:
Daniel Jasper0649d362013-08-23 15:14:03 +00001540 /// \brief Gets the precedence (+1) of the given token for binary operators
1541 /// and other tokens that we treat like binary operators.
1542 int getCurrentPrecedence() {
1543 if (Current) {
Daniel Jasper97bfb7b2014-09-05 08:29:31 +00001544 const FormatToken *NextNonComment = Current->getNextNonComment();
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001545 if (Current->is(TT_ConditionalExpr))
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001546 return prec::Conditional;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001547 if (NextNonComment && NextNonComment->is(tok::colon) &&
1548 NextNonComment->is(TT_DictLiteral))
Daniel Jasper893b8ad2017-03-01 19:47:28 +00001549 return prec::Assignment;
1550 if (Current->is(TT_JsComputedPropertyName))
1551 return prec::Assignment;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001552 if (Current->is(TT_LambdaArrow))
Daniel Jasper8354ea82014-11-21 12:14:12 +00001553 return prec::Comma;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001554 if (Current->is(TT_JsFatArrow))
Daniel Jasper3b0f3042015-06-05 08:25:37 +00001555 return prec::Assignment;
Daniel Jasper893b8ad2017-03-01 19:47:28 +00001556 if (Current->isOneOf(tok::semi, TT_InlineASMColon, TT_SelectorName) ||
Daniel Jasper3c306e82015-06-03 17:08:40 +00001557 (Current->is(tok::comment) && NextNonComment &&
1558 NextNonComment->is(TT_SelectorName)))
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001559 return 0;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001560 if (Current->is(TT_RangeBasedForLoopColon))
Daniel Jasper9cc3e972014-02-07 10:09:46 +00001561 return prec::Comma;
Daniel Jasper043ac052015-07-03 10:12:53 +00001562 if ((Style.Language == FormatStyle::LK_Java ||
1563 Style.Language == FormatStyle::LK_JavaScript) &&
1564 Current->is(Keywords.kw_instanceof))
1565 return prec::Relational;
Daniel Jasper1ce41112016-02-01 11:20:47 +00001566 if (Style.Language == FormatStyle::LK_JavaScript &&
Daniel Jasper01b87832017-03-01 19:26:12 +00001567 Current->isOneOf(Keywords.kw_in, Keywords.kw_as))
Daniel Jasper1ce41112016-02-01 11:20:47 +00001568 return prec::Relational;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001569 if (Current->is(TT_BinaryOperator) || Current->is(tok::comma))
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001570 return Current->getPrecedence();
Daniel Jasper3c306e82015-06-03 17:08:40 +00001571 if (Current->isOneOf(tok::period, tok::arrow))
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001572 return PrecedenceArrowAndPeriod;
Daniel Jasper64650082016-06-14 11:28:02 +00001573 if ((Style.Language == FormatStyle::LK_Java ||
1574 Style.Language == FormatStyle::LK_JavaScript) &&
Daniel Jasper3c306e82015-06-03 17:08:40 +00001575 Current->isOneOf(Keywords.kw_extends, Keywords.kw_implements,
1576 Keywords.kw_throws))
Daniel Jasper50b4bd72014-11-02 19:16:41 +00001577 return 0;
Daniel Jasper0649d362013-08-23 15:14:03 +00001578 }
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001579 return -1;
Daniel Jasper0649d362013-08-23 15:14:03 +00001580 }
1581
Daniel Jasper2c611c02013-05-31 14:56:12 +00001582 void addFakeParenthesis(FormatToken *Start, prec::Level Precedence) {
1583 Start->FakeLParens.push_back(Precedence);
Daniel Jasper562ecd42013-09-06 08:08:14 +00001584 if (Precedence > prec::Unknown)
1585 Start->StartsBinaryExpression = true;
1586 if (Current) {
Daniel Jasper119ff532014-11-14 12:31:14 +00001587 FormatToken *Previous = Current->Previous;
Daniel Jasperc0956632014-12-03 14:02:59 +00001588 while (Previous->is(tok::comment) && Previous->Previous)
Daniel Jasper119ff532014-11-14 12:31:14 +00001589 Previous = Previous->Previous;
1590 ++Previous->FakeRParens;
Daniel Jasper562ecd42013-09-06 08:08:14 +00001591 if (Precedence > prec::Unknown)
Daniel Jasper119ff532014-11-14 12:31:14 +00001592 Previous->EndsBinaryExpression = true;
Daniel Jasper562ecd42013-09-06 08:08:14 +00001593 }
Daniel Jasper2c611c02013-05-31 14:56:12 +00001594 }
1595
Daniel Jasper0649d362013-08-23 15:14:03 +00001596 /// \brief Parse unary operator expressions and surround them with fake
1597 /// parentheses if appropriate.
1598 void parseUnaryOperator() {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001599 if (!Current || Current->isNot(TT_UnaryOperator)) {
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001600 parse(PrecedenceArrowAndPeriod);
Daniel Jasper0649d362013-08-23 15:14:03 +00001601 return;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001602 }
Daniel Jasper0649d362013-08-23 15:14:03 +00001603
1604 FormatToken *Start = Current;
1605 next();
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001606 parseUnaryOperator();
Daniel Jasper0649d362013-08-23 15:14:03 +00001607
Daniel Jasper0649d362013-08-23 15:14:03 +00001608 // The actual precedence doesn't matter.
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001609 addFakeParenthesis(Start, prec::Unknown);
Daniel Jasper0649d362013-08-23 15:14:03 +00001610 }
1611
Daniel Jasper2c611c02013-05-31 14:56:12 +00001612 void parseConditionalExpr() {
Daniel Jasper1a31bab2014-10-16 09:10:11 +00001613 while (Current && Current->isTrailingComment()) {
1614 next();
1615 }
Daniel Jasper2c611c02013-05-31 14:56:12 +00001616 FormatToken *Start = Current;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001617 parse(prec::LogicalOr);
Daniel Jasper2c611c02013-05-31 14:56:12 +00001618 if (!Current || !Current->is(tok::question))
1619 return;
1620 next();
Daniel Jasper6c22c442014-11-14 13:03:40 +00001621 parse(prec::Assignment);
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001622 if (!Current || Current->isNot(TT_ConditionalExpr))
Daniel Jasper2c611c02013-05-31 14:56:12 +00001623 return;
1624 next();
Daniel Jasper6c22c442014-11-14 13:03:40 +00001625 parse(prec::Assignment);
Daniel Jasper2c611c02013-05-31 14:56:12 +00001626 addFakeParenthesis(Start, prec::Conditional);
1627 }
1628
Daniel Jasper94e11d02014-09-04 14:58:30 +00001629 void next(bool SkipPastLeadingComments = true) {
Alexander Kornienkoafaa8f52013-06-17 13:19:53 +00001630 if (Current)
1631 Current = Current->Next;
Daniel Jasper94e11d02014-09-04 14:58:30 +00001632 while (Current &&
1633 (Current->NewlinesBefore == 0 || SkipPastLeadingComments) &&
1634 Current->isTrailingComment())
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001635 Current = Current->Next;
Daniel Jasper400adc62013-02-08 15:28:42 +00001636 }
1637
Daniel Jasper50b4bd72014-11-02 19:16:41 +00001638 const FormatStyle &Style;
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001639 const AdditionalKeywords &Keywords;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001640 FormatToken *Current;
Daniel Jasper400adc62013-02-08 15:28:42 +00001641};
1642
Craig Topper318ed7c2013-07-01 04:03:19 +00001643} // end anonymous namespace
1644
Nico Weberbeb03932015-01-09 23:25:06 +00001645void TokenAnnotator::setCommentLineLevels(
1646 SmallVectorImpl<AnnotatedLine *> &Lines) {
Craig Topper2145bc02014-05-09 08:15:10 +00001647 const AnnotatedLine *NextNonCommentLine = nullptr;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001648 for (SmallVectorImpl<AnnotatedLine *>::reverse_iterator I = Lines.rbegin(),
1649 E = Lines.rend();
1650 I != E; ++I) {
Krasimir Georgiev91834222017-01-25 13:58:58 +00001651 bool CommentLine = (*I)->First;
1652 for (const FormatToken *Tok = (*I)->First; Tok; Tok = Tok->Next) {
1653 if (!Tok->is(tok::comment)) {
1654 CommentLine = false;
1655 break;
1656 }
1657 }
1658 if (NextNonCommentLine && CommentLine)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001659 (*I)->Level = NextNonCommentLine->Level;
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001660 else
Craig Topper2145bc02014-05-09 08:15:10 +00001661 NextNonCommentLine = (*I)->First->isNot(tok::r_brace) ? (*I) : nullptr;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001662
1663 setCommentLineLevels((*I)->Children);
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001664 }
1665}
1666
Daniel Jasperfda47cd2016-10-31 13:23:00 +00001667static unsigned maxNestingDepth(const AnnotatedLine &Line) {
1668 unsigned Result = 0;
1669 for (const auto* Tok = Line.First; Tok != nullptr; Tok = Tok->Next)
1670 Result = std::max(Result, Tok->NestingLevel);
1671 return Result;
1672}
1673
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001674void TokenAnnotator::annotate(AnnotatedLine &Line) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001675 for (SmallVectorImpl<AnnotatedLine *>::iterator I = Line.Children.begin(),
1676 E = Line.Children.end();
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001677 I != E; ++I) {
1678 annotate(**I);
1679 }
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001680 AnnotatingParser Parser(Style, Line, Keywords);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001681 Line.Type = Parser.parseLine();
Daniel Jasperfda47cd2016-10-31 13:23:00 +00001682
1683 // With very deep nesting, ExpressionParser uses lots of stack and the
1684 // formatting algorithm is very slow. We're not going to do a good job here
1685 // anyway - it's probably generated code being formatted by mistake.
1686 // Just skip the whole line.
1687 if (maxNestingDepth(Line) > 50)
1688 Line.Type = LT_Invalid;
1689
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001690 if (Line.Type == LT_Invalid)
1691 return;
1692
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001693 ExpressionParser ExprParser(Style, Keywords, Line);
Daniel Jasper400adc62013-02-08 15:28:42 +00001694 ExprParser.parse();
1695
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001696 if (Line.startsWith(TT_ObjCMethodSpecifier))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001697 Line.Type = LT_ObjCMethodDecl;
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001698 else if (Line.startsWith(TT_ObjCDecl))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001699 Line.Type = LT_ObjCDecl;
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001700 else if (Line.startsWith(TT_ObjCProperty))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001701 Line.Type = LT_ObjCProperty;
1702
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001703 Line.First->SpacesRequiredBefore = 1;
1704 Line.First->CanBreakBefore = Line.First->MustBreakBefore;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001705}
1706
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001707// This function heuristically determines whether 'Current' starts the name of a
1708// function declaration.
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001709static bool isFunctionDeclarationName(const FormatToken &Current,
1710 const AnnotatedLine &Line) {
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001711 auto skipOperatorName = [](const FormatToken* Next) -> const FormatToken* {
1712 for (; Next; Next = Next->Next) {
1713 if (Next->is(TT_OverloadedOperatorLParen))
1714 return Next;
1715 if (Next->is(TT_OverloadedOperator))
1716 continue;
1717 if (Next->isOneOf(tok::kw_new, tok::kw_delete)) {
1718 // For 'new[]' and 'delete[]'.
1719 if (Next->Next && Next->Next->is(tok::l_square) &&
1720 Next->Next->Next && Next->Next->Next->is(tok::r_square))
1721 Next = Next->Next->Next;
1722 continue;
1723 }
1724
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001725 break;
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001726 }
1727 return nullptr;
1728 };
1729
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001730 // Find parentheses of parameter list.
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001731 const FormatToken *Next = Current.Next;
1732 if (Current.is(tok::kw_operator)) {
1733 if (Current.Previous && Current.Previous->is(tok::coloncolon))
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001734 return false;
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001735 Next = skipOperatorName(Next);
1736 } else {
1737 if (!Current.is(TT_StartOfName) || Current.NestingLevel != 0)
1738 return false;
1739 for (; Next; Next = Next->Next) {
1740 if (Next->is(TT_TemplateOpener)) {
1741 Next = Next->MatchingParen;
1742 } else if (Next->is(tok::coloncolon)) {
1743 Next = Next->Next;
1744 if (!Next)
1745 return false;
1746 if (Next->is(tok::kw_operator)) {
1747 Next = skipOperatorName(Next->Next);
1748 break;
1749 }
1750 if (!Next->is(tok::identifier))
1751 return false;
1752 } else if (Next->is(tok::l_paren)) {
1753 break;
1754 } else {
1755 return false;
1756 }
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001757 }
1758 }
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001759
Daniel Jasper697a8ec2017-02-07 21:38:16 +00001760 // Check whether parameter list can belong to a function declaration.
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001761 if (!Next || !Next->is(tok::l_paren) || !Next->MatchingParen)
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001762 return false;
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001763 // If the lines ends with "{", this is likely an function definition.
1764 if (Line.Last->is(tok::l_brace))
1765 return true;
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001766 if (Next->Next == Next->MatchingParen)
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001767 return true; // Empty parentheses.
1768 // If there is an &/&& after the r_paren, this is likely a function.
1769 if (Next->MatchingParen->Next &&
1770 Next->MatchingParen->Next->is(TT_PointerOrReference))
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001771 return true;
Daniel Jasper193cdd32015-01-19 10:52:16 +00001772 for (const FormatToken *Tok = Next->Next; Tok && Tok != Next->MatchingParen;
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001773 Tok = Tok->Next) {
Daniel Jasper697a8ec2017-02-07 21:38:16 +00001774 if (Tok->is(tok::l_paren) && Tok->MatchingParen) {
1775 Tok = Tok->MatchingParen;
1776 continue;
1777 }
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001778 if (Tok->is(tok::kw_const) || Tok->isSimpleTypeSpecifier() ||
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001779 Tok->isOneOf(TT_PointerOrReference, TT_StartOfName, tok::ellipsis))
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001780 return true;
Daniel Jasper0faa9132015-04-23 13:58:40 +00001781 if (Tok->isOneOf(tok::l_brace, tok::string_literal, TT_ObjCMethodExpr) ||
1782 Tok->Tok.isLiteral())
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001783 return false;
1784 }
1785 return false;
1786}
1787
Zachary Turner448592e2015-12-18 22:20:15 +00001788bool TokenAnnotator::mustBreakForReturnType(const AnnotatedLine &Line) const {
1789 assert(Line.MightBeFunctionDecl);
1790
1791 if ((Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_TopLevel ||
1792 Style.AlwaysBreakAfterReturnType ==
1793 FormatStyle::RTBS_TopLevelDefinitions) &&
1794 Line.Level > 0)
1795 return false;
1796
1797 switch (Style.AlwaysBreakAfterReturnType) {
1798 case FormatStyle::RTBS_None:
1799 return false;
1800 case FormatStyle::RTBS_All:
1801 case FormatStyle::RTBS_TopLevel:
1802 return true;
1803 case FormatStyle::RTBS_AllDefinitions:
1804 case FormatStyle::RTBS_TopLevelDefinitions:
1805 return Line.mightBeFunctionDefinition();
1806 }
1807
1808 return false;
1809}
1810
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001811void TokenAnnotator::calculateFormattingInformation(AnnotatedLine &Line) {
Daniel Jasper5f3ea472014-05-22 08:36:53 +00001812 for (SmallVectorImpl<AnnotatedLine *>::iterator I = Line.Children.begin(),
1813 E = Line.Children.end();
1814 I != E; ++I) {
1815 calculateFormattingInformation(**I);
1816 }
1817
Alexander Kornienko39856b72013-09-10 09:38:25 +00001818 Line.First->TotalLength =
1819 Line.First->IsMultiline ? Style.ColumnLimit : Line.First->ColumnWidth;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001820 FormatToken *Current = Line.First->Next;
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001821 bool InFunctionDecl = Line.MightBeFunctionDecl;
Craig Topper2145bc02014-05-09 08:15:10 +00001822 while (Current) {
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001823 if (isFunctionDeclarationName(*Current, Line))
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001824 Current->Type = TT_FunctionDeclarationName;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001825 if (Current->is(TT_LineComment)) {
Daniel Jasper84a12e12014-03-10 15:06:25 +00001826 if (Current->Previous->BlockKind == BK_BracedInit &&
1827 Current->Previous->opensScope())
Daniel Jasper5a611392013-12-19 21:41:37 +00001828 Current->SpacesRequiredBefore = Style.Cpp11BracedListStyle ? 0 : 1;
1829 else
1830 Current->SpacesRequiredBefore = Style.SpacesBeforeTrailingComments;
Daniel Jasper14e58e52014-03-21 11:58:45 +00001831
1832 // If we find a trailing comment, iterate backwards to determine whether
1833 // it seems to relate to a specific parameter. If so, break before that
1834 // parameter to avoid changing the comment's meaning. E.g. don't move 'b'
1835 // to the previous line in:
1836 // SomeFunction(a,
1837 // b, // comment
1838 // c);
Daniel Jasper28df0a32014-03-21 12:15:40 +00001839 if (!Current->HasUnescapedNewline) {
Daniel Jasper14e58e52014-03-21 11:58:45 +00001840 for (FormatToken *Parameter = Current->Previous; Parameter;
1841 Parameter = Parameter->Previous) {
1842 if (Parameter->isOneOf(tok::comment, tok::r_brace))
1843 break;
1844 if (Parameter->Previous && Parameter->Previous->is(tok::comma)) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001845 if (!Parameter->Previous->is(TT_CtorInitializerComma) &&
Daniel Jasper14e58e52014-03-21 11:58:45 +00001846 Parameter->HasUnescapedNewline)
1847 Parameter->MustBreakBefore = true;
1848 break;
1849 }
1850 }
1851 }
Daniel Jasperb88b25f2013-12-23 07:29:06 +00001852 } else if (Current->SpacesRequiredBefore == 0 &&
Daniel Jasper166c19b2014-05-06 14:12:21 +00001853 spaceRequiredBefore(Line, *Current)) {
Alexander Kornienko384b40b2013-10-11 21:43:05 +00001854 Current->SpacesRequiredBefore = 1;
Daniel Jasper5a611392013-12-19 21:41:37 +00001855 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001856
Daniel Jasperfb81b092013-09-17 09:52:48 +00001857 Current->MustBreakBefore =
1858 Current->MustBreakBefore || mustBreakBefore(Line, *Current);
1859
Zachary Turner448592e2015-12-18 22:20:15 +00001860 if (!Current->MustBreakBefore && InFunctionDecl &&
1861 Current->is(TT_FunctionDeclarationName))
1862 Current->MustBreakBefore = mustBreakForReturnType(Line);
Daniel Jasperca4ea1c2014-08-05 12:16:31 +00001863
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001864 Current->CanBreakBefore =
1865 Current->MustBreakBefore || canBreakBefore(Line, *Current);
Daniel Jasper5f3ea472014-05-22 08:36:53 +00001866 unsigned ChildSize = 0;
1867 if (Current->Previous->Children.size() == 1) {
1868 FormatToken &LastOfChild = *Current->Previous->Children[0]->Last;
1869 ChildSize = LastOfChild.isTrailingComment() ? Style.ColumnLimit
1870 : LastOfChild.TotalLength + 1;
1871 }
Nico Weberbeb03932015-01-09 23:25:06 +00001872 const FormatToken *Prev = Current->Previous;
Daniel Jasper56346192014-10-27 16:31:46 +00001873 if (Current->MustBreakBefore || Prev->Children.size() > 1 ||
1874 (Prev->Children.size() == 1 &&
1875 Prev->Children[0]->First->MustBreakBefore) ||
Alexander Kornienko39856b72013-09-10 09:38:25 +00001876 Current->IsMultiline)
Daniel Jasper56346192014-10-27 16:31:46 +00001877 Current->TotalLength = Prev->TotalLength + Style.ColumnLimit;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001878 else
Daniel Jasper56346192014-10-27 16:31:46 +00001879 Current->TotalLength = Prev->TotalLength + Current->ColumnWidth +
1880 ChildSize + Current->SpacesRequiredBefore;
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001881
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001882 if (Current->is(TT_CtorInitializerColon))
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001883 InFunctionDecl = false;
1884
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001885 // FIXME: Only calculate this if CanBreakBefore is true once static
1886 // initializers etc. are sorted out.
1887 // FIXME: Move magic numbers to a better place.
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001888 Current->SplitPenalty = 20 * Current->BindingStrength +
1889 splitPenalty(Line, *Current, InFunctionDecl);
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001890
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001891 Current = Current->Next;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001892 }
Daniel Jasper6bee6822013-04-08 20:33:42 +00001893
Manuel Klimek4fe43002013-05-22 12:51:29 +00001894 calculateUnbreakableTailLengths(Line);
Daniel Jasper7d42f3f2017-01-31 11:25:01 +00001895 unsigned IndentLevel = Line.Level;
Craig Topper2145bc02014-05-09 08:15:10 +00001896 for (Current = Line.First; Current != nullptr; Current = Current->Next) {
Daniel Jasper8de9ed02013-08-22 15:00:41 +00001897 if (Current->Role)
1898 Current->Role->precomputeFormattingInfos(Current);
Daniel Jasper7d42f3f2017-01-31 11:25:01 +00001899 if (Current->MatchingParen &&
1900 Current->MatchingParen->opensBlockOrBlockTypeList(Style)) {
1901 assert(IndentLevel > 0);
1902 --IndentLevel;
1903 }
1904 Current->IndentLevel = IndentLevel;
1905 if (Current->opensBlockOrBlockTypeList(Style))
1906 ++IndentLevel;
Daniel Jasper8de9ed02013-08-22 15:00:41 +00001907 }
1908
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001909 DEBUG({ printDebugInfo(Line); });
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001910}
1911
Manuel Klimek4fe43002013-05-22 12:51:29 +00001912void TokenAnnotator::calculateUnbreakableTailLengths(AnnotatedLine &Line) {
1913 unsigned UnbreakableTailLength = 0;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001914 FormatToken *Current = Line.Last;
Craig Topper2145bc02014-05-09 08:15:10 +00001915 while (Current) {
Manuel Klimek4fe43002013-05-22 12:51:29 +00001916 Current->UnbreakableTailLength = UnbreakableTailLength;
1917 if (Current->CanBreakBefore ||
1918 Current->isOneOf(tok::comment, tok::string_literal)) {
1919 UnbreakableTailLength = 0;
1920 } else {
1921 UnbreakableTailLength +=
Alexander Kornienko39856b72013-09-10 09:38:25 +00001922 Current->ColumnWidth + Current->SpacesRequiredBefore;
Manuel Klimek4fe43002013-05-22 12:51:29 +00001923 }
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001924 Current = Current->Previous;
Manuel Klimek4fe43002013-05-22 12:51:29 +00001925 }
1926}
1927
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001928unsigned TokenAnnotator::splitPenalty(const AnnotatedLine &Line,
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001929 const FormatToken &Tok,
1930 bool InFunctionDecl) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001931 const FormatToken &Left = *Tok.Previous;
1932 const FormatToken &Right = Tok;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001933
Daniel Jasperbca4bbe2013-05-28 11:30:49 +00001934 if (Left.is(tok::semi))
1935 return 0;
Daniel Jasper734d52b2014-11-14 10:15:56 +00001936
1937 if (Style.Language == FormatStyle::LK_Java) {
Daniel Jasper375815d2014-11-26 12:31:19 +00001938 if (Right.isOneOf(Keywords.kw_extends, Keywords.kw_throws))
Daniel Jasper734d52b2014-11-14 10:15:56 +00001939 return 1;
1940 if (Right.is(Keywords.kw_implements))
1941 return 2;
1942 if (Left.is(tok::comma) && Left.NestingLevel == 0)
1943 return 3;
Daniel Jasper41368e92014-11-27 15:37:42 +00001944 } else if (Style.Language == FormatStyle::LK_JavaScript) {
Daniel Jasper7325aee2015-05-08 08:38:52 +00001945 if (Right.is(Keywords.kw_function) && Left.isNot(tok::comma))
Daniel Jasper41368e92014-11-27 15:37:42 +00001946 return 100;
Daniel Jasperb9a52812015-07-10 13:39:26 +00001947 if (Left.is(TT_JsTypeColon))
Daniel Jasperf412e262016-01-08 10:51:24 +00001948 return 35;
Martin Probst6181da42016-08-25 10:13:21 +00001949 if ((Left.is(TT_TemplateString) && Left.TokenText.endswith("${")) ||
1950 (Right.is(TT_TemplateString) && Right.TokenText.startswith("}")))
1951 return 100;
Daniel Jasper734d52b2014-11-14 10:15:56 +00001952 }
1953
Daniel Jasper7209bb92016-12-13 11:16:42 +00001954 if (Right.is(tok::identifier) && Right.Next && Right.Next->is(TT_DictLiteral))
Daniel Jasperbca4bbe2013-05-28 11:30:49 +00001955 return 1;
Daniel Jasper7052ce62014-01-19 09:04:08 +00001956 if (Right.is(tok::l_square)) {
Daniel Jaspere1afb9b2015-12-30 12:23:00 +00001957 if (Style.Language == FormatStyle::LK_Proto)
Daniel Jasper7052ce62014-01-19 09:04:08 +00001958 return 1;
Daniel Jaspere1afb9b2015-12-30 12:23:00 +00001959 if (Left.is(tok::r_square))
Daniel Jasperf9168de2016-03-01 04:19:55 +00001960 return 200;
Daniel Jasper0ad28142015-05-13 08:47:16 +00001961 // Slightly prefer formatting local lambda definitions like functions.
1962 if (Right.is(TT_LambdaLSquare) && Left.is(tok::equal))
Daniel Jasper9c8a7742016-01-04 07:29:40 +00001963 return 35;
Daniel Jasper9970df12015-06-03 08:57:36 +00001964 if (!Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare,
1965 TT_ArrayInitializerLSquare))
Daniel Jasperecaba172014-06-10 13:27:57 +00001966 return 500;
Daniel Jasper7052ce62014-01-19 09:04:08 +00001967 }
Daniel Jasper734d52b2014-11-14 10:15:56 +00001968
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001969 if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
1970 Right.is(tok::kw_operator)) {
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001971 if (Line.startsWith(tok::kw_for) && Right.PartOfMultiVariableDeclStmt)
Daniel Jasper26d1b1d2013-02-24 18:54:32 +00001972 return 3;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001973 if (Left.is(TT_StartOfName))
Daniel Jasper3ca283a2015-05-15 09:58:11 +00001974 return 110;
Daniel Jasper63af7c42013-12-09 14:40:19 +00001975 if (InFunctionDecl && Right.NestingLevel == 0)
Daniel Jasper26d1b1d2013-02-24 18:54:32 +00001976 return Style.PenaltyReturnTypeOnItsOwnLine;
Daniel Jasper53643062013-08-19 10:16:18 +00001977 return 200;
Daniel Jasper26d1b1d2013-02-24 18:54:32 +00001978 }
Daniel Jasperb754a742015-03-12 15:04:53 +00001979 if (Right.is(TT_PointerOrReference))
Daniel Jasper414c9c62015-03-19 09:40:16 +00001980 return 190;
Daniel Jasper6f2b88a2015-06-05 13:18:09 +00001981 if (Right.is(TT_LambdaArrow))
Daniel Jaspere6623162015-03-02 10:35:13 +00001982 return 110;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001983 if (Left.is(tok::equal) && Right.is(tok::l_brace))
Daniel Jasperc79e4d22017-03-14 00:40:32 +00001984 return 160;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001985 if (Left.is(TT_CastRParen))
Daniel Jasper1bc1b502013-07-05 07:58:34 +00001986 return 100;
Daniel Jasper215d6c82014-01-22 08:04:52 +00001987 if (Left.is(tok::coloncolon) ||
1988 (Right.is(tok::period) && Style.Language == FormatStyle::LK_Proto))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001989 return 500;
Daniel Jasper83193602013-04-05 17:22:09 +00001990 if (Left.isOneOf(tok::kw_class, tok::kw_struct))
1991 return 5000;
Daniel Jasper99302ed2016-05-27 08:59:34 +00001992 if (Left.is(tok::comment))
1993 return 1000;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001994
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001995 if (Left.isOneOf(TT_RangeBasedForLoopColon, TT_InheritanceColon))
Daniel Jasper16b35622013-02-26 13:18:08 +00001996 return 2;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001997
Daniel Jasper4c6e0052013-08-27 14:24:43 +00001998 if (Right.isMemberAccess()) {
Daniel Jasperf901a572015-12-07 19:50:48 +00001999 // Breaking before the "./->" of a chained call/member access is reasonably
2000 // cheap, as formatting those with one call per line is generally
2001 // desirable. In particular, it should be cheaper to break before the call
2002 // than it is to break inside a call's parameters, which could lead to weird
2003 // "hanging" indents. The exception is the very last "./->" to support this
2004 // frequent pattern:
2005 //
2006 // aaaaaaaa.aaaaaaaa.bbbbbbb().ccccccccccccccccccccc(
2007 // dddddddd);
2008 //
2009 // which might otherwise be blown up onto many lines. Here, clang-format
2010 // won't produce "hanging" indents anyway as there is no other trailing
2011 // call.
Daniel Jasper00492f92016-01-05 13:03:50 +00002012 //
2013 // Also apply higher penalty is not a call as that might lead to a wrapping
2014 // like:
2015 //
2016 // aaaaaaa
2017 // .aaaaaaaaa.bbbbbbbb(cccccccc);
2018 return !Right.NextOperator || !Right.NextOperator->Previous->closesScope()
2019 ? 150
2020 : 35;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002021 }
2022
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002023 if (Right.is(TT_TrailingAnnotation) &&
Daniel Jaspere3f907f2014-06-02 09:52:08 +00002024 (!Right.Next || Right.Next->isNot(tok::l_paren))) {
Daniel Jasperec8e8382014-10-11 08:24:56 +00002025 // Moving trailing annotations to the next line is fine for ObjC method
2026 // declarations.
Daniel Jaspere285b8d2015-06-17 09:43:56 +00002027 if (Line.startsWith(TT_ObjCMethodSpecifier))
Daniel Jasperec8e8382014-10-11 08:24:56 +00002028 return 10;
Daniel Jasper5550de62014-02-17 07:57:46 +00002029 // Generally, breaking before a trailing annotation is bad unless it is
2030 // function-like. It seems to be especially preferable to keep standard
2031 // annotations (i.e. "const", "final" and "override") on the same line.
Daniel Jasper43e6a282013-12-16 15:01:54 +00002032 // Use a slightly higher penalty after ")" so that annotations like
2033 // "const override" are kept together.
Daniel Jasperb48d3af2014-04-09 10:01:49 +00002034 bool is_short_annotation = Right.TokenText.size() < 10;
Daniel Jasperb05a81d2014-05-09 13:11:16 +00002035 return (Left.is(tok::r_paren) ? 100 : 120) + (is_short_annotation ? 50 : 0);
Daniel Jasper43e6a282013-12-16 15:01:54 +00002036 }
Daniel Jasper13c37b32013-05-22 08:28:26 +00002037
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002038 // In for-loops, prefer breaking at ',' and ';'.
Daniel Jaspere285b8d2015-06-17 09:43:56 +00002039 if (Line.startsWith(tok::kw_for) && Left.is(tok::equal))
Daniel Jasper37905f72013-02-21 15:00:29 +00002040 return 4;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002041
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002042 // In Objective-C method expressions, prefer breaking before "param:" over
2043 // breaking after it.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002044 if (Right.is(TT_SelectorName))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002045 return 0;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002046 if (Left.is(tok::colon) && Left.is(TT_ObjCMethodExpr))
Daniel Jasper4bf0d802013-11-23 14:27:27 +00002047 return Line.MightBeFunctionDecl ? 50 : 500;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002048
Daniel Jasper6501f7e2015-10-27 12:38:37 +00002049 if (Left.is(tok::l_paren) && InFunctionDecl &&
2050 Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign)
Daniel Jasper6728fc12013-04-11 14:29:13 +00002051 return 100;
Daniel Jasper3bacc4d2015-07-07 16:09:39 +00002052 if (Left.is(tok::l_paren) && Left.Previous &&
2053 Left.Previous->isOneOf(tok::kw_if, tok::kw_for))
Daniel Jaspera42de762015-02-26 09:49:08 +00002054 return 1000;
Daniel Jasper126153a2013-12-27 06:39:56 +00002055 if (Left.is(tok::equal) && InFunctionDecl)
2056 return 110;
Daniel Jaspera5621202014-08-08 12:00:13 +00002057 if (Right.is(tok::r_brace))
2058 return 1;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002059 if (Left.is(TT_TemplateOpener))
Daniel Jasperea79ea12014-08-15 05:00:39 +00002060 return 100;
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +00002061 if (Left.opensScope()) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +00002062 if (Style.AlignAfterOpenBracket == FormatStyle::BAS_DontAlign)
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +00002063 return 0;
Daniel Jasper33b909c2013-10-25 14:29:37 +00002064 return Left.ParameterCount > 1 ? Style.PenaltyBreakBeforeFirstCallParameter
2065 : 19;
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +00002066 }
Daniel Jasper190fbda2015-01-14 10:36:31 +00002067 if (Left.is(TT_JavaAnnotation))
2068 return 50;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002069
Daniel Jasper7209bb92016-12-13 11:16:42 +00002070 if (Left.isOneOf(tok::plus, tok::comma) && Left.Previous &&
2071 Left.Previous->isLabelString() &&
Daniel Jasperf789f052016-12-20 15:27:46 +00002072 (Left.NextOperator || Left.OperatorIndex != 0))
Daniel Jasper23888612016-12-22 12:37:06 +00002073 return 45;
Daniel Jasperf789f052016-12-20 15:27:46 +00002074 if (Right.is(tok::plus) && Left.isLabelString() &&
2075 (Right.NextOperator || Right.OperatorIndex != 0))
2076 return 25;
Daniel Jasper7209bb92016-12-13 11:16:42 +00002077 if (Left.is(tok::comma))
2078 return 1;
Daniel Jasperf789f052016-12-20 15:27:46 +00002079 if (Right.is(tok::lessless) && Left.isLabelString() &&
Daniel Jasper7209bb92016-12-13 11:16:42 +00002080 (Right.NextOperator || Right.OperatorIndex != 1))
2081 return 25;
Daniel Jasper7aacf462016-12-19 11:14:23 +00002082 if (Right.is(tok::lessless)) {
2083 // Breaking at a << is really cheap.
2084 if (!Left.is(tok::r_paren) || Right.OperatorIndex > 0)
2085 // Slightly prefer to break before the first one in log-like statements.
2086 return 2;
2087 return 1;
2088 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002089 if (Left.is(TT_ConditionalExpr))
Daniel Jasper70bc8742013-02-26 13:59:14 +00002090 return prec::Conditional;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002091 prec::Level Level = Left.getPrecedence();
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002092 if (Level != prec::Unknown)
2093 return Level;
Daniel Jaspere92bf6f2015-05-06 14:23:38 +00002094 Level = Right.getPrecedence();
2095 if (Level != prec::Unknown)
2096 return Level;
Daniel Jasperf9a84b52013-03-01 16:48:32 +00002097
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002098 return 3;
2099}
2100
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00002101bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002102 const FormatToken &Left,
2103 const FormatToken &Right) {
Daniel Jasper166c19b2014-05-06 14:12:21 +00002104 if (Left.is(tok::kw_return) && Right.isNot(tok::semi))
2105 return true;
Daniel Jaspere9beea22014-01-28 15:20:33 +00002106 if (Style.ObjCSpaceAfterProperty && Line.Type == LT_ObjCProperty &&
2107 Left.Tok.getObjCKeywordID() == tok::objc_property)
2108 return true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002109 if (Right.is(tok::hashhash))
2110 return Left.is(tok::hash);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00002111 if (Left.isOneOf(tok::hashhash, tok::hash))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002112 return Right.is(tok::hash);
Daniel Jasperb55acad2013-08-20 12:36:34 +00002113 if (Left.is(tok::l_paren) && Right.is(tok::r_paren))
2114 return Style.SpaceInEmptyParentheses;
2115 if (Left.is(tok::l_paren) || Right.is(tok::r_paren))
Nico Weberbeb03932015-01-09 23:25:06 +00002116 return (Right.is(TT_CastRParen) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002117 (Left.MatchingParen && Left.MatchingParen->is(TT_CastRParen)))
Daniel Jasperb55acad2013-08-20 12:36:34 +00002118 ? Style.SpacesInCStyleCastParentheses
2119 : Style.SpacesInParentheses;
2120 if (Right.isOneOf(tok::semi, tok::comma))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002121 return false;
2122 if (Right.is(tok::less) &&
Sylvestre Ledru83bbd572016-08-09 14:24:40 +00002123 Line.Type == LT_ObjCDecl && Style.ObjCSpaceBeforeProtocolList)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002124 return true;
Sylvestre Ledru83bbd572016-08-09 14:24:40 +00002125 if (Right.is(tok::less) && Left.is(tok::kw_template))
2126 return Style.SpaceAfterTemplateKeyword;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00002127 if (Left.isOneOf(tok::exclaim, tok::tilde))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002128 return false;
2129 if (Left.is(tok::at) &&
Alexander Kornienko62b85b92013-03-13 14:41:29 +00002130 Right.isOneOf(tok::identifier, tok::string_literal, tok::char_constant,
2131 tok::numeric_constant, tok::l_paren, tok::l_brace,
2132 tok::kw_true, tok::kw_false))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002133 return false;
Daniel Jasperffbad0e2016-01-04 07:28:12 +00002134 if (Left.is(tok::colon))
2135 return !Left.is(TT_ObjCMethodExpr);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002136 if (Left.is(tok::coloncolon))
2137 return false;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00002138 if (Left.is(tok::less) || Right.isOneOf(tok::greater, tok::less))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002139 return false;
Daniel Jasperbafa6b72013-07-01 09:47:25 +00002140 if (Right.is(tok::ellipsis))
Daniel Jaspere2fab132016-05-19 06:19:17 +00002141 return Left.Tok.isLiteral() || (Left.is(tok::identifier) && Left.Previous &&
2142 Left.Previous->is(tok::kw_case));
Manuel Klimekbab25fd2013-09-04 08:20:47 +00002143 if (Left.is(tok::l_square) && Right.is(tok::amp))
2144 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002145 if (Right.is(TT_PointerOrReference))
Daniel Jasper2b4d6ea2016-06-08 08:23:46 +00002146 return (Left.is(tok::r_paren) && Line.MightBeFunctionDecl) ||
Daniel Jasper1f5d6372016-06-13 14:45:12 +00002147 (Left.Tok.isLiteral() || (Left.is(tok::kw_const) && Left.Previous &&
2148 Left.Previous->is(tok::r_paren)) ||
Daniel Jasper1c220482015-02-25 10:30:06 +00002149 (!Left.isOneOf(TT_PointerOrReference, tok::l_paren) &&
Daniel Jasperbea1ab42015-03-01 18:55:26 +00002150 (Style.PointerAlignment != FormatStyle::PAS_Left ||
Daniel Jasper85d1f0b2016-10-04 20:18:25 +00002151 (Line.IsMultiVariableDeclStmt &&
2152 (Left.NestingLevel == 0 ||
2153 (Left.NestingLevel == 1 && Line.First->is(tok::kw_for)))))));
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002154 if (Right.is(TT_FunctionTypeLParen) && Left.isNot(tok::l_paren) &&
2155 (!Left.is(TT_PointerOrReference) ||
Daniel Jasperbea1ab42015-03-01 18:55:26 +00002156 (Style.PointerAlignment != FormatStyle::PAS_Right &&
2157 !Line.IsMultiVariableDeclStmt)))
Daniel Jaspercfda5172013-05-08 14:58:20 +00002158 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002159 if (Left.is(TT_PointerOrReference))
Daniel Jasperc941e7d2017-01-09 11:04:07 +00002160 return Right.Tok.isLiteral() || Right.is(TT_BlockComment) ||
2161 (Right.isOneOf(Keywords.kw_override, Keywords.kw_final) &&
2162 !Right.is(TT_StartOfName)) ||
Daniel Jasper60ba32d2015-06-12 09:59:16 +00002163 (Right.is(tok::l_brace) && Right.BlockKind == BK_Block) ||
Daniel Jasper532a0312015-04-23 10:23:53 +00002164 (!Right.isOneOf(TT_PointerOrReference, TT_ArraySubscriptLSquare,
2165 tok::l_paren) &&
Daniel Jasperbea1ab42015-03-01 18:55:26 +00002166 (Style.PointerAlignment != FormatStyle::PAS_Right &&
2167 !Line.IsMultiVariableDeclStmt) &&
2168 Left.Previous &&
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002169 !Left.Previous->isOneOf(tok::l_paren, tok::coloncolon));
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002170 if (Right.is(tok::star) && Left.is(tok::l_paren))
2171 return false;
Nico Weber2a726b62013-02-10 02:08:05 +00002172 if (Left.is(tok::l_square))
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002173 return (Left.is(TT_ArrayInitializerLSquare) &&
Daniel Jasperad981f82014-08-26 11:41:14 +00002174 Style.SpacesInContainerLiterals && Right.isNot(tok::r_square)) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002175 (Left.is(TT_ArraySubscriptLSquare) && Style.SpacesInSquareBrackets &&
2176 Right.isNot(tok::r_square));
Nico Weber2a726b62013-02-10 02:08:05 +00002177 if (Right.is(tok::r_square))
Daniel Jasperad981f82014-08-26 11:41:14 +00002178 return Right.MatchingParen &&
2179 ((Style.SpacesInContainerLiterals &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002180 Right.MatchingParen->is(TT_ArrayInitializerLSquare)) ||
Daniel Jasperad981f82014-08-26 11:41:14 +00002181 (Style.SpacesInSquareBrackets &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002182 Right.MatchingParen->is(TT_ArraySubscriptLSquare)));
2183 if (Right.is(tok::l_square) &&
2184 !Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare) &&
2185 !Left.isOneOf(tok::numeric_constant, TT_DictLiteral))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002186 return false;
Daniel Jasper610381f2014-08-26 09:37:52 +00002187 if (Left.is(tok::l_brace) && Right.is(tok::r_brace))
2188 return !Left.Children.empty(); // No spaces in "{}".
2189 if ((Left.is(tok::l_brace) && Left.BlockKind != BK_Block) ||
2190 (Right.is(tok::r_brace) && Right.MatchingParen &&
2191 Right.MatchingParen->BlockKind != BK_Block))
2192 return !Style.Cpp11BracedListStyle;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002193 if (Left.is(TT_BlockComment))
Daniel Jasper484033b2014-05-06 14:41:29 +00002194 return !Left.TokenText.endswith("=*/");
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002195 if (Right.is(tok::l_paren)) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002196 if (Left.is(tok::r_paren) && Left.is(TT_AttributeParen))
Daniel Jasperee6d6502013-07-17 20:25:02 +00002197 return true;
Daniel Jasper79121232014-11-27 14:55:17 +00002198 return Line.Type == LT_ObjCDecl || Left.is(tok::semi) ||
Alexander Kornienkofdca83d2013-12-10 10:18:34 +00002199 (Style.SpaceBeforeParens != FormatStyle::SBPO_Never &&
Daniel Jasperd7884572015-08-14 12:44:06 +00002200 (Left.isOneOf(tok::kw_if, tok::pp_elif, tok::kw_for, tok::kw_while,
Daniel Jasper9cb1ac282015-10-07 15:09:08 +00002201 tok::kw_switch, tok::kw_case, TT_ForEachMacro,
2202 TT_ObjCForIn) ||
Nico Weberfac23712015-02-04 15:26:27 +00002203 (Left.isOneOf(tok::kw_try, Keywords.kw___except, tok::kw_catch,
2204 tok::kw_new, tok::kw_delete) &&
Daniel Jasper66cb8c52015-05-04 09:22:29 +00002205 (!Left.Previous || Left.Previous->isNot(tok::period))))) ||
Alexander Kornienkofdca83d2013-12-10 10:18:34 +00002206 (Style.SpaceBeforeParens == FormatStyle::SBPO_Always &&
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +00002207 (Left.is(tok::identifier) || Left.isFunctionLikeKeyword() ||
2208 Left.is(tok::r_paren)) &&
Alexander Kornienkofdca83d2013-12-10 10:18:34 +00002209 Line.Type != LT_PreprocessorDirective);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002210 }
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002211 if (Left.is(tok::at) && Right.Tok.getObjCKeywordID() != tok::objc_not_keyword)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002212 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002213 if (Right.is(TT_UnaryOperator))
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +00002214 return !Left.isOneOf(tok::l_paren, tok::l_square, tok::at) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002215 (Left.isNot(tok::colon) || Left.isNot(TT_ObjCMethodExpr));
Daniel Jasper4afc6b32014-06-02 10:57:55 +00002216 if ((Left.isOneOf(tok::identifier, tok::greater, tok::r_square,
2217 tok::r_paren) ||
Daniel Jasper7a2d60e2014-05-07 07:59:03 +00002218 Left.isSimpleTypeSpecifier()) &&
Manuel Klimekbab25fd2013-09-04 08:20:47 +00002219 Right.is(tok::l_brace) && Right.getNextNonComment() &&
2220 Right.BlockKind != BK_Block)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002221 return false;
Daniel Jasperbca4bbe2013-05-28 11:30:49 +00002222 if (Left.is(tok::period) || Right.is(tok::period))
2223 return false;
Alexander Kornienkod8d47fa2013-09-10 13:41:43 +00002224 if (Right.is(tok::hash) && Left.is(tok::identifier) && Left.TokenText == "L")
2225 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002226 if (Left.is(TT_TemplateCloser) && Left.MatchingParen &&
Daniel Jasper5ffcb7f2014-10-21 11:13:31 +00002227 Left.MatchingParen->Previous &&
2228 Left.MatchingParen->Previous->is(tok::period))
2229 // A.<B>DoSomething();
2230 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002231 if (Left.is(TT_TemplateCloser) && Right.is(tok::l_square))
Daniel Jasper6761b422014-11-18 23:48:01 +00002232 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002233 return true;
2234}
2235
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00002236bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
Daniel Jasper38efc132014-10-21 07:51:54 +00002237 const FormatToken &Right) {
2238 const FormatToken &Left = *Right.Previous;
Daniel Jasper23d3bcf2015-06-25 08:38:46 +00002239 if (Right.Tok.getIdentifierInfo() && Left.Tok.getIdentifierInfo())
2240 return true; // Never ever merge two identifiers.
Daniel Jasper1dbc2102017-03-31 13:30:24 +00002241 if (Style.isCpp()) {
Daniel Jasper23d3bcf2015-06-25 08:38:46 +00002242 if (Left.is(tok::kw_operator))
2243 return Right.is(tok::coloncolon);
2244 } else if (Style.Language == FormatStyle::LK_Proto) {
Daniel Jasper38efc132014-10-21 07:51:54 +00002245 if (Right.is(tok::period) &&
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002246 Left.isOneOf(Keywords.kw_optional, Keywords.kw_required,
Daniel Jasperd8d98392015-11-20 14:32:54 +00002247 Keywords.kw_repeated, Keywords.kw_extend))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002248 return true;
Daniel Jasper38efc132014-10-21 07:51:54 +00002249 if (Right.is(tok::l_paren) &&
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002250 Left.isOneOf(Keywords.kw_returns, Keywords.kw_option))
Daniel Jasper38efc132014-10-21 07:51:54 +00002251 return true;
2252 } else if (Style.Language == FormatStyle::LK_JavaScript) {
Daniel Jaspera4607e12016-03-17 12:17:59 +00002253 if (Left.is(TT_JsFatArrow))
2254 return true;
Martin Probsta050f412017-05-18 21:19:29 +00002255 // for await ( ...
2256 if (Right.is(tok::l_paren) && Left.is(Keywords.kw_await) &&
Martin Probstbd49e322017-05-15 19:33:20 +00002257 Left.Previous && Left.Previous->is(tok::kw_for))
2258 return true;
Martin Probst20371c32017-02-27 11:15:53 +00002259 if (Left.is(Keywords.kw_async) && Right.is(tok::l_paren) &&
2260 Right.MatchingParen) {
2261 const FormatToken *Next = Right.MatchingParen->getNextNonComment();
2262 // An async arrow function, for example: `x = async () => foo();`,
2263 // as opposed to calling a function called async: `x = async();`
2264 if (Next && Next->is(TT_JsFatArrow))
2265 return true;
2266 }
Martin Probst6181da42016-08-25 10:13:21 +00002267 if ((Left.is(TT_TemplateString) && Left.TokenText.endswith("${")) ||
2268 (Right.is(TT_TemplateString) && Right.TokenText.startswith("}")))
2269 return false;
2270 if (Left.is(tok::identifier) && Right.is(TT_TemplateString))
2271 return false;
Martin Probst5f8445b2016-04-24 22:05:09 +00002272 if (Right.is(tok::star) &&
2273 Left.isOneOf(Keywords.kw_function, Keywords.kw_yield))
2274 return false;
Daniel Jaspereb886632016-10-31 13:18:25 +00002275 if (Right.isOneOf(tok::l_brace, tok::l_square) &&
2276 Left.isOneOf(Keywords.kw_function, Keywords.kw_yield))
2277 return true;
Martin Probst4210d2f2016-09-22 07:18:00 +00002278 // JS methods can use some keywords as names (e.g. `delete()`).
2279 if (Right.is(tok::l_paren) && Line.MustBeDeclaration &&
2280 Left.Tok.getIdentifierInfo())
2281 return false;
Martin Probstc4a3d082017-04-05 10:56:07 +00002282 if ((Left.isOneOf(Keywords.kw_let, Keywords.kw_var, Keywords.kw_in,
2283 tok::kw_const) ||
2284 // "of" is only a keyword if it appears after another identifier
2285 // (e.g. as "const x of y" in a for loop).
2286 (Left.is(Keywords.kw_of) && Left.Previous &&
2287 Left.Previous->Tok.getIdentifierInfo())) &&
Daniel Jaspera4607e12016-03-17 12:17:59 +00002288 (!Left.Previous || !Left.Previous->is(tok::period)))
Daniel Jasper38efc132014-10-21 07:51:54 +00002289 return true;
Daniel Jasperb559b432016-11-01 06:23:10 +00002290 if (Left.isOneOf(tok::kw_for, Keywords.kw_as) && Left.Previous &&
Daniel Jasper4d67dd72016-11-01 06:22:54 +00002291 Left.Previous->is(tok::period) && Right.is(tok::l_paren))
2292 return false;
Martin Probsted87d782016-08-22 14:23:30 +00002293 if (Left.is(Keywords.kw_as) &&
2294 Right.isOneOf(tok::l_square, tok::l_brace, tok::l_paren))
2295 return true;
Daniel Jasper5e271462016-01-04 16:10:36 +00002296 if (Left.is(tok::kw_default) && Left.Previous &&
2297 Left.Previous->is(tok::kw_export))
2298 return true;
Daniel Jasper779c66f2015-12-30 08:00:58 +00002299 if (Left.is(Keywords.kw_is) && Right.is(tok::l_brace))
2300 return true;
Daniel Jaspera74f5072015-04-13 15:01:40 +00002301 if (Right.isOneOf(TT_JsTypeColon, TT_JsTypeOptionalQuestion))
Daniel Jasperb10bdff2015-02-18 17:09:53 +00002302 return false;
Daniel Jasper91b1d1a2016-03-21 17:57:31 +00002303 if (Left.is(TT_JsTypeOperator) || Right.is(TT_JsTypeOperator))
2304 return false;
Daniel Jasper354aa512015-02-19 16:07:32 +00002305 if ((Left.is(tok::l_brace) || Right.is(tok::r_brace)) &&
Daniel Jasperfca735c2015-02-19 16:14:18 +00002306 Line.First->isOneOf(Keywords.kw_import, tok::kw_export))
Daniel Jasper354aa512015-02-19 16:07:32 +00002307 return false;
Daniel Jasper08051992015-05-26 07:18:56 +00002308 if (Left.is(tok::ellipsis))
2309 return false;
Daniel Jasperbc46b932015-03-15 13:59:51 +00002310 if (Left.is(TT_TemplateCloser) &&
Daniel Jasperd2219062015-05-02 07:54:58 +00002311 !Right.isOneOf(tok::equal, tok::l_brace, tok::comma, tok::l_square,
Daniel Jasperbc46b932015-03-15 13:59:51 +00002312 Keywords.kw_implements, Keywords.kw_extends))
2313 // Type assertions ('<type>expr') are not followed by whitespace. Other
2314 // locations that should have whitespace following are identified by the
2315 // above set of follower tokens.
2316 return false;
Martin Probst22b8d2692017-03-13 09:14:23 +00002317 if (Right.is(TT_JsNonNullAssertion))
Martin Probst0eb40cf2016-06-13 00:49:54 +00002318 return false;
Martin Probst22b8d2692017-03-13 09:14:23 +00002319 if (Left.is(TT_JsNonNullAssertion) && Right.is(Keywords.kw_as))
Martin Probst34ecf422016-09-06 18:55:34 +00002320 return true; // "x! as string"
Daniel Jasperb9d3db62014-11-02 22:00:57 +00002321 } else if (Style.Language == FormatStyle::LK_Java) {
Daniel Jaspera0143fa2014-11-23 20:54:37 +00002322 if (Left.is(tok::r_square) && Right.is(tok::l_brace))
2323 return true;
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002324 if (Left.is(Keywords.kw_synchronized) && Right.is(tok::l_paren))
Daniel Jasperb9d3db62014-11-02 22:00:57 +00002325 return Style.SpaceBeforeParens != FormatStyle::SBPO_Never;
Daniel Jasper82c92752014-11-21 12:19:07 +00002326 if ((Left.isOneOf(tok::kw_static, tok::kw_public, tok::kw_private,
2327 tok::kw_protected) ||
Nico Webered501662015-01-13 22:32:50 +00002328 Left.isOneOf(Keywords.kw_final, Keywords.kw_abstract,
2329 Keywords.kw_native)) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002330 Right.is(TT_TemplateOpener))
Daniel Jasperdb9a7a22014-11-03 02:35:14 +00002331 return true;
Daniel Jasper38efc132014-10-21 07:51:54 +00002332 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002333 if (Left.is(TT_ImplicitStringLiteral))
Daniel Jasper38efc132014-10-21 07:51:54 +00002334 return Right.WhitespaceRange.getBegin() != Right.WhitespaceRange.getEnd();
2335 if (Line.Type == LT_ObjCMethodDecl) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002336 if (Left.is(TT_ObjCMethodSpecifier))
Daniel Jasper38efc132014-10-21 07:51:54 +00002337 return true;
2338 if (Left.is(tok::r_paren) && Right.is(tok::identifier))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002339 // Don't space between ')' and <id>
2340 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002341 }
2342 if (Line.Type == LT_ObjCProperty &&
Daniel Jasper38efc132014-10-21 07:51:54 +00002343 (Right.is(tok::equal) || Left.is(tok::equal)))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002344 return false;
2345
Daniel Jasper6f2b88a2015-06-05 13:18:09 +00002346 if (Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow) ||
2347 Left.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow))
Daniel Jasper6cdec7c2013-07-09 14:36:48 +00002348 return true;
Daniel Jasper804a2762016-01-09 15:56:40 +00002349 if (Right.is(TT_OverloadedOperatorLParen))
2350 return Style.SpaceBeforeParens == FormatStyle::SBPO_Always;
Daniel Jasper38efc132014-10-21 07:51:54 +00002351 if (Left.is(tok::comma))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002352 return true;
Daniel Jasper38efc132014-10-21 07:51:54 +00002353 if (Right.is(tok::comma))
Daniel Jasperff6c3a92013-02-28 13:40:17 +00002354 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002355 if (Right.isOneOf(TT_CtorInitializerColon, TT_ObjCBlockLParen))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002356 return true;
Daniel Jasper9326f912015-05-05 08:40:32 +00002357 if (Right.is(tok::colon)) {
2358 if (Line.First->isOneOf(tok::kw_case, tok::kw_default) ||
Daniel Jasper1fe0d5c2015-05-06 15:19:47 +00002359 !Right.getNextNonComment() || Right.getNextNonComment()->is(tok::semi))
Daniel Jasper9326f912015-05-05 08:40:32 +00002360 return false;
2361 if (Right.is(TT_ObjCMethodExpr))
2362 return false;
2363 if (Left.is(tok::question))
2364 return false;
2365 if (Right.is(TT_InlineASMColon) && Left.is(tok::coloncolon))
2366 return false;
2367 if (Right.is(TT_DictLiteral))
2368 return Style.SpacesInContainerLiterals;
2369 return true;
2370 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002371 if (Left.is(TT_UnaryOperator))
2372 return Right.is(TT_BinaryOperator);
Daniel Jaspercdb58b22015-05-15 09:05:31 +00002373
2374 // If the next token is a binary operator or a selector name, we have
2375 // incorrectly classified the parenthesis as a cast. FIXME: Detect correctly.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002376 if (Left.is(TT_CastRParen))
Daniel Jaspercdb58b22015-05-15 09:05:31 +00002377 return Style.SpaceAfterCStyleCast ||
2378 Right.isOneOf(TT_BinaryOperator, TT_SelectorName);
2379
Daniel Jaspere497bed2015-06-02 22:06:07 +00002380 if (Left.is(tok::greater) && Right.is(tok::greater))
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002381 return Right.is(TT_TemplateCloser) && Left.is(TT_TemplateCloser) &&
Daniel Jasperdd978ae2013-10-29 14:52:02 +00002382 (Style.Standard != FormatStyle::LS_Cpp11 || Style.SpacesInAngles);
Daniel Jasper38efc132014-10-21 07:51:54 +00002383 if (Right.isOneOf(tok::arrow, tok::period, tok::arrowstar, tok::periodstar) ||
2384 Left.isOneOf(tok::arrow, tok::period, tok::arrowstar, tok::periodstar))
Daniel Jasperff6c3a92013-02-28 13:40:17 +00002385 return false;
Daniel Jasperd94bff32013-09-25 15:15:02 +00002386 if (!Style.SpaceBeforeAssignmentOperators &&
Daniel Jasper38efc132014-10-21 07:51:54 +00002387 Right.getPrecedence() == prec::Assignment)
Daniel Jasperd94bff32013-09-25 15:15:02 +00002388 return false;
Daniel Jasper23c2b5a2017-02-17 10:44:07 +00002389 if (Right.is(tok::coloncolon) && Left.is(tok::identifier))
2390 // Generally don't remove existing spaces between an identifier and "::".
2391 // The identifier might actually be a macro name such as ALWAYS_INLINE. If
2392 // this turns out to be too lenient, add analysis of the identifier itself.
2393 return Right.WhitespaceRange.getBegin() != Right.WhitespaceRange.getEnd();
Daniel Jasper2b2c9672016-05-08 18:14:01 +00002394 if (Right.is(tok::coloncolon) && !Left.isOneOf(tok::l_brace, tok::comment))
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002395 return (Left.is(TT_TemplateOpener) &&
Daniel Jasperf322eb52014-10-23 20:22:22 +00002396 Style.Standard == FormatStyle::LS_Cpp03) ||
Daniel Jasper23c2b5a2017-02-17 10:44:07 +00002397 !(Left.isOneOf(tok::l_paren, tok::r_paren, tok::l_square,
Martin Probstc9c51c42017-03-16 10:21:35 +00002398 tok::kw___super, TT_TemplateCloser, TT_TemplateOpener));
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002399 if ((Left.is(TT_TemplateOpener)) != (Right.is(TT_TemplateCloser)))
Daniel Jasper16b107e2014-10-21 09:57:09 +00002400 return Style.SpacesInAngles;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002401 if ((Right.is(TT_BinaryOperator) && !Left.is(tok::l_paren)) ||
Daniel Jasper7fa524b2015-11-20 15:26:50 +00002402 (Left.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) &&
2403 !Right.is(tok::r_paren)))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002404 return true;
Daniel Jasperbeaa3222015-02-26 11:30:50 +00002405 if (Left.is(TT_TemplateCloser) && Right.is(tok::l_paren) &&
2406 Right.isNot(TT_FunctionTypeLParen))
Chad Rosier0a84f172014-08-05 17:58:54 +00002407 return Style.SpaceBeforeParens == FormatStyle::SBPO_Always;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002408 if (Right.is(TT_TemplateOpener) && Left.is(tok::r_paren) &&
2409 Left.MatchingParen && Left.MatchingParen->is(TT_OverloadedOperatorLParen))
Daniel Jasper8835a322014-10-20 13:56:30 +00002410 return false;
Daniel Jasper38efc132014-10-21 07:51:54 +00002411 if (Right.is(tok::less) && Left.isNot(tok::l_paren) &&
Daniel Jaspere285b8d2015-06-17 09:43:56 +00002412 Line.startsWith(tok::hash))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002413 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002414 if (Right.is(TT_TrailingUnaryOperator))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002415 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002416 if (Left.is(TT_RegexLiteral))
Daniel Jasperf9ae3122014-05-08 07:01:45 +00002417 return false;
Daniel Jasper38efc132014-10-21 07:51:54 +00002418 return spaceRequiredBetween(Line, Left, Right);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002419}
2420
Daniel Jaspere18ff372014-06-02 10:17:32 +00002421// Returns 'true' if 'Tok' is a brace we'd want to break before in Allman style.
2422static bool isAllmanBrace(const FormatToken &Tok) {
2423 return Tok.is(tok::l_brace) && Tok.BlockKind == BK_Block &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002424 !Tok.isOneOf(TT_ObjCBlockLBrace, TT_DictLiteral);
Daniel Jaspere18ff372014-06-02 10:17:32 +00002425}
2426
Daniel Jasperfb81b092013-09-17 09:52:48 +00002427bool TokenAnnotator::mustBreakBefore(const AnnotatedLine &Line,
2428 const FormatToken &Right) {
Daniel Jaspera125d532014-03-21 12:38:57 +00002429 const FormatToken &Left = *Right.Previous;
Manuel Klimek9e321992015-07-28 15:50:24 +00002430 if (Right.NewlinesBefore > 1 && Style.MaxEmptyLinesToKeep > 0)
Daniel Jaspera69ca9b2014-06-04 12:40:57 +00002431 return true;
Daniel Jasper64a328e2014-11-11 19:34:57 +00002432
Daniel Jasper9f4ec152015-06-17 09:44:07 +00002433 if (Style.Language == FormatStyle::LK_JavaScript) {
2434 // FIXME: This might apply to other languages and token kinds.
Daniel Jasperabd1f572016-03-02 22:44:03 +00002435 if (Right.is(tok::string_literal) && Left.is(tok::plus) && Left.Previous &&
2436 Left.Previous->is(tok::string_literal))
Daniel Jasper9f4ec152015-06-17 09:44:07 +00002437 return true;
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +00002438 if (Left.is(TT_DictLiteral) && Left.is(tok::l_brace) && Line.Level == 0 &&
2439 Left.Previous && Left.Previous->is(tok::equal) &&
2440 Line.First->isOneOf(tok::identifier, Keywords.kw_import, tok::kw_export,
2441 tok::kw_const) &&
Daniel Jasper9f642f72015-09-28 14:28:08 +00002442 // kw_var/kw_let are pseudo-tokens that are tok::identifier, so match
2443 // above.
2444 !Line.First->isOneOf(Keywords.kw_var, Keywords.kw_let))
Daniel Jasper9f4ec152015-06-17 09:44:07 +00002445 // Object literals on the top level of a file are treated as "enum-style".
2446 // Each key/value pair is put on a separate line, instead of bin-packing.
2447 return true;
2448 if (Left.is(tok::l_brace) && Line.Level == 0 &&
2449 (Line.startsWith(tok::kw_enum) ||
2450 Line.startsWith(tok::kw_export, tok::kw_enum)))
2451 // JavaScript top-level enum key/value pairs are put on separate lines
2452 // instead of bin-packing.
2453 return true;
2454 if (Right.is(tok::r_brace) && Left.is(tok::l_brace) &&
2455 !Left.Children.empty())
2456 // Support AllowShortFunctionsOnASingleLine for JavaScript.
2457 return Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_None ||
Daniel Jasper71e57452015-11-20 16:44:28 +00002458 Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_Empty ||
Daniel Jasper9f4ec152015-06-17 09:44:07 +00002459 (Left.NestingLevel == 0 && Line.Level == 0 &&
2460 Style.AllowShortFunctionsOnASingleLine ==
2461 FormatStyle::SFS_Inline);
2462 } else if (Style.Language == FormatStyle::LK_Java) {
2463 if (Right.is(tok::plus) && Left.is(tok::string_literal) && Right.Next &&
2464 Right.Next->is(tok::string_literal))
2465 return true;
Daniel Jasperf2019292017-01-31 12:07:35 +00002466 } else if (Style.Language == FormatStyle::LK_Cpp ||
Daniel Jasperda910e02017-02-03 08:29:02 +00002467 Style.Language == FormatStyle::LK_ObjC ||
2468 Style.Language == FormatStyle::LK_Proto) {
Alexander Kornienkod4fa2e62017-04-11 09:55:00 +00002469 if (Left.isStringLiteral() && Right.isStringLiteral())
Daniel Jasperf2019292017-01-31 12:07:35 +00002470 return true;
Daniel Jasper9f4ec152015-06-17 09:44:07 +00002471 }
2472
Martin Probst2c1cdae2017-05-15 11:15:29 +00002473 // If the last token before a '}', ']', or ')' is a comma or a trailing
2474 // comment, the intention is to insert a line break after it in order to make
Krasimir Georgiev994b6c92017-05-18 08:07:52 +00002475 // shuffling around entries easier. Import statements, especially in
2476 // JavaScript, can be an exception to this rule.
2477 if (Style.JavaScriptWrapImports || Line.Type != LT_ImportStatement) {
2478 const FormatToken *BeforeClosingBrace = nullptr;
2479 if ((Left.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) ||
2480 (Style.Language == FormatStyle::LK_JavaScript &&
2481 Left.is(tok::l_paren))) &&
2482 Left.BlockKind != BK_Block && Left.MatchingParen)
2483 BeforeClosingBrace = Left.MatchingParen->Previous;
2484 else if (Right.MatchingParen &&
2485 (Right.MatchingParen->isOneOf(tok::l_brace,
2486 TT_ArrayInitializerLSquare) ||
2487 (Style.Language == FormatStyle::LK_JavaScript &&
2488 Right.MatchingParen->is(tok::l_paren))))
2489 BeforeClosingBrace = &Left;
2490 if (BeforeClosingBrace && (BeforeClosingBrace->is(tok::comma) ||
2491 BeforeClosingBrace->isTrailingComment()))
2492 return true;
2493 }
Daniel Jasper64a328e2014-11-11 19:34:57 +00002494
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002495 if (Right.is(tok::comment))
Daniel Jasper64a328e2014-11-11 19:34:57 +00002496 return Left.BlockKind != BK_BracedInit &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002497 Left.isNot(TT_CtorInitializerColon) &&
Manuel Klimek1fcbe672014-04-11 12:27:47 +00002498 (Right.NewlinesBefore > 0 && Right.HasUnescapedNewline);
Daniel Jasper015c7a92015-05-11 15:15:48 +00002499 if (Left.isTrailingComment())
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +00002500 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002501 if (Right.Previous->IsUnterminatedLiteral)
Daniel Jasperfb81b092013-09-17 09:52:48 +00002502 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002503 if (Right.is(tok::lessless) && Right.Next &&
2504 Right.Previous->is(tok::string_literal) &&
2505 Right.Next->is(tok::string_literal))
Daniel Jasperfb81b092013-09-17 09:52:48 +00002506 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002507 if (Right.Previous->ClosesTemplateDeclaration &&
2508 Right.Previous->MatchingParen &&
2509 Right.Previous->MatchingParen->NestingLevel == 0 &&
2510 Style.AlwaysBreakTemplateDeclarations)
Daniel Jasperfb81b092013-09-17 09:52:48 +00002511 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002512 if ((Right.isOneOf(TT_CtorInitializerComma, TT_CtorInitializerColon)) &&
2513 Style.BreakConstructorInitializersBeforeComma &&
2514 !Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
Daniel Jasperfb81b092013-09-17 09:52:48 +00002515 return true;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +00002516 // Break only if we have multiple inheritance.
2517 if (Style.BreakBeforeInheritanceComma &&
2518 Right.is(TT_InheritanceComma))
2519 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002520 if (Right.is(tok::string_literal) && Right.TokenText.startswith("R\""))
Daniel Jasperc39b56f2013-12-16 07:23:08 +00002521 // Raw string literals are special wrt. line breaks. The author has made a
2522 // deliberate choice and might have aligned the contents of the string
2523 // literal accordingly. Thus, we try keep existing line breaks.
2524 return Right.NewlinesBefore > 0;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002525 if (Right.Previous->is(tok::l_brace) && Right.NestingLevel == 1 &&
2526 Style.Language == FormatStyle::LK_Proto)
Daniel Jasperce2fdb02014-10-27 13:25:59 +00002527 // Don't put enums onto single lines in protocol buffers.
Daniel Jasper7052ce62014-01-19 09:04:08 +00002528 return true;
Daniel Jasperc6366072015-05-10 08:42:04 +00002529 if (Right.is(TT_InlineASMBrace))
2530 return Right.HasUnescapedNewline;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002531 if (isAllmanBrace(Left) || isAllmanBrace(Right))
Daniel Jasperc1bc38e2015-09-29 14:57:55 +00002532 return (Line.startsWith(tok::kw_enum) && Style.BraceWrapping.AfterEnum) ||
2533 (Line.startsWith(tok::kw_class) && Style.BraceWrapping.AfterClass) ||
2534 (Line.startsWith(tok::kw_struct) && Style.BraceWrapping.AfterStruct);
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002535 if (Left.is(TT_ObjCBlockLBrace) && !Style.AllowShortBlocksOnASingleLine)
Daniel Jasper76284682014-10-22 09:12:44 +00002536 return true;
Daniel Jasperb175d572014-04-09 09:53:23 +00002537
Daniel Jasper354aa512015-02-19 16:07:32 +00002538 if ((Style.Language == FormatStyle::LK_Java ||
2539 Style.Language == FormatStyle::LK_JavaScript) &&
2540 Left.is(TT_LeadingJavaAnnotation) &&
2541 Right.isNot(TT_LeadingJavaAnnotation) && Right.isNot(tok::l_paren) &&
Nico Weber2cd92f12015-10-15 16:03:01 +00002542 (Line.Last->is(tok::l_brace) || Style.BreakAfterJavaFieldAnnotations))
Daniel Jasper354aa512015-02-19 16:07:32 +00002543 return true;
2544
Daniel Jasperfb81b092013-09-17 09:52:48 +00002545 return false;
2546}
2547
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00002548bool TokenAnnotator::canBreakBefore(const AnnotatedLine &Line,
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002549 const FormatToken &Right) {
2550 const FormatToken &Left = *Right.Previous;
Daniel Jasperf26c7552014-10-17 13:36:14 +00002551
Daniel Jasperc83d7692015-06-09 11:39:22 +00002552 // Language-specific stuff.
Daniel Jasperf26c7552014-10-17 13:36:14 +00002553 if (Style.Language == FormatStyle::LK_Java) {
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002554 if (Left.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
2555 Keywords.kw_implements))
Daniel Jasperf26c7552014-10-17 13:36:14 +00002556 return false;
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002557 if (Right.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
2558 Keywords.kw_implements))
Daniel Jasper58fcf6d2014-11-04 10:53:14 +00002559 return true;
Daniel Jasperc83d7692015-06-09 11:39:22 +00002560 } else if (Style.Language == FormatStyle::LK_JavaScript) {
Martin Probst56ff7aa2016-09-06 18:39:30 +00002561 const FormatToken *NonComment = Right.getPreviousNonComment();
Martin Probstb98ab892017-03-13 07:10:18 +00002562 if (NonComment &&
Martin Probst07a03072017-04-26 12:34:18 +00002563 NonComment->isOneOf(
2564 tok::kw_return, tok::kw_continue, tok::kw_break, tok::kw_throw,
2565 Keywords.kw_interface, Keywords.kw_type, tok::kw_static,
2566 tok::kw_public, tok::kw_private, tok::kw_protected,
2567 Keywords.kw_abstract, Keywords.kw_get, Keywords.kw_set))
Daniel Jasper11a87652016-01-14 05:37:52 +00002568 return false; // Otherwise a semicolon is inserted.
Daniel Jasperc83d7692015-06-09 11:39:22 +00002569 if (Left.is(TT_JsFatArrow) && Right.is(tok::l_brace))
2570 return false;
Daniel Jasper5a3de1d2015-07-03 10:37:23 +00002571 if (Left.is(TT_JsTypeColon))
2572 return true;
Daniel Jasper779c66f2015-12-30 08:00:58 +00002573 if (Right.NestingLevel == 0 && Right.is(Keywords.kw_is))
2574 return false;
Daniel Jasper1ce41112016-02-01 11:20:47 +00002575 if (Left.is(Keywords.kw_in))
2576 return Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None;
2577 if (Right.is(Keywords.kw_in))
2578 return Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None;
Martin Probstdce8e412016-06-22 14:35:14 +00002579 if (Right.is(Keywords.kw_as))
2580 return false; // must not break before as in 'x as type' casts
Daniel Jasper01b87832017-03-01 19:26:12 +00002581 if (Left.is(Keywords.kw_as))
2582 return true;
Martin Probst22b8d2692017-03-13 09:14:23 +00002583 if (Left.is(TT_JsNonNullAssertion))
2584 return true;
Martin Probst72fd75a2016-11-10 16:20:58 +00002585 if (Left.is(Keywords.kw_declare) &&
2586 Right.isOneOf(Keywords.kw_module, tok::kw_namespace,
2587 Keywords.kw_function, tok::kw_class, tok::kw_enum,
2588 Keywords.kw_interface, Keywords.kw_type, Keywords.kw_var,
2589 Keywords.kw_let, tok::kw_const))
2590 // See grammar for 'declare' statements at:
2591 // https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md#A.10
2592 return false;
2593 if (Left.isOneOf(Keywords.kw_module, tok::kw_namespace) &&
Daniel Jasper98e0b122017-02-20 14:51:16 +00002594 Right.isOneOf(tok::identifier, tok::string_literal))
Martin Probst72fd75a2016-11-10 16:20:58 +00002595 return false; // must not break in "module foo { ...}"
Daniel Jasper98e0b122017-02-20 14:51:16 +00002596 if (Right.is(TT_TemplateString) && Right.closesScope())
2597 return false;
2598 if (Left.is(TT_TemplateString) && Left.opensScope())
2599 return true;
Daniel Jasperf26c7552014-10-17 13:36:14 +00002600 }
2601
Daniel Jasper4bf0d802013-11-23 14:27:27 +00002602 if (Left.is(tok::at))
2603 return false;
Daniel Jasper437c3f52014-04-28 07:34:48 +00002604 if (Left.Tok.getObjCKeywordID() == tok::objc_interface)
2605 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002606 if (Left.isOneOf(TT_JavaAnnotation, TT_LeadingJavaAnnotation))
Daniel Jasper3e1bd142015-01-14 09:51:32 +00002607 return !Right.is(tok::l_paren);
Daniel Jasperb754a742015-03-12 15:04:53 +00002608 if (Right.is(TT_PointerOrReference))
2609 return Line.IsMultiVariableDeclStmt ||
2610 (Style.PointerAlignment == FormatStyle::PAS_Right &&
2611 (!Right.Next || Right.Next->isNot(TT_FunctionDeclarationName)));
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002612 if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
2613 Right.is(tok::kw_operator))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002614 return true;
Daniel Jasper414c9c62015-03-19 09:40:16 +00002615 if (Left.is(TT_PointerOrReference))
2616 return false;
Daniel Jasper165b29e2013-11-08 00:57:11 +00002617 if (Right.isTrailingComment())
2618 // We rely on MustBreakBefore being set correctly here as we should not
2619 // change the "binding" behavior of a comment.
Daniel Jasper5a611392013-12-19 21:41:37 +00002620 // The first comment in a braced lists is always interpreted as belonging to
2621 // the first list element. Otherwise, it should be placed outside of the
2622 // list.
2623 return Left.BlockKind == BK_BracedInit;
Daniel Jasper165b29e2013-11-08 00:57:11 +00002624 if (Left.is(tok::question) && Right.is(tok::colon))
2625 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002626 if (Right.is(TT_ConditionalExpr) || Right.is(tok::question))
Daniel Jasper165b29e2013-11-08 00:57:11 +00002627 return Style.BreakBeforeTernaryOperators;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002628 if (Left.is(TT_ConditionalExpr) || Left.is(tok::question))
Daniel Jasper165b29e2013-11-08 00:57:11 +00002629 return !Style.BreakBeforeTernaryOperators;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002630 if (Right.is(TT_InheritanceColon))
Daniel Jasper3a122c02014-02-14 18:22:40 +00002631 return true;
Daniel Jasperfd36f0b2016-11-12 07:38:22 +00002632 if (Right.is(TT_ObjCMethodExpr) && !Right.is(tok::r_square) &&
2633 Left.isNot(TT_SelectorName))
2634 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002635 if (Right.is(tok::colon) &&
2636 !Right.isOneOf(TT_CtorInitializerColon, TT_InlineASMColon))
Daniel Jasperd39312ec2014-05-28 10:09:11 +00002637 return false;
Daniel Jasperfd36f0b2016-11-12 07:38:22 +00002638 if (Left.is(tok::colon) && Left.isOneOf(TT_DictLiteral, TT_ObjCMethodExpr))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002639 return true;
Daniel Jaspera7b14262015-05-13 10:23:03 +00002640 if (Right.is(TT_SelectorName) || (Right.is(tok::identifier) && Right.Next &&
2641 Right.Next->is(TT_ObjCMethodExpr)))
Daniel Jaspered41f772015-05-19 11:06:33 +00002642 return Left.isNot(tok::period); // FIXME: Properly parse ObjC calls.
Daniel Jasper9688ff12013-08-01 13:46:58 +00002643 if (Left.is(tok::r_paren) && Line.Type == LT_ObjCProperty)
2644 return true;
Daniel Jasper788ffd72015-08-24 15:10:01 +00002645 if (Left.ClosesTemplateDeclaration || Left.is(TT_FunctionAnnotationRParen))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002646 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002647 if (Right.isOneOf(TT_RangeBasedForLoopColon, TT_OverloadedOperatorLParen,
2648 TT_OverloadedOperator))
Daniel Jaspereead02b2013-02-14 08:42:54 +00002649 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002650 if (Left.is(TT_RangeBasedForLoopColon))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002651 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002652 if (Right.is(TT_RangeBasedForLoopColon))
Daniel Jasper37905f72013-02-21 15:00:29 +00002653 return false;
Daniel Jaspera4322082016-11-05 17:43:16 +00002654 if (Left.is(TT_TemplateCloser) && Right.is(TT_TemplateOpener))
2655 return true;
Daniel Jasperb754a742015-03-12 15:04:53 +00002656 if (Left.isOneOf(TT_TemplateCloser, TT_UnaryOperator) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002657 Left.is(tok::kw_operator))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002658 return false;
Daniel Jaspercaf84fe2015-04-23 12:59:09 +00002659 if (Left.is(tok::equal) && !Right.isOneOf(tok::kw_default, tok::kw_delete) &&
Daniel Jasper100ffc62015-08-21 11:44:57 +00002660 Line.Type == LT_VirtualFunctionDecl && Left.NestingLevel == 0)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002661 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002662 if (Left.is(tok::l_paren) && Left.is(TT_AttributeParen))
Daniel Jasper559b63c2014-01-28 20:13:43 +00002663 return false;
2664 if (Left.is(tok::l_paren) && Left.Previous &&
Daniel Jaspera42de762015-02-26 09:49:08 +00002665 (Left.Previous->isOneOf(TT_BinaryOperator, TT_CastRParen)))
Daniel Jasper559b63c2014-01-28 20:13:43 +00002666 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002667 if (Right.is(TT_ImplicitStringLiteral))
Daniel Jasper98857842013-10-30 13:54:53 +00002668 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002669
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002670 if (Right.is(tok::r_paren) || Right.is(TT_TemplateCloser))
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00002671 return false;
Daniel Jasperb9edcfb2015-07-07 13:50:50 +00002672 if (Right.is(tok::r_square) && Right.MatchingParen &&
2673 Right.MatchingParen->is(TT_LambdaLSquare))
2674 return false;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00002675
Daniel Jasper13c37b32013-05-22 08:28:26 +00002676 // We only break before r_brace if there was a corresponding break before
2677 // the l_brace, which is tracked by BreakBeforeClosingBrace.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00002678 if (Right.is(tok::r_brace))
2679 return Right.MatchingParen && Right.MatchingParen->BlockKind == BK_Block;
Daniel Jasper13c37b32013-05-22 08:28:26 +00002680
Daniel Jasperf9a09062014-04-09 10:29:11 +00002681 // Allow breaking after a trailing annotation, e.g. after a method
2682 // declaration.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002683 if (Left.is(TT_TrailingAnnotation))
Daniel Jasperf9a09062014-04-09 10:29:11 +00002684 return !Right.isOneOf(tok::l_brace, tok::semi, tok::equal, tok::l_paren,
2685 tok::less, tok::coloncolon);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002686
Daniel Jasperbf4755b2013-03-14 09:50:46 +00002687 if (Right.is(tok::kw___attribute))
2688 return true;
2689
Daniel Jasperaf5ba0e2013-02-23 07:46:38 +00002690 if (Left.is(tok::identifier) && Right.is(tok::string_literal))
2691 return true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +00002692
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002693 if (Right.is(tok::identifier) && Right.Next && Right.Next->is(TT_DictLiteral))
Daniel Jasper783bac62014-04-15 09:54:30 +00002694 return true;
2695
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002696 if (Left.is(TT_CtorInitializerComma) &&
Daniel Jaspere33d4af2013-07-26 16:56:36 +00002697 Style.BreakConstructorInitializersBeforeComma)
2698 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002699 if (Right.is(TT_CtorInitializerComma) &&
Daniel Jasperec01cd62013-10-08 05:11:18 +00002700 Style.BreakConstructorInitializersBeforeComma)
2701 return true;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +00002702 if (Left.is(TT_InheritanceComma) && Style.BreakBeforeInheritanceComma)
2703 return false;
2704 if (Right.is(TT_InheritanceComma) && Style.BreakBeforeInheritanceComma)
2705 return true;
Jacques Pienaarfc275112015-02-18 23:48:37 +00002706 if ((Left.is(tok::greater) && Right.is(tok::greater)) ||
2707 (Left.is(tok::less) && Right.is(tok::less)))
Daniel Jasper0de8efa2013-09-17 08:15:46 +00002708 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002709 if (Right.is(TT_BinaryOperator) &&
Daniel Jasperac043c92014-09-15 11:11:00 +00002710 Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None &&
2711 (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_All ||
2712 Right.getPrecedence() != prec::Assignment))
Daniel Jasper0a1e5ac2014-05-13 08:01:47 +00002713 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002714 if (Left.is(TT_ArrayInitializerLSquare))
Daniel Jasper1db6c382013-10-22 15:30:28 +00002715 return true;
Daniel Jasper598dd332014-08-12 13:22:26 +00002716 if (Right.is(tok::kw_typename) && Left.isNot(tok::kw_const))
2717 return true;
Daniel Jasper043ac052015-07-03 10:12:53 +00002718 if ((Left.isBinaryOperator() || Left.is(TT_BinaryOperator)) &&
2719 !Left.isOneOf(tok::arrowstar, tok::lessless) &&
Daniel Jasperac043c92014-09-15 11:11:00 +00002720 Style.BreakBeforeBinaryOperators != FormatStyle::BOS_All &&
2721 (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None ||
2722 Left.getPrecedence() == prec::Assignment))
2723 return true;
2724 return Left.isOneOf(tok::comma, tok::coloncolon, tok::semi, tok::l_brace,
Daniel Jasper99302ed2016-05-27 08:59:34 +00002725 tok::kw_class, tok::kw_struct, tok::comment) ||
Daniel Jasper05cd9292015-03-26 18:46:28 +00002726 Right.isMemberAccess() ||
2727 Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow, tok::lessless,
2728 tok::colon, tok::l_square, tok::at) ||
Daniel Jasper1bc1b502013-07-05 07:58:34 +00002729 (Left.is(tok::r_paren) &&
Daniel Jasper559b63c2014-01-28 20:13:43 +00002730 Right.isOneOf(tok::identifier, tok::kw_const)) ||
Daniel Jasper2db1b4a2017-02-06 10:55:49 +00002731 (Left.is(tok::l_paren) && !Right.is(tok::r_paren)) ||
2732 (Left.is(TT_TemplateOpener) && !Right.is(TT_TemplateCloser));
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002733}
2734
Daniel Jasper6bee6822013-04-08 20:33:42 +00002735void TokenAnnotator::printDebugInfo(const AnnotatedLine &Line) {
2736 llvm::errs() << "AnnotatedTokens:\n";
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002737 const FormatToken *Tok = Line.First;
Daniel Jasper6bee6822013-04-08 20:33:42 +00002738 while (Tok) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002739 llvm::errs() << " M=" << Tok->MustBreakBefore
Birunthan Mohanathas67d81c82015-07-13 16:19:34 +00002740 << " C=" << Tok->CanBreakBefore
2741 << " T=" << getTokenTypeName(Tok->Type)
Daniel Jasperb10cbc42013-07-10 14:02:49 +00002742 << " S=" << Tok->SpacesRequiredBefore
Daniel Jasper17062ff2014-06-10 14:44:02 +00002743 << " B=" << Tok->BlockParameterCount
Martin Probst8e3eba02017-02-07 16:33:13 +00002744 << " BK=" << Tok->BlockKind
Daniel Jasperb10cbc42013-07-10 14:02:49 +00002745 << " P=" << Tok->SplitPenalty << " Name=" << Tok->Tok.getName()
Manuel Klimek71814b42013-10-11 21:25:45 +00002746 << " L=" << Tok->TotalLength << " PPK=" << Tok->PackingKind
2747 << " FakeLParens=";
Daniel Jasper6bee6822013-04-08 20:33:42 +00002748 for (unsigned i = 0, e = Tok->FakeLParens.size(); i != e; ++i)
2749 llvm::errs() << Tok->FakeLParens[i] << "/";
Daniel Jasper7209bb92016-12-13 11:16:42 +00002750 llvm::errs() << " FakeRParens=" << Tok->FakeRParens;
2751 llvm::errs() << " Text='" << Tok->TokenText << "'\n";
Daniel Jasperb05a81d2014-05-09 13:11:16 +00002752 if (!Tok->Next)
Manuel Klimek71814b42013-10-11 21:25:45 +00002753 assert(Tok == Line.Last);
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002754 Tok = Tok->Next;
Daniel Jasper6bee6822013-04-08 20:33:42 +00002755 }
2756 llvm::errs() << "----\n";
2757}
2758
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002759} // namespace format
2760} // namespace clang