blob: 1f1a32a2b2cc90dac3026b8a80cf16c5778d7e12 [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;
137 } else if (Left->Previous &&
Daniel Jasper033181b2015-08-13 13:43:51 +0000138 (Left->Previous->isOneOf(tok::kw_static_assert, tok::kw_decltype,
139 tok::kw_if, tok::kw_while, tok::l_paren,
140 tok::comma) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000141 Left->Previous->is(TT_BinaryOperator))) {
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000142 // static_assert, if and while usually contain expressions.
Daniel Jasper8b1c6352013-08-01 17:58:23 +0000143 Contexts.back().IsExpression = true;
Daniel Jasper91b1d1a2016-03-21 17:57:31 +0000144 } else if (Style.Language == FormatStyle::LK_JavaScript && Left->Previous &&
Martin Probst2ec23242016-06-09 22:49:04 +0000145 (Left->Previous->is(Keywords.kw_function) ||
146 (Left->Previous->endsSequence(tok::identifier,
147 Keywords.kw_function)))) {
148 // function(...) or function f(...)
Daniel Jasper91b1d1a2016-03-21 17:57:31 +0000149 Contexts.back().IsExpression = false;
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000150 } else if (Left->Previous && Left->Previous->is(tok::r_square) &&
151 Left->Previous->MatchingParen &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000152 Left->Previous->MatchingParen->is(TT_LambdaLSquare)) {
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000153 // This is a parameter list of a lambda expression.
154 Contexts.back().IsExpression = false;
Daniel Jasper99b5a462015-05-12 10:20:32 +0000155 } else if (Line.InPPDirective &&
Daniel Jasperdf51f2e62016-01-11 12:55:33 +0000156 (!Left->Previous || !Left->Previous->is(tok::identifier))) {
Daniel Jasper99b5a462015-05-12 10:20:32 +0000157 Contexts.back().IsExpression = true;
Daniel Jasperc13ee342014-03-27 09:43:54 +0000158 } else if (Contexts[Contexts.size() - 2].CaretFound) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000159 // This is the parameter list of an ObjC block.
160 Contexts.back().IsExpression = false;
Daniel Jasper559b63c2014-01-28 20:13:43 +0000161 } else if (Left->Previous && Left->Previous->is(tok::kw___attribute)) {
162 Left->Type = TT_AttributeParen;
Daniel Jasper66cb8c52015-05-04 09:22:29 +0000163 } else if (Left->Previous && Left->Previous->is(TT_ForEachMacro)) {
Daniel Jaspere1e43192014-04-01 12:55:11 +0000164 // The first argument to a foreach macro is a declaration.
165 Contexts.back().IsForEachMacro = true;
166 Contexts.back().IsExpression = false;
Daniel Jasperf1f267b2014-10-21 07:57:50 +0000167 } else if (Left->Previous && Left->Previous->MatchingParen &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000168 Left->Previous->MatchingParen->is(TT_ObjCBlockLParen)) {
Daniel Jasperf1f267b2014-10-21 07:57:50 +0000169 Contexts.back().IsExpression = false;
Daniel Jaspera85c3312015-12-28 07:44:25 +0000170 } else if (!Line.MustBeDeclaration && !Line.InPPDirective) {
171 bool IsForOrCatch =
172 Left->Previous && Left->Previous->isOneOf(tok::kw_for, tok::kw_catch);
173 Contexts.back().IsExpression = !IsForOrCatch;
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000174 }
Daniel Jasper8b1c6352013-08-01 17:58:23 +0000175
Daniel Jasperc697ad22013-02-06 10:05:46 +0000176 if (StartsObjCMethodExpr) {
177 Contexts.back().ColonIsObjCMethodExpr = true;
178 Left->Type = TT_ObjCMethodExpr;
179 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000180
Daniel Jaspera85c3312015-12-28 07:44:25 +0000181 bool MightBeFunctionType = CurrentToken->isOneOf(tok::star, tok::amp) &&
182 !Contexts[Contexts.size() - 2].IsExpression;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000183 bool HasMultipleLines = false;
184 bool HasMultipleParametersOnALine = false;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000185 bool MightBeObjCForRangeLoop =
186 Left->Previous && Left->Previous->is(tok::kw_for);
Craig Topper2145bc02014-05-09 08:15:10 +0000187 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000188 // LookForDecls is set when "if (" has been seen. Check for
189 // 'identifier' '*' 'identifier' followed by not '=' -- this
190 // '*' has to be a binary operator but determineStarAmpUsage() will
191 // categorize it as an unary operator, so set the right type here.
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000192 if (LookForDecls && CurrentToken->Next) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000193 FormatToken *Prev = CurrentToken->getPreviousNonComment();
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000194 if (Prev) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000195 FormatToken *PrevPrev = Prev->getPreviousNonComment();
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000196 FormatToken *Next = CurrentToken->Next;
197 if (PrevPrev && PrevPrev->is(tok::identifier) &&
198 Prev->isOneOf(tok::star, tok::amp, tok::ampamp) &&
199 CurrentToken->is(tok::identifier) && Next->isNot(tok::equal)) {
200 Prev->Type = TT_BinaryOperator;
201 LookForDecls = false;
202 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000203 }
204 }
205
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000206 if (CurrentToken->Previous->is(TT_PointerOrReference) &&
Daniel Jasper59036852013-08-12 12:16:34 +0000207 CurrentToken->Previous->Previous->isOneOf(tok::l_paren,
208 tok::coloncolon))
209 MightBeFunctionType = true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000210 if (CurrentToken->Previous->is(TT_BinaryOperator))
Daniel Jasper91beebd2014-06-30 13:44:47 +0000211 Contexts.back().IsExpression = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000212 if (CurrentToken->is(tok::r_paren)) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000213 if (MightBeFunctionType && CurrentToken->Next &&
Daniel Jasper655d96a2013-07-16 11:37:21 +0000214 (CurrentToken->Next->is(tok::l_paren) ||
215 (CurrentToken->Next->is(tok::l_square) &&
Daniel Jaspera85c3312015-12-28 07:44:25 +0000216 Line.MustBeDeclaration)))
Daniel Jasper37194282013-05-28 08:33:00 +0000217 Left->Type = TT_FunctionTypeLParen;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000218 Left->MatchingParen = CurrentToken;
219 CurrentToken->MatchingParen = Left;
220
Daniel Jasper54353da2016-01-07 14:36:11 +0000221 if (CurrentToken->Next && CurrentToken->Next->is(tok::l_brace) &&
222 Left->Previous && Left->Previous->is(tok::l_paren)) {
223 // Detect the case where macros are used to generate lambdas or
224 // function bodies, e.g.:
225 // auto my_lambda = MARCO((Type *type, int i) { .. body .. });
226 for (FormatToken *Tok = Left; Tok != CurrentToken; Tok = Tok->Next) {
227 if (Tok->is(TT_BinaryOperator) &&
228 Tok->isOneOf(tok::star, tok::amp, tok::ampamp))
229 Tok->Type = TT_PointerOrReference;
230 }
231 }
232
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000233 if (StartsObjCMethodExpr) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000234 CurrentToken->Type = TT_ObjCMethodExpr;
Craig Topper2145bc02014-05-09 08:15:10 +0000235 if (Contexts.back().FirstObjCSelectorName) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000236 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
237 Contexts.back().LongestObjCSelectorName;
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000238 }
239 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000240
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000241 if (Left->is(TT_AttributeParen))
Daniel Jasper559b63c2014-01-28 20:13:43 +0000242 CurrentToken->Type = TT_AttributeParen;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000243 if (Left->Previous && Left->Previous->is(TT_JavaAnnotation))
Daniel Jasperf1f0c352014-10-21 09:25:39 +0000244 CurrentToken->Type = TT_JavaAnnotation;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000245 if (Left->Previous && Left->Previous->is(TT_LeadingJavaAnnotation))
Daniel Jaspere9ab42d2014-10-31 18:23:49 +0000246 CurrentToken->Type = TT_LeadingJavaAnnotation;
Daniel Jasper559b63c2014-01-28 20:13:43 +0000247
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000248 if (!HasMultipleLines)
249 Left->PackingKind = PPK_Inconclusive;
250 else if (HasMultipleParametersOnALine)
251 Left->PackingKind = PPK_BinPacked;
252 else
253 Left->PackingKind = PPK_OnePerLine;
254
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000255 next();
256 return true;
257 }
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000258 if (CurrentToken->isOneOf(tok::r_square, tok::r_brace))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000259 return false;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000260
261 if (CurrentToken->is(tok::l_brace))
Daniel Jasper31745732014-01-19 07:46:32 +0000262 Left->Type = TT_Unknown; // Not TT_ObjCBlockLParen
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000263 if (CurrentToken->is(tok::comma) && CurrentToken->Next &&
264 !CurrentToken->Next->HasUnescapedNewline &&
265 !CurrentToken->Next->isTrailingComment())
266 HasMultipleParametersOnALine = true;
Daniel Jaspercc7bf7f2014-04-03 09:00:49 +0000267 if (CurrentToken->isOneOf(tok::kw_const, tok::kw_auto) ||
Daniel Jasperc580af92014-03-11 09:29:46 +0000268 CurrentToken->isSimpleTypeSpecifier())
269 Contexts.back().IsExpression = false;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000270 if (CurrentToken->isOneOf(tok::semi, tok::colon))
271 MightBeObjCForRangeLoop = false;
272 if (MightBeObjCForRangeLoop && CurrentToken->is(Keywords.kw_in))
273 CurrentToken->Type = TT_ObjCForIn;
Daniel Jasper3a26a8d2015-05-13 12:54:30 +0000274 // When we discover a 'new', we set CanBeExpression to 'false' in order to
275 // parse the type correctly. Reset that after a comma.
276 if (CurrentToken->is(tok::comma))
277 Contexts.back().CanBeExpression = true;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000278
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000279 FormatToken *Tok = CurrentToken;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000280 if (!consumeToken())
281 return false;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000282 updateParameterCount(Left, Tok);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000283 if (CurrentToken && CurrentToken->HasUnescapedNewline)
284 HasMultipleLines = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000285 }
286 return false;
287 }
288
289 bool parseSquare() {
290 if (!CurrentToken)
291 return false;
292
Alexander Kornienkoafaa8f52013-06-17 13:19:53 +0000293 // A '[' could be an index subscript (after an identifier or after
Nico Weber2a726b62013-02-10 02:08:05 +0000294 // ')' or ']'), it could be the start of an Objective-C method
Eric Christopher2c4555a2015-06-19 01:52:53 +0000295 // expression, or it could the start of an Objective-C array literal.
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000296 FormatToken *Left = CurrentToken->Previous;
Daniel Jasperde7ca752015-05-04 07:39:00 +0000297 Left->ParentBracket = Contexts.back().ContextKind;
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000298 FormatToken *Parent = Left->getPreviousNonComment();
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000299 bool StartsObjCMethodExpr =
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000300 Style.Language == FormatStyle::LK_Cpp &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000301 Contexts.back().CanBeExpression && Left->isNot(TT_LambdaLSquare) &&
Daniel Jasper89519082014-05-09 10:26:08 +0000302 CurrentToken->isNot(tok::l_brace) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000303 (!Parent ||
304 Parent->isOneOf(tok::colon, tok::l_square, tok::l_paren,
305 tok::kw_return, tok::kw_throw) ||
306 Parent->isUnaryOperator() ||
307 Parent->isOneOf(TT_ObjCForIn, TT_CastRParen) ||
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000308 getBinOpPrecedence(Parent->Tok.getKind(), true, true) > prec::Unknown);
Daniel Jaspera1ea4cb2013-10-26 17:00:22 +0000309 bool ColonFound = false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000310
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000311 unsigned BindingIncrease = 1;
312 if (Left->is(TT_Unknown)) {
313 if (StartsObjCMethodExpr) {
314 Left->Type = TT_ObjCMethodExpr;
Daniel Jasper8c42d442015-05-29 06:19:49 +0000315 } else if (Style.Language == FormatStyle::LK_JavaScript && Parent &&
Daniel Jasper4284e362015-06-02 14:20:08 +0000316 Contexts.back().ContextKind == tok::l_brace &&
Daniel Jasper8c42d442015-05-29 06:19:49 +0000317 Parent->isOneOf(tok::l_brace, tok::comma)) {
318 Left->Type = TT_JsComputedPropertyName;
Daniel Jasperccff4d12016-01-04 07:27:33 +0000319 } else if (Style.Language == FormatStyle::LK_Proto ||
320 (Parent &&
Daniel Jasperebcb71f2016-01-04 13:11:41 +0000321 Parent->isOneOf(TT_BinaryOperator, tok::at, tok::comma,
322 tok::l_paren, tok::l_square, tok::question,
Daniel Jasperb14f6672016-01-04 15:51:56 +0000323 tok::colon, tok::kw_return,
324 // Should only be relevant to JavaScript:
325 tok::kw_default))) {
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000326 Left->Type = TT_ArrayInitializerLSquare;
327 } else {
328 BindingIncrease = 10;
329 Left->Type = TT_ArraySubscriptLSquare;
330 }
Daniel Jasperc697ad22013-02-06 10:05:46 +0000331 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000332
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000333 ScopedContextCreator ContextCreator(*this, tok::l_square, BindingIncrease);
334 Contexts.back().IsExpression = true;
335 Contexts.back().ColonIsObjCMethodExpr = StartsObjCMethodExpr;
336
Craig Topper2145bc02014-05-09 08:15:10 +0000337 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000338 if (CurrentToken->is(tok::r_square)) {
Daniel Jasper9a8d48b2013-09-05 10:04:31 +0000339 if (CurrentToken->Next && CurrentToken->Next->is(tok::l_paren) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000340 Left->is(TT_ObjCMethodExpr)) {
Nico Weber5d2624e2013-02-06 06:20:11 +0000341 // An ObjC method call is rarely followed by an open parenthesis.
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000342 // FIXME: Do we incorrectly label ":" with this?
343 StartsObjCMethodExpr = false;
344 Left->Type = TT_Unknown;
345 }
Daniel Jasper139d4a32014-04-08 13:07:41 +0000346 if (StartsObjCMethodExpr && CurrentToken->Previous != Left) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000347 CurrentToken->Type = TT_ObjCMethodExpr;
Nico Weber5d2624e2013-02-06 06:20:11 +0000348 // determineStarAmpUsage() thinks that '*' '[' is allocating an
349 // array of pointers, but if '[' starts a selector then '*' is a
350 // binary operator.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000351 if (Parent && Parent->is(TT_PointerOrReference))
Nico Weberac9bde22013-02-06 16:54:35 +0000352 Parent->Type = TT_BinaryOperator;
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000353 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000354 Left->MatchingParen = CurrentToken;
355 CurrentToken->MatchingParen = Left;
Craig Topper2145bc02014-05-09 08:15:10 +0000356 if (Contexts.back().FirstObjCSelectorName) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000357 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
358 Contexts.back().LongestObjCSelectorName;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000359 if (Left->BlockParameterCount > 1)
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000360 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName = 0;
361 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000362 next();
363 return true;
364 }
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000365 if (CurrentToken->isOneOf(tok::r_paren, tok::r_brace))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000366 return false;
Daniel Jasperea772b4d2014-10-16 08:38:51 +0000367 if (CurrentToken->is(tok::colon)) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000368 if (Left->is(TT_ArraySubscriptLSquare)) {
Daniel Jasperea772b4d2014-10-16 08:38:51 +0000369 Left->Type = TT_ObjCMethodExpr;
370 StartsObjCMethodExpr = true;
371 Contexts.back().ColonIsObjCMethodExpr = true;
372 if (Parent && Parent->is(tok::r_paren))
373 Parent->Type = TT_CastRParen;
374 }
Daniel Jaspera1ea4cb2013-10-26 17:00:22 +0000375 ColonFound = true;
Daniel Jasperea772b4d2014-10-16 08:38:51 +0000376 }
Daniel Jasperf841d3a2015-05-28 07:21:50 +0000377 if (CurrentToken->is(tok::comma) && Left->is(TT_ObjCMethodExpr) &&
378 !ColonFound)
Daniel Jasper1db6c382013-10-22 15:30:28 +0000379 Left->Type = TT_ArrayInitializerLSquare;
Nico Weberbeb03932015-01-09 23:25:06 +0000380 FormatToken *Tok = CurrentToken;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000381 if (!consumeToken())
382 return false;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000383 updateParameterCount(Left, Tok);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000384 }
385 return false;
386 }
387
388 bool parseBrace() {
Craig Topper2145bc02014-05-09 08:15:10 +0000389 if (CurrentToken) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000390 FormatToken *Left = CurrentToken->Previous;
Daniel Jasperde7ca752015-05-04 07:39:00 +0000391 Left->ParentBracket = Contexts.back().ContextKind;
Daniel Jasperc13ee342014-03-27 09:43:54 +0000392
393 if (Contexts.back().CaretFound)
394 Left->Type = TT_ObjCBlockLBrace;
395 Contexts.back().CaretFound = false;
396
Daniel Jasperb596fb22013-10-24 10:31:50 +0000397 ScopedContextCreator ContextCreator(*this, tok::l_brace, 1);
398 Contexts.back().ColonIsDictLiteral = true;
Daniel Jasper39485162014-05-22 09:00:33 +0000399 if (Left->BlockKind == BK_BracedInit)
400 Contexts.back().IsExpression = true;
Nico Weberced7d412013-05-26 05:39:26 +0000401
Craig Topper2145bc02014-05-09 08:15:10 +0000402 while (CurrentToken) {
Daniel Jasper8e357692013-05-06 08:27:33 +0000403 if (CurrentToken->is(tok::r_brace)) {
404 Left->MatchingParen = CurrentToken;
405 CurrentToken->MatchingParen = Left;
406 next();
407 return true;
408 }
409 if (CurrentToken->isOneOf(tok::r_paren, tok::r_square))
410 return false;
411 updateParameterCount(Left, CurrentToken);
Daniel Jasper497d9fd2014-08-15 05:00:35 +0000412 if (CurrentToken->isOneOf(tok::colon, tok::l_brace)) {
413 FormatToken *Previous = CurrentToken->getPreviousNonComment();
Daniel Jasper4d724492015-10-12 03:19:07 +0000414 if (((CurrentToken->is(tok::colon) &&
415 (!Contexts.back().ColonIsDictLiteral ||
416 Style.Language != FormatStyle::LK_Cpp)) ||
Daniel Jasper168c8aa2014-08-27 11:53:26 +0000417 Style.Language == FormatStyle::LK_Proto) &&
Daniel Jasperb18425b2016-03-01 04:19:47 +0000418 (Previous->Tok.getIdentifierInfo() ||
Daniel Jasperabd1f572016-03-02 22:44:03 +0000419 Previous->is(tok::string_literal)))
Daniel Jasper497d9fd2014-08-15 05:00:35 +0000420 Previous->Type = TT_SelectorName;
Daniel Jasper739ec532015-04-04 07:56:55 +0000421 if (CurrentToken->is(tok::colon) ||
422 Style.Language == FormatStyle::LK_JavaScript)
Daniel Jasper497d9fd2014-08-15 05:00:35 +0000423 Left->Type = TT_DictLiteral;
Daniel Jasper17062ff2014-06-10 14:44:02 +0000424 }
Daniel Jasper8e357692013-05-06 08:27:33 +0000425 if (!consumeToken())
426 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000427 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000428 }
429 return true;
430 }
Daniel Jasperdc7d5812013-02-20 12:56:39 +0000431
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000432 void updateParameterCount(FormatToken *Left, FormatToken *Current) {
Daniel Jasper9f4c9d42016-02-07 22:17:13 +0000433 if (Current->is(tok::l_brace) && Current->BlockKind == BK_Block)
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000434 ++Left->BlockParameterCount;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000435 if (Current->is(tok::comma)) {
Daniel Jaspere11095a2013-02-14 15:01:34 +0000436 ++Left->ParameterCount;
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000437 if (!Left->Role)
438 Left->Role.reset(new CommaSeparatedList(Style));
439 Left->Role->CommaFound(Current);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000440 } else if (Left->ParameterCount == 0 && Current->isNot(tok::comment)) {
Daniel Jaspere11095a2013-02-14 15:01:34 +0000441 Left->ParameterCount = 1;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000442 }
Daniel Jaspere11095a2013-02-14 15:01:34 +0000443 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000444
445 bool parseConditional() {
Craig Topper2145bc02014-05-09 08:15:10 +0000446 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000447 if (CurrentToken->is(tok::colon)) {
448 CurrentToken->Type = TT_ConditionalExpr;
449 next();
450 return true;
451 }
452 if (!consumeToken())
453 return false;
454 }
455 return false;
456 }
457
458 bool parseTemplateDeclaration() {
Craig Topper2145bc02014-05-09 08:15:10 +0000459 if (CurrentToken && CurrentToken->is(tok::less)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000460 CurrentToken->Type = TT_TemplateOpener;
461 next();
462 if (!parseAngle())
463 return false;
Craig Topper2145bc02014-05-09 08:15:10 +0000464 if (CurrentToken)
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000465 CurrentToken->Previous->ClosesTemplateDeclaration = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000466 return true;
467 }
468 return false;
469 }
470
471 bool consumeToken() {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000472 FormatToken *Tok = CurrentToken;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000473 next();
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000474 switch (Tok->Tok.getKind()) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000475 case tok::plus:
476 case tok::minus:
Craig Topper2145bc02014-05-09 08:15:10 +0000477 if (!Tok->Previous && Line.MustBeDeclaration)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000478 Tok->Type = TT_ObjCMethodSpecifier;
479 break;
480 case tok::colon:
Craig Topper2145bc02014-05-09 08:15:10 +0000481 if (!Tok->Previous)
Daniel Jasper850677d2013-03-18 12:50:26 +0000482 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000483 // Colons from ?: are handled in parseConditional().
Daniel Jaspera74f5072015-04-13 15:01:40 +0000484 if (Style.Language == FormatStyle::LK_JavaScript) {
Daniel Jasper9326f912015-05-05 08:40:32 +0000485 if (Contexts.back().ColonIsForRangeExpr || // colon in for loop
486 (Contexts.size() == 1 && // switch/case labels
Daniel Jaspera74f5072015-04-13 15:01:40 +0000487 !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) ||
Daniel Jasper9326f912015-05-05 08:40:32 +0000488 Contexts.back().ContextKind == tok::l_paren || // function params
489 Contexts.back().ContextKind == tok::l_square || // array type
Daniel Jasper81dbb562015-06-03 08:43:18 +0000490 (Contexts.size() == 1 &&
491 Line.MustBeDeclaration)) { // method/property declaration
Daniel Jaspera74f5072015-04-13 15:01:40 +0000492 Tok->Type = TT_JsTypeColon;
493 break;
494 }
495 }
Daniel Jasperffbad0e2016-01-04 07:28:12 +0000496 if (Contexts.back().ColonIsDictLiteral ||
497 Style.Language == FormatStyle::LK_Proto) {
Daniel Jasperb596fb22013-10-24 10:31:50 +0000498 Tok->Type = TT_DictLiteral;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000499 } else if (Contexts.back().ColonIsObjCMethodExpr ||
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000500 Line.startsWith(TT_ObjCMethodSpecifier)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000501 Tok->Type = TT_ObjCMethodExpr;
Daniel Jasper17062ff2014-06-10 14:44:02 +0000502 Tok->Previous->Type = TT_SelectorName;
Alexander Kornienko39856b72013-09-10 09:38:25 +0000503 if (Tok->Previous->ColumnWidth >
Daniel Jasper06a26952016-01-04 07:29:07 +0000504 Contexts.back().LongestObjCSelectorName)
Alexander Kornienko60d1b042013-10-10 13:36:20 +0000505 Contexts.back().LongestObjCSelectorName = Tok->Previous->ColumnWidth;
Craig Topper2145bc02014-05-09 08:15:10 +0000506 if (!Contexts.back().FirstObjCSelectorName)
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000507 Contexts.back().FirstObjCSelectorName = Tok->Previous;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000508 } else if (Contexts.back().ColonIsForRangeExpr) {
Daniel Jaspera74f5072015-04-13 15:01:40 +0000509 Tok->Type = TT_RangeBasedForLoopColon;
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000510 } else if (CurrentToken && CurrentToken->is(tok::numeric_constant)) {
Alexander Kornienko60d1b042013-10-10 13:36:20 +0000511 Tok->Type = TT_BitFieldColon;
Daniel Jasperd39312ec2014-05-28 10:09:11 +0000512 } else if (Contexts.size() == 1 &&
513 !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) {
Daniel Jasper56ef6ac2016-03-01 21:41:58 +0000514 if (Tok->Previous->isOneOf(tok::r_paren, tok::kw_noexcept))
Daniel Jasperb10bdff2015-02-18 17:09:53 +0000515 Tok->Type = TT_CtorInitializerColon;
516 else
517 Tok->Type = TT_InheritanceColon;
Daniel Jasper78580792014-10-20 12:01:45 +0000518 } else if (Tok->Previous->is(tok::identifier) && Tok->Next &&
519 Tok->Next->isOneOf(tok::r_paren, tok::comma)) {
520 // This handles a special macro in ObjC code where selectors including
521 // the colon are passed as macro arguments.
522 Tok->Type = TT_ObjCMethodExpr;
Daniel Jasper40aacf42013-03-14 13:45:21 +0000523 } else if (Contexts.back().ContextKind == tok::l_paren) {
Daniel Jaspera74f5072015-04-13 15:01:40 +0000524 Tok->Type = TT_InlineASMColon;
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000525 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000526 break;
Daniel Jasper91b1d1a2016-03-21 17:57:31 +0000527 case tok::pipe:
528 case tok::amp:
529 // | and & in declarations/type expressions represent union and
530 // intersection types, respectively.
531 if (Style.Language == FormatStyle::LK_JavaScript &&
532 !Contexts.back().IsExpression)
533 Tok->Type = TT_JsTypeOperator;
534 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000535 case tok::kw_if:
536 case tok::kw_while:
Craig Topper2145bc02014-05-09 08:15:10 +0000537 if (CurrentToken && CurrentToken->is(tok::l_paren)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000538 next();
Nico Weber9096fc02013-06-26 00:30:14 +0000539 if (!parseParens(/*LookForDecls=*/true))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000540 return false;
541 }
542 break;
543 case tok::kw_for:
Daniel Jasper997cf2f2016-05-20 06:16:01 +0000544 if (Style.Language == FormatStyle::LK_JavaScript && Tok->Previous &&
545 Tok->Previous->is(tok::period))
546 break;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000547 Contexts.back().ColonIsForRangeExpr = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000548 next();
549 if (!parseParens())
550 return false;
551 break;
552 case tok::l_paren:
Birunthan Mohanathas525579d2015-07-15 19:11:58 +0000553 // When faced with 'operator()()', the kw_operator handler incorrectly
554 // marks the first l_paren as a OverloadedOperatorLParen. Here, we make
555 // the first two parens OverloadedOperators and the second l_paren an
556 // OverloadedOperatorLParen.
557 if (Tok->Previous &&
558 Tok->Previous->is(tok::r_paren) &&
559 Tok->Previous->MatchingParen &&
560 Tok->Previous->MatchingParen->is(TT_OverloadedOperatorLParen)) {
561 Tok->Previous->Type = TT_OverloadedOperator;
562 Tok->Previous->MatchingParen->Type = TT_OverloadedOperator;
563 Tok->Type = TT_OverloadedOperatorLParen;
564 }
565
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000566 if (!parseParens())
567 return false;
Daniel Jasperbc5cb4e2013-11-07 17:43:07 +0000568 if (Line.MustBeDeclaration && Contexts.size() == 1 &&
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000569 !Contexts.back().IsExpression && !Line.startsWith(TT_ObjCProperty) &&
Daniel Jaspera831c582015-01-14 09:47:57 +0000570 (!Tok->Previous ||
Daniel Jaspera5fa4d12015-07-06 11:30:34 +0000571 !Tok->Previous->isOneOf(tok::kw_decltype, tok::kw___attribute,
572 TT_LeadingJavaAnnotation)))
Daniel Jasper26d1b1d2013-02-24 18:54:32 +0000573 Line.MightBeFunctionDecl = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000574 break;
575 case tok::l_square:
576 if (!parseSquare())
577 return false;
578 break;
579 case tok::l_brace:
580 if (!parseBrace())
581 return false;
582 break;
583 case tok::less:
Daniel Jasper0c9772e2016-02-05 14:17:16 +0000584 if (parseAngle()) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000585 Tok->Type = TT_TemplateOpener;
Daniel Jasperb13135b2015-01-08 08:48:21 +0000586 } else {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000587 Tok->Type = TT_BinaryOperator;
Daniel Jasper4d9ec172015-05-06 08:38:24 +0000588 NonTemplateLess.insert(Tok);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000589 CurrentToken = Tok;
590 next();
591 }
592 break;
593 case tok::r_paren:
594 case tok::r_square:
595 return false;
596 case tok::r_brace:
597 // Lines can start with '}'.
Craig Topper2145bc02014-05-09 08:15:10 +0000598 if (Tok->Previous)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000599 return false;
600 break;
601 case tok::greater:
602 Tok->Type = TT_BinaryOperator;
603 break;
604 case tok::kw_operator:
Daniel Jasper42401c82013-09-02 09:20:39 +0000605 while (CurrentToken &&
606 !CurrentToken->isOneOf(tok::l_paren, tok::semi, tok::r_paren)) {
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000607 if (CurrentToken->isOneOf(tok::star, tok::amp))
Daniel Jasper35d2dc72013-02-11 08:01:18 +0000608 CurrentToken->Type = TT_PointerOrReference;
609 consumeToken();
Daniel Jasper804a2762016-01-09 15:56:40 +0000610 if (CurrentToken &&
611 CurrentToken->Previous->isOneOf(TT_BinaryOperator, tok::comma))
Daniel Jasperd215b8b2013-08-28 07:27:35 +0000612 CurrentToken->Previous->Type = TT_OverloadedOperator;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000613 }
Daniel Jasper8f9624b2013-05-10 07:59:58 +0000614 if (CurrentToken) {
Daniel Jasper35d2dc72013-02-11 08:01:18 +0000615 CurrentToken->Type = TT_OverloadedOperatorLParen;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000616 if (CurrentToken->Previous->is(TT_BinaryOperator))
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000617 CurrentToken->Previous->Type = TT_OverloadedOperator;
Daniel Jasper8f9624b2013-05-10 07:59:58 +0000618 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000619 break;
620 case tok::question:
Daniel Jaspera74f5072015-04-13 15:01:40 +0000621 if (Style.Language == FormatStyle::LK_JavaScript && Tok->Next &&
Daniel Jasper56691b82015-06-11 13:29:20 +0000622 Tok->Next->isOneOf(tok::semi, tok::comma, tok::colon, tok::r_paren,
Daniel Jaspera74f5072015-04-13 15:01:40 +0000623 tok::r_brace)) {
Daniel Jasper9326f912015-05-05 08:40:32 +0000624 // Question marks before semicolons, colons, etc. indicate optional
625 // types (fields, parameters), e.g.
626 // function(x?: string, y?) {...}
627 // class X { y?; }
Daniel Jaspera74f5072015-04-13 15:01:40 +0000628 Tok->Type = TT_JsTypeOptionalQuestion;
629 break;
630 }
Daniel Jasper9326f912015-05-05 08:40:32 +0000631 // Declarations cannot be conditional expressions, this can only be part
632 // of a type declaration.
633 if (Line.MustBeDeclaration &&
634 Style.Language == FormatStyle::LK_JavaScript)
635 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000636 parseConditional();
637 break;
638 case tok::kw_template:
639 parseTemplateDeclaration();
640 break;
Daniel Jaspera628c982013-04-03 13:36:17 +0000641 case tok::comma:
Daniel Jaspere4ab49e2015-04-20 12:54:29 +0000642 if (Contexts.back().InCtorInitializer)
643 Tok->Type = TT_CtorInitializerComma;
Daniel Jasperd6e09e82015-05-19 11:51:39 +0000644 else if (Contexts.back().FirstStartOfName &&
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000645 (Contexts.size() == 1 || Line.startsWith(tok::kw_for))) {
Daniel Jaspera628c982013-04-03 13:36:17 +0000646 Contexts.back().FirstStartOfName->PartOfMultiVariableDeclStmt = true;
Daniel Jasperbea1ab42015-03-01 18:55:26 +0000647 Line.IsMultiVariableDeclStmt = true;
648 }
Daniel Jaspere1e43192014-04-01 12:55:11 +0000649 if (Contexts.back().IsForEachMacro)
650 Contexts.back().IsExpression = true;
Daniel Jaspera628c982013-04-03 13:36:17 +0000651 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000652 default:
653 break;
654 }
655 return true;
656 }
657
658 void parseIncludeDirective() {
Craig Topper2145bc02014-05-09 08:15:10 +0000659 if (CurrentToken && CurrentToken->is(tok::less)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000660 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000661 while (CurrentToken) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000662 if (CurrentToken->isNot(tok::comment) || CurrentToken->Next)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000663 CurrentToken->Type = TT_ImplicitStringLiteral;
664 next();
665 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000666 }
667 }
668
669 void parseWarningOrError() {
670 next();
671 // We still want to format the whitespace left of the first token of the
672 // warning or error.
673 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000674 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000675 CurrentToken->Type = TT_ImplicitStringLiteral;
676 next();
677 }
678 }
679
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000680 void parsePragma() {
681 next(); // Consume "pragma".
Daniel Jasperee4a8a12015-04-22 09:45:42 +0000682 if (CurrentToken &&
683 CurrentToken->isOneOf(Keywords.kw_mark, Keywords.kw_option)) {
684 bool IsMark = CurrentToken->is(Keywords.kw_mark);
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000685 next(); // Consume "mark".
686 next(); // Consume first token (so we fix leading whitespace).
Craig Topper2145bc02014-05-09 08:15:10 +0000687 while (CurrentToken) {
Daniel Jasperee4a8a12015-04-22 09:45:42 +0000688 if (IsMark || CurrentToken->Previous->is(TT_BinaryOperator))
689 CurrentToken->Type = TT_ImplicitStringLiteral;
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000690 next();
691 }
692 }
693 }
694
Daniel Jasper616de8642014-11-23 16:46:28 +0000695 LineType parsePreprocessorDirective() {
Martin Probst7ea9b6d2016-05-29 14:41:36 +0000696 bool IsFirstToken = CurrentToken->IsFirst;
Daniel Jasper616de8642014-11-23 16:46:28 +0000697 LineType Type = LT_PreprocessorDirective;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000698 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000699 if (!CurrentToken)
Daniel Jasper616de8642014-11-23 16:46:28 +0000700 return Type;
Martin Probst7ea9b6d2016-05-29 14:41:36 +0000701
702 if (Style.Language == FormatStyle::LK_JavaScript && IsFirstToken) {
703 // JavaScript files can contain shebang lines of the form:
704 // #!/usr/bin/env node
705 // Treat these like C++ #include directives.
706 while (CurrentToken) {
707 // Tokens cannot be comments here.
708 CurrentToken->Type = TT_ImplicitStringLiteral;
709 next();
710 }
711 return LT_ImportStatement;
712 }
713
Alexander Kornienko384b40b2013-10-11 21:43:05 +0000714 if (CurrentToken->Tok.is(tok::numeric_constant)) {
715 CurrentToken->SpacesRequiredBefore = 1;
Daniel Jasper616de8642014-11-23 16:46:28 +0000716 return Type;
Alexander Kornienko384b40b2013-10-11 21:43:05 +0000717 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000718 // Hashes in the middle of a line can lead to any strange token
719 // sequence.
Craig Topper2145bc02014-05-09 08:15:10 +0000720 if (!CurrentToken->Tok.getIdentifierInfo())
Daniel Jasper616de8642014-11-23 16:46:28 +0000721 return Type;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000722 switch (CurrentToken->Tok.getIdentifierInfo()->getPPKeywordID()) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000723 case tok::pp_include:
Daniel Jasperfa3f8fb2015-05-19 11:22:29 +0000724 case tok::pp_include_next:
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000725 case tok::pp_import:
Daniel Jasper343643b2014-08-13 08:29:18 +0000726 next();
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000727 parseIncludeDirective();
Daniel Jasper616de8642014-11-23 16:46:28 +0000728 Type = LT_ImportStatement;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000729 break;
730 case tok::pp_error:
731 case tok::pp_warning:
732 parseWarningOrError();
733 break;
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000734 case tok::pp_pragma:
735 parsePragma();
736 break;
Daniel Jasper4431aa92013-04-23 13:54:04 +0000737 case tok::pp_if:
738 case tok::pp_elif:
Daniel Jasper7cfde412014-01-21 08:56:09 +0000739 Contexts.back().IsExpression = true;
Daniel Jasper4431aa92013-04-23 13:54:04 +0000740 parseLine();
741 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000742 default:
743 break;
744 }
Craig Topper2145bc02014-05-09 08:15:10 +0000745 while (CurrentToken)
Daniel Jaspera885dbe2013-02-05 09:34:14 +0000746 next();
Daniel Jasper616de8642014-11-23 16:46:28 +0000747 return Type;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000748 }
749
Nico Weber44449172013-02-12 16:17:07 +0000750public:
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000751 LineType parseLine() {
Daniel Jasper4d9ec172015-05-06 08:38:24 +0000752 NonTemplateLess.clear();
Daniel Jasper1b998812015-04-23 09:54:10 +0000753 if (CurrentToken->is(tok::hash))
Daniel Jasper616de8642014-11-23 16:46:28 +0000754 return parsePreprocessorDirective();
Daniel Jasper7cfde412014-01-21 08:56:09 +0000755
Daniel Jasper47ef6dd2014-01-17 16:21:39 +0000756 // Directly allow to 'import <string-literal>' to support protocol buffer
757 // definitions (code.google.com/p/protobuf) or missing "#" (either way we
758 // should not break the line).
759 IdentifierInfo *Info = CurrentToken->Tok.getIdentifierInfo();
Daniel Jasper9b9e0762014-11-26 18:03:42 +0000760 if ((Style.Language == FormatStyle::LK_Java &&
761 CurrentToken->is(Keywords.kw_package)) ||
762 (Info && Info->getPPKeywordID() == tok::pp_import &&
Daniel Jasper86ee0b62014-12-04 08:57:27 +0000763 CurrentToken->Next &&
Daniel Jasper16dbe0b2015-01-14 10:02:49 +0000764 CurrentToken->Next->isOneOf(tok::string_literal, tok::identifier,
765 tok::kw_static))) {
Daniel Jasper343643b2014-08-13 08:29:18 +0000766 next();
Daniel Jasper47ef6dd2014-01-17 16:21:39 +0000767 parseIncludeDirective();
Daniel Jasper616de8642014-11-23 16:46:28 +0000768 return LT_ImportStatement;
Daniel Jasper343643b2014-08-13 08:29:18 +0000769 }
770
771 // If this line starts and ends in '<' and '>', respectively, it is likely
772 // part of "#define <a/b.h>".
773 if (CurrentToken->is(tok::less) && Line.Last->is(tok::greater)) {
774 parseIncludeDirective();
Daniel Jasper616de8642014-11-23 16:46:28 +0000775 return LT_ImportStatement;
Daniel Jasper343643b2014-08-13 08:29:18 +0000776 }
Daniel Jasper47ef6dd2014-01-17 16:21:39 +0000777
Daniel Jasper1b998812015-04-23 09:54:10 +0000778 // In .proto files, top-level options are very similar to import statements
779 // and should not be line-wrapped.
780 if (Style.Language == FormatStyle::LK_Proto && Line.Level == 0 &&
781 CurrentToken->is(Keywords.kw_option)) {
782 next();
783 if (CurrentToken && CurrentToken->is(tok::identifier))
784 return LT_ImportStatement;
785 }
786
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +0000787 // import {...} from '...';
788 if (Style.Language == FormatStyle::LK_JavaScript &&
789 CurrentToken->is(Keywords.kw_import))
790 return LT_ImportStatement;
791
Daniel Jasper616de8642014-11-23 16:46:28 +0000792 bool KeywordVirtualFound = false;
793 bool ImportStatement = false;
Craig Topper2145bc02014-05-09 08:15:10 +0000794 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000795 if (CurrentToken->is(tok::kw_virtual))
796 KeywordVirtualFound = true;
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +0000797 if (Style.Language == FormatStyle::LK_JavaScript) {
798 // export {...} from '...';
799 // An export followed by "from 'some string';" is a re-export from
800 // another module identified by a URI and is treated as a
801 // LT_ImportStatement (i.e. prevent wraps on it for long URIs).
802 // Just "export {...};" or "export class ..." should not be treated as
803 // an import in this sense.
804 if (Line.First->is(tok::kw_export) &&
805 CurrentToken->is(Keywords.kw_from) && CurrentToken->Next &&
806 CurrentToken->Next->isStringLiteral())
807 ImportStatement = true;
808 if (isClosureImportStatement(*CurrentToken))
809 ImportStatement = true;
810 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000811 if (!consumeToken())
812 return LT_Invalid;
813 }
814 if (KeywordVirtualFound)
815 return LT_VirtualFunctionDecl;
Daniel Jasper616de8642014-11-23 16:46:28 +0000816 if (ImportStatement)
817 return LT_ImportStatement;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000818
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000819 if (Line.startsWith(TT_ObjCMethodSpecifier)) {
Craig Topper2145bc02014-05-09 08:15:10 +0000820 if (Contexts.back().FirstObjCSelectorName)
Daniel Jasperc697ad22013-02-06 10:05:46 +0000821 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
822 Contexts.back().LongestObjCSelectorName;
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000823 return LT_ObjCMethodDecl;
824 }
825
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000826 return LT_Other;
827 }
828
Nico Weber44449172013-02-12 16:17:07 +0000829private:
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +0000830 bool isClosureImportStatement(const FormatToken &Tok) {
Daniel Jasper616de8642014-11-23 16:46:28 +0000831 // FIXME: Closure-library specific stuff should not be hard-coded but be
832 // configurable.
Daniel Jasper8fc7a1e2016-03-22 14:32:20 +0000833 return Tok.TokenText == "goog" && Tok.Next && Tok.Next->is(tok::period) &&
Daniel Jasper616de8642014-11-23 16:46:28 +0000834 Tok.Next->Next && (Tok.Next->Next->TokenText == "module" ||
Daniel Jasperb488a742015-10-29 19:05:20 +0000835 Tok.Next->Next->TokenText == "provide" ||
Daniel Jasper616de8642014-11-23 16:46:28 +0000836 Tok.Next->Next->TokenText == "require" ||
Daniel Jasper02cbeb22016-02-22 15:06:53 +0000837 Tok.Next->Next->TokenText == "setTestOnly" ||
838 Tok.Next->Next->TokenText == "forwardDeclare") &&
Daniel Jasper53c38f42014-11-27 14:46:03 +0000839 Tok.Next->Next->Next && Tok.Next->Next->Next->is(tok::l_paren);
Daniel Jasper616de8642014-11-23 16:46:28 +0000840 }
841
Manuel Klimek819788d2014-03-18 11:22:45 +0000842 void resetTokenMetadata(FormatToken *Token) {
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000843 if (!Token)
844 return;
Manuel Klimek819788d2014-03-18 11:22:45 +0000845
846 // Reset token type in case we have already looked at it and then
847 // recovered from an error (e.g. failure to find the matching >).
Daniel Jasper66cb8c52015-05-04 09:22:29 +0000848 if (!CurrentToken->isOneOf(TT_LambdaLSquare, TT_ForEachMacro,
849 TT_FunctionLBrace, TT_ImplicitStringLiteral,
Daniel Jasper6f2b88a2015-06-05 13:18:09 +0000850 TT_InlineASMBrace, TT_JsFatArrow, TT_LambdaArrow,
851 TT_RegexLiteral))
Manuel Klimek819788d2014-03-18 11:22:45 +0000852 CurrentToken->Type = TT_Unknown;
David Blaikie3875a822014-07-19 01:06:45 +0000853 CurrentToken->Role.reset();
Daniel Jasperd1debfc2015-01-21 18:04:02 +0000854 CurrentToken->MatchingParen = nullptr;
Manuel Klimek819788d2014-03-18 11:22:45 +0000855 CurrentToken->FakeLParens.clear();
856 CurrentToken->FakeRParens = 0;
857 }
858
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000859 void next() {
Craig Topper2145bc02014-05-09 08:15:10 +0000860 if (CurrentToken) {
Daniel Jasper63af7c42013-12-09 14:40:19 +0000861 CurrentToken->NestingLevel = Contexts.size() - 1;
Daniel Jasper78b45332014-08-14 10:52:56 +0000862 CurrentToken->BindingStrength = Contexts.back().BindingStrength;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000863 modifyContext(*CurrentToken);
Daniel Jasper78b45332014-08-14 10:52:56 +0000864 determineTokenType(*CurrentToken);
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000865 CurrentToken = CurrentToken->Next;
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000866 }
Daniel Jasper5065bc42013-02-18 12:44:35 +0000867
Manuel Klimek819788d2014-03-18 11:22:45 +0000868 resetTokenMetadata(CurrentToken);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000869 }
870
Daniel Jasperc697ad22013-02-06 10:05:46 +0000871 /// \brief A struct to hold information valid in a specific context, e.g.
872 /// a pair of parenthesis.
873 struct Context {
Daniel Jasper40aacf42013-03-14 13:45:21 +0000874 Context(tok::TokenKind ContextKind, unsigned BindingStrength,
875 bool IsExpression)
876 : ContextKind(ContextKind), BindingStrength(BindingStrength),
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000877 IsExpression(IsExpression) {}
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000878
Daniel Jasper40aacf42013-03-14 13:45:21 +0000879 tok::TokenKind ContextKind;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000880 unsigned BindingStrength;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000881 bool IsExpression;
Daniel Jasper2b1865c2015-04-15 07:26:18 +0000882 unsigned LongestObjCSelectorName = 0;
883 bool ColonIsForRangeExpr = false;
884 bool ColonIsDictLiteral = false;
885 bool ColonIsObjCMethodExpr = false;
886 FormatToken *FirstObjCSelectorName = nullptr;
887 FormatToken *FirstStartOfName = nullptr;
888 bool CanBeExpression = true;
889 bool InTemplateArgument = false;
890 bool InCtorInitializer = false;
891 bool CaretFound = false;
892 bool IsForEachMacro = false;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000893 };
894
895 /// \brief Puts a new \c Context onto the stack \c Contexts for the lifetime
896 /// of each instance.
897 struct ScopedContextCreator {
898 AnnotatingParser &P;
899
Daniel Jasper40aacf42013-03-14 13:45:21 +0000900 ScopedContextCreator(AnnotatingParser &P, tok::TokenKind ContextKind,
901 unsigned Increase)
902 : P(P) {
Daniel Jasper3ac9b9e2013-07-08 14:34:09 +0000903 P.Contexts.push_back(Context(ContextKind,
904 P.Contexts.back().BindingStrength + Increase,
905 P.Contexts.back().IsExpression));
Daniel Jasperc697ad22013-02-06 10:05:46 +0000906 }
907
908 ~ScopedContextCreator() { P.Contexts.pop_back(); }
909 };
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000910
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000911 void modifyContext(const FormatToken &Current) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000912 if (Current.getPrecedence() == prec::Assignment &&
Daniel Jasper95516cd2015-12-23 18:01:29 +0000913 !Line.First->isOneOf(tok::kw_template, tok::kw_using, tok::kw_return) &&
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000914 (!Current.Previous || Current.Previous->isNot(tok::kw_operator))) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000915 Contexts.back().IsExpression = true;
Daniel Jaspere285b8d2015-06-17 09:43:56 +0000916 if (!Line.startsWith(TT_UnaryOperator)) {
Daniel Jasper75092162015-01-23 19:04:49 +0000917 for (FormatToken *Previous = Current.Previous;
Daniel Jasperbcad0662015-07-21 22:51:00 +0000918 Previous && Previous->Previous &&
919 !Previous->Previous->isOneOf(tok::comma, tok::semi);
Daniel Jasper75092162015-01-23 19:04:49 +0000920 Previous = Previous->Previous) {
921 if (Previous->isOneOf(tok::r_square, tok::r_paren)) {
922 Previous = Previous->MatchingParen;
923 if (!Previous)
924 break;
925 }
Daniel Jasperdc4f7252015-03-11 12:59:49 +0000926 if (Previous->opensScope())
927 break;
Daniel Jasper75092162015-01-23 19:04:49 +0000928 if (Previous->isOneOf(TT_BinaryOperator, TT_UnaryOperator) &&
Daniel Jasper1c220482015-02-25 10:30:06 +0000929 Previous->isOneOf(tok::star, tok::amp, tok::ampamp) &&
930 Previous->Previous && Previous->Previous->isNot(tok::equal))
Daniel Jasper75092162015-01-23 19:04:49 +0000931 Previous->Type = TT_PointerOrReference;
Manuel Klimek5f594f82014-08-13 14:00:41 +0000932 }
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000933 }
Daniel Jasper93101662015-05-19 12:29:27 +0000934 } else if (Current.is(tok::lessless) &&
935 (!Current.Previous || !Current.Previous->is(tok::kw_operator))) {
936 Contexts.back().IsExpression = true;
Daniel Jasper3682fcd2013-12-16 08:36:18 +0000937 } else if (Current.isOneOf(tok::kw_return, tok::kw_throw)) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000938 Contexts.back().IsExpression = true;
Daniel Jasperbcb55ee2014-11-21 14:08:38 +0000939 } else if (Current.is(TT_TrailingReturnArrow)) {
940 Contexts.back().IsExpression = false;
Nico Weber4f113492015-09-15 23:48:17 +0000941 } else if (Current.is(TT_LambdaArrow) || Current.is(Keywords.kw_assert)) {
Daniel Jasper6f2b88a2015-06-05 13:18:09 +0000942 Contexts.back().IsExpression = Style.Language == FormatStyle::LK_Java;
Eric Liuce5e4bc2016-05-18 08:02:56 +0000943 } else if (Current.Previous &&
944 Current.Previous->is(TT_CtorInitializerColon)) {
945 Contexts.back().IsExpression = true;
946 Contexts.back().InCtorInitializer = true;
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000947 } else if (Current.isOneOf(tok::r_paren, tok::greater, tok::comma)) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000948 for (FormatToken *Previous = Current.Previous;
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000949 Previous && Previous->isOneOf(tok::star, tok::amp);
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000950 Previous = Previous->Previous)
Nico Weber44449172013-02-12 16:17:07 +0000951 Previous->Type = TT_PointerOrReference;
Daniel Jasperd27df3d2016-02-01 11:21:07 +0000952 if (Line.MustBeDeclaration && !Contexts.front().InCtorInitializer)
953 Contexts.back().IsExpression = false;
Daniel Jasper97b89482013-03-13 07:49:51 +0000954 } else if (Current.is(tok::kw_new)) {
955 Contexts.back().CanBeExpression = false;
Daniel Marjamakie59f8d72015-06-18 10:59:26 +0000956 } else if (Current.isOneOf(tok::semi, tok::exclaim)) {
Daniel Jasperc37de302013-05-03 14:41:24 +0000957 // This should be the condition or increment in a for-loop.
958 Contexts.back().IsExpression = true;
Nico Weber44449172013-02-12 16:17:07 +0000959 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000960 }
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000961
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000962 void determineTokenType(FormatToken &Current) {
963 if (!Current.is(TT_Unknown))
964 // The token type is already known.
965 return;
966
967 // Line.MightBeFunctionDecl can only be true after the parentheses of a
968 // function declaration have been found. In this case, 'Current' is a
969 // trailing token of this declaration and thus cannot be a name.
970 if (Current.is(Keywords.kw_instanceof)) {
971 Current.Type = TT_BinaryOperator;
972 } else if (isStartOfName(Current) &&
973 (!Line.MightBeFunctionDecl || Current.NestingLevel != 0)) {
974 Contexts.back().FirstStartOfName = &Current;
975 Current.Type = TT_StartOfName;
Richard Smithe301ba22015-11-11 02:02:15 +0000976 } else if (Current.isOneOf(tok::kw_auto, tok::kw___auto_type)) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000977 AutoFound = true;
978 } else if (Current.is(tok::arrow) &&
979 Style.Language == FormatStyle::LK_Java) {
980 Current.Type = TT_LambdaArrow;
981 } else if (Current.is(tok::arrow) && AutoFound && Line.MustBeDeclaration &&
982 Current.NestingLevel == 0) {
983 Current.Type = TT_TrailingReturnArrow;
984 } else if (Current.isOneOf(tok::star, tok::amp, tok::ampamp)) {
985 Current.Type =
986 determineStarAmpUsage(Current, Contexts.back().CanBeExpression &&
987 Contexts.back().IsExpression,
988 Contexts.back().InTemplateArgument);
989 } else if (Current.isOneOf(tok::minus, tok::plus, tok::caret)) {
990 Current.Type = determinePlusMinusCaretUsage(Current);
991 if (Current.is(TT_UnaryOperator) && Current.is(tok::caret))
992 Contexts.back().CaretFound = true;
993 } else if (Current.isOneOf(tok::minusminus, tok::plusplus)) {
994 Current.Type = determineIncrementUsage(Current);
995 } else if (Current.isOneOf(tok::exclaim, tok::tilde)) {
996 Current.Type = TT_UnaryOperator;
997 } else if (Current.is(tok::question)) {
Daniel Jasper9326f912015-05-05 08:40:32 +0000998 if (Style.Language == FormatStyle::LK_JavaScript &&
999 Line.MustBeDeclaration) {
1000 // In JavaScript, `interface X { foo?(): bar; }` is an optional method
1001 // on the interface, not a ternary expression.
1002 Current.Type = TT_JsTypeOptionalQuestion;
1003 } else {
1004 Current.Type = TT_ConditionalExpr;
1005 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001006 } else if (Current.isBinaryOperator() &&
1007 (!Current.Previous || Current.Previous->isNot(tok::l_square))) {
1008 Current.Type = TT_BinaryOperator;
1009 } else if (Current.is(tok::comment)) {
Daniel Jasper62c78f52015-05-06 08:58:57 +00001010 if (Current.TokenText.startswith("/*")) {
1011 if (Current.TokenText.endswith("*/"))
1012 Current.Type = TT_BlockComment;
1013 else
1014 // The lexer has for some reason determined a comment here. But we
1015 // cannot really handle it, if it isn't properly terminated.
1016 Current.Tok.setKind(tok::unknown);
1017 } else {
1018 Current.Type = TT_LineComment;
1019 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001020 } else if (Current.is(tok::r_paren)) {
1021 if (rParenEndsCast(Current))
1022 Current.Type = TT_CastRParen;
Daniel Jasper47bbda02015-05-18 13:47:23 +00001023 if (Current.MatchingParen && Current.Next &&
1024 !Current.Next->isBinaryOperator() &&
Daniel Jasper19bc1d02016-04-06 13:58:09 +00001025 !Current.Next->isOneOf(tok::semi, tok::colon, tok::l_brace,
1026 tok::period, tok::arrow, tok::coloncolon))
Daniel Jasper47bbda02015-05-18 13:47:23 +00001027 if (FormatToken *BeforeParen = Current.MatchingParen->Previous)
1028 if (BeforeParen->is(tok::identifier) &&
1029 BeforeParen->TokenText == BeforeParen->TokenText.upper() &&
1030 (!BeforeParen->Previous ||
1031 BeforeParen->Previous->ClosesTemplateDeclaration))
1032 Current.Type = TT_FunctionAnnotationRParen;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001033 } else if (Current.is(tok::at) && Current.Next) {
Daniel Jasper015c7a92015-05-11 15:15:48 +00001034 if (Current.Next->isStringLiteral()) {
1035 Current.Type = TT_ObjCStringLiteral;
1036 } else {
1037 switch (Current.Next->Tok.getObjCKeywordID()) {
1038 case tok::objc_interface:
1039 case tok::objc_implementation:
1040 case tok::objc_protocol:
1041 Current.Type = TT_ObjCDecl;
1042 break;
1043 case tok::objc_property:
1044 Current.Type = TT_ObjCProperty;
1045 break;
1046 default:
1047 break;
1048 }
Aaron Ballman484ee9b2014-11-24 15:42:34 +00001049 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001050 } else if (Current.is(tok::period)) {
1051 FormatToken *PreviousNoComment = Current.getPreviousNonComment();
1052 if (PreviousNoComment &&
1053 PreviousNoComment->isOneOf(tok::comma, tok::l_brace))
1054 Current.Type = TT_DesignatedInitializerPeriod;
Nico Weberbeb03932015-01-09 23:25:06 +00001055 else if (Style.Language == FormatStyle::LK_Java && Current.Previous &&
1056 Current.Previous->isOneOf(TT_JavaAnnotation,
1057 TT_LeadingJavaAnnotation)) {
1058 Current.Type = Current.Previous->Type;
1059 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001060 } else if (Current.isOneOf(tok::identifier, tok::kw_const) &&
1061 Current.Previous &&
1062 !Current.Previous->isOneOf(tok::equal, tok::at) &&
1063 Line.MightBeFunctionDecl && Contexts.size() == 1) {
1064 // Line.MightBeFunctionDecl can only be true after the parentheses of a
1065 // function declaration have been found.
1066 Current.Type = TT_TrailingAnnotation;
Daniel Jasper3c42dba2015-02-18 17:17:15 +00001067 } else if ((Style.Language == FormatStyle::LK_Java ||
1068 Style.Language == FormatStyle::LK_JavaScript) &&
1069 Current.Previous) {
Nico Weberbeb03932015-01-09 23:25:06 +00001070 if (Current.Previous->is(tok::at) &&
1071 Current.isNot(Keywords.kw_interface)) {
1072 const FormatToken &AtToken = *Current.Previous;
1073 const FormatToken *Previous = AtToken.getPreviousNonComment();
1074 if (!Previous || Previous->is(TT_LeadingJavaAnnotation))
1075 Current.Type = TT_LeadingJavaAnnotation;
1076 else
1077 Current.Type = TT_JavaAnnotation;
1078 } else if (Current.Previous->is(tok::period) &&
1079 Current.Previous->isOneOf(TT_JavaAnnotation,
1080 TT_LeadingJavaAnnotation)) {
1081 Current.Type = Current.Previous->Type;
1082 }
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001083 }
1084 }
1085
Daniel Jasperdba1c552013-07-02 09:47:29 +00001086 /// \brief Take a guess at whether \p Tok starts a name of a function or
1087 /// variable declaration.
1088 ///
1089 /// This is a heuristic based on whether \p Tok is an identifier following
1090 /// something that is likely a type.
1091 bool isStartOfName(const FormatToken &Tok) {
Craig Topper2145bc02014-05-09 08:15:10 +00001092 if (Tok.isNot(tok::identifier) || !Tok.Previous)
Daniel Jasperdba1c552013-07-02 09:47:29 +00001093 return false;
1094
Daniel Jasper043ac052015-07-03 10:12:53 +00001095 if (Tok.Previous->isOneOf(TT_LeadingJavaAnnotation, Keywords.kw_instanceof))
Jacques Pienaarfc275112015-02-18 23:48:37 +00001096 return false;
Daniel Jasper1ce41112016-02-01 11:20:47 +00001097 if (Style.Language == FormatStyle::LK_JavaScript &&
1098 Tok.Previous->is(Keywords.kw_in))
1099 return false;
Daniel Jasper404658a2015-01-14 10:00:20 +00001100
Daniel Jasperdba1c552013-07-02 09:47:29 +00001101 // Skip "const" as it does not have an influence on whether this is a name.
1102 FormatToken *PreviousNotConst = Tok.Previous;
Craig Topper2145bc02014-05-09 08:15:10 +00001103 while (PreviousNotConst && PreviousNotConst->is(tok::kw_const))
Daniel Jasperdba1c552013-07-02 09:47:29 +00001104 PreviousNotConst = PreviousNotConst->Previous;
1105
Craig Topper2145bc02014-05-09 08:15:10 +00001106 if (!PreviousNotConst)
Daniel Jasperdba1c552013-07-02 09:47:29 +00001107 return false;
1108
Daniel Jasper3ac9b9e2013-07-08 14:34:09 +00001109 bool IsPPKeyword = PreviousNotConst->is(tok::identifier) &&
1110 PreviousNotConst->Previous &&
1111 PreviousNotConst->Previous->is(tok::hash);
Daniel Jasperdba1c552013-07-02 09:47:29 +00001112
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001113 if (PreviousNotConst->is(TT_TemplateCloser))
Daniel Jasper53643062013-08-19 10:16:18 +00001114 return PreviousNotConst && PreviousNotConst->MatchingParen &&
1115 PreviousNotConst->MatchingParen->Previous &&
Daniel Jaspercaf86852014-11-20 09:48:11 +00001116 PreviousNotConst->MatchingParen->Previous->isNot(tok::period) &&
Daniel Jasper53643062013-08-19 10:16:18 +00001117 PreviousNotConst->MatchingParen->Previous->isNot(tok::kw_template);
1118
Daniel Jasperf10a28d2014-05-05 13:48:09 +00001119 if (PreviousNotConst->is(tok::r_paren) && PreviousNotConst->MatchingParen &&
1120 PreviousNotConst->MatchingParen->Previous &&
1121 PreviousNotConst->MatchingParen->Previous->is(tok::kw_decltype))
1122 return true;
1123
Daniel Jasperaf642c62015-08-25 13:40:51 +00001124 return (!IsPPKeyword &&
1125 PreviousNotConst->isOneOf(tok::identifier, tok::kw_auto)) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001126 PreviousNotConst->is(TT_PointerOrReference) ||
Daniel Jaspercb51cf42014-01-16 09:11:55 +00001127 PreviousNotConst->isSimpleTypeSpecifier();
Daniel Jasperdba1c552013-07-02 09:47:29 +00001128 }
1129
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001130 /// \brief Determine whether ')' is ending a cast.
1131 bool rParenEndsCast(const FormatToken &Tok) {
Daniel Jasper569369c2015-11-23 15:55:55 +00001132 // C-style casts are only used in C++ and Java.
1133 if (Style.Language != FormatStyle::LK_Cpp &&
1134 Style.Language != FormatStyle::LK_Java)
1135 return false;
Daniel Jasper9bb30012015-11-23 15:55:50 +00001136
Daniel Jasper569369c2015-11-23 15:55:55 +00001137 // Empty parens aren't casts and there are no casts at the end of the line.
1138 if (Tok.Previous == Tok.MatchingParen || !Tok.Next || !Tok.MatchingParen)
1139 return false;
1140
1141 FormatToken *LeftOfParens = Tok.MatchingParen->getPreviousNonComment();
Daniel Jasper9bb30012015-11-23 15:55:50 +00001142 if (LeftOfParens) {
Daniel Jasper594be2f2016-06-13 07:49:09 +00001143 // If there is a closing parenthesis left of the current parentheses,
Daniel Jasper8e8b4fb2015-11-23 19:11:45 +00001144 // look past it as these might be chained casts.
1145 if (LeftOfParens->is(tok::r_paren)) {
1146 if (!LeftOfParens->MatchingParen ||
1147 !LeftOfParens->MatchingParen->Previous)
1148 return false;
1149 LeftOfParens = LeftOfParens->MatchingParen->Previous;
1150 }
1151
Daniel Jasper569369c2015-11-23 15:55:55 +00001152 // If there is an identifier (or with a few exceptions a keyword) right
1153 // before the parentheses, this is unlikely to be a cast.
Daniel Jasper9bb30012015-11-23 15:55:50 +00001154 if (LeftOfParens->Tok.getIdentifierInfo() &&
1155 !LeftOfParens->isOneOf(Keywords.kw_in, tok::kw_return, tok::kw_case,
1156 tok::kw_delete))
1157 return false;
Daniel Jasper569369c2015-11-23 15:55:55 +00001158
1159 // Certain other tokens right before the parentheses are also signals that
1160 // this cannot be a cast.
1161 if (LeftOfParens->isOneOf(tok::at, tok::r_square, TT_OverloadedOperator,
Daniel Jasper594be2f2016-06-13 07:49:09 +00001162 TT_TemplateCloser, tok::ellipsis))
Daniel Jasper9bb30012015-11-23 15:55:50 +00001163 return false;
Daniel Jasper9bb30012015-11-23 15:55:50 +00001164 }
Daniel Jasper569369c2015-11-23 15:55:55 +00001165
1166 if (Tok.Next->is(tok::question))
1167 return false;
1168
1169 // As Java has no function types, a "(" after the ")" likely means that this
1170 // is a cast.
1171 if (Style.Language == FormatStyle::LK_Java && Tok.Next->is(tok::l_paren))
1172 return true;
1173
1174 // If a (non-string) literal follows, this is likely a cast.
1175 if (Tok.Next->isNot(tok::string_literal) &&
1176 (Tok.Next->Tok.isLiteral() ||
1177 Tok.Next->isOneOf(tok::kw_sizeof, tok::kw_alignof)))
1178 return true;
1179
1180 // Heuristically try to determine whether the parentheses contain a type.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001181 bool ParensAreType =
1182 !Tok.Previous ||
1183 Tok.Previous->isOneOf(TT_PointerOrReference, TT_TemplateCloser) ||
1184 Tok.Previous->isSimpleTypeSpecifier();
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001185 bool ParensCouldEndDecl =
Daniel Jasper74331d42015-10-26 12:08:47 +00001186 Tok.Next->isOneOf(tok::equal, tok::semi, tok::l_brace, tok::greater);
Daniel Jaspera85c3312015-12-28 07:44:25 +00001187 if (ParensAreType && !ParensCouldEndDecl)
Daniel Jasper569369c2015-11-23 15:55:55 +00001188 return true;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001189
Daniel Jasper569369c2015-11-23 15:55:55 +00001190 // At this point, we heuristically assume that there are no casts at the
1191 // start of the line. We assume that we have found most cases where there
1192 // are by the logic above, e.g. "(void)x;".
1193 if (!LeftOfParens)
1194 return false;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001195
Daniel Jasper94b1bdf2016-04-05 11:46:06 +00001196 // If the following token is an identifier or 'this', this is a cast. All
1197 // cases where this can be something else are handled above.
1198 if (Tok.Next->isOneOf(tok::identifier, tok::kw_this))
Daniel Jasper569369c2015-11-23 15:55:55 +00001199 return true;
1200
1201 if (!Tok.Next->Next)
1202 return false;
1203
1204 // If the next token after the parenthesis is a unary operator, assume
1205 // that this is cast, unless there are unexpected tokens inside the
1206 // parenthesis.
1207 bool NextIsUnary =
1208 Tok.Next->isUnaryOperator() || Tok.Next->isOneOf(tok::amp, tok::star);
1209 if (!NextIsUnary || Tok.Next->is(tok::plus) ||
1210 !Tok.Next->Next->isOneOf(tok::identifier, tok::numeric_constant))
1211 return false;
1212 // Search for unexpected tokens.
1213 for (FormatToken *Prev = Tok.Previous; Prev != Tok.MatchingParen;
1214 Prev = Prev->Previous) {
1215 if (!Prev->isOneOf(tok::kw_const, tok::identifier, tok::coloncolon))
1216 return false;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001217 }
Daniel Jasper569369c2015-11-23 15:55:55 +00001218 return true;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +00001219 }
1220
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001221 /// \brief Return the type of the given token assuming it is * or &.
Manuel Klimekf81e5c02014-03-27 11:17:36 +00001222 TokenType determineStarAmpUsage(const FormatToken &Tok, bool IsExpression,
1223 bool InTemplateArgument) {
Daniel Jasper3a038de2014-09-05 08:53:45 +00001224 if (Style.Language == FormatStyle::LK_JavaScript)
1225 return TT_BinaryOperator;
1226
Alexander Kornienko1efe0a02013-07-04 14:47:51 +00001227 const FormatToken *PrevToken = Tok.getPreviousNonComment();
Craig Topper2145bc02014-05-09 08:15:10 +00001228 if (!PrevToken)
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001229 return TT_UnaryOperator;
1230
Alexander Kornienko1efe0a02013-07-04 14:47:51 +00001231 const FormatToken *NextToken = Tok.getNextNonComment();
Daniel Jasper5d7f06f2015-08-24 14:28:08 +00001232 if (!NextToken ||
1233 NextToken->isOneOf(tok::arrow, Keywords.kw_final,
1234 Keywords.kw_override) ||
Daniel Jasperbcb55ee2014-11-21 14:08:38 +00001235 (NextToken->is(tok::l_brace) && !NextToken->getNextNonComment()))
Daniel Jasper5d7f06f2015-08-24 14:28:08 +00001236 return TT_PointerOrReference;
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001237
Daniel Jasper73e171f2014-08-29 12:54:38 +00001238 if (PrevToken->is(tok::coloncolon))
Daniel Jasper8eb371b2013-03-01 17:13:29 +00001239 return TT_PointerOrReference;
1240
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001241 if (PrevToken->isOneOf(tok::l_paren, tok::l_square, tok::l_brace,
Daniel Jasperae907642013-03-14 10:50:25 +00001242 tok::comma, tok::semi, tok::kw_return, tok::colon,
Aaron Ballman484ee9b2014-11-24 15:42:34 +00001243 tok::equal, tok::kw_delete, tok::kw_sizeof) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001244 PrevToken->isOneOf(TT_BinaryOperator, TT_ConditionalExpr,
1245 TT_UnaryOperator, TT_CastRParen))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001246 return TT_UnaryOperator;
1247
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001248 if (NextToken->is(tok::l_square) && NextToken->isNot(TT_LambdaLSquare))
Nico Weber5d2624e2013-02-06 06:20:11 +00001249 return TT_PointerOrReference;
Daniel Jasper0ea4d792015-10-07 01:41:14 +00001250 if (NextToken->is(tok::kw_operator) && !IsExpression)
1251 return TT_PointerOrReference;
1252 if (NextToken->isOneOf(tok::comma, tok::semi))
Daniel Jasper32ccb032014-06-23 07:36:18 +00001253 return TT_PointerOrReference;
Nico Weber5d2624e2013-02-06 06:20:11 +00001254
Daniel Jasper71665cd2013-09-10 10:26:38 +00001255 if (PrevToken->is(tok::r_paren) && PrevToken->MatchingParen &&
1256 PrevToken->MatchingParen->Previous &&
Daniel Jasper4ac7de72014-06-11 07:35:16 +00001257 PrevToken->MatchingParen->Previous->isOneOf(tok::kw_typeof,
1258 tok::kw_decltype))
Daniel Jasper71665cd2013-09-10 10:26:38 +00001259 return TT_PointerOrReference;
1260
Manuel Klimek94815562014-03-28 09:27:09 +00001261 if (PrevToken->Tok.isLiteral() ||
1262 PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::kw_true,
Daniel Jasperf0c809a2014-10-28 18:28:22 +00001263 tok::kw_false, tok::r_brace) ||
Manuel Klimek94815562014-03-28 09:27:09 +00001264 NextToken->Tok.isLiteral() ||
1265 NextToken->isOneOf(tok::kw_true, tok::kw_false) ||
1266 NextToken->isUnaryOperator() ||
Manuel Klimekf81e5c02014-03-27 11:17:36 +00001267 // If we know we're in a template argument, there are no named
1268 // declarations. Thus, having an identifier on the right-hand side
1269 // indicates a binary operator.
1270 (InTemplateArgument && NextToken->Tok.isAnyIdentifier()))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001271 return TT_BinaryOperator;
1272
Daniel Jasper13a7f462014-10-28 18:11:52 +00001273 // "&&(" is quite unlikely to be two successive unary "&".
1274 if (Tok.is(tok::ampamp) && NextToken && NextToken->is(tok::l_paren))
1275 return TT_BinaryOperator;
1276
Daniel Jasper7d028292014-06-02 11:54:20 +00001277 // This catches some cases where evaluation order is used as control flow:
1278 // aaa && aaa->f();
1279 const FormatToken *NextNextToken = NextToken->getNextNonComment();
1280 if (NextNextToken && NextNextToken->is(tok::arrow))
1281 return TT_BinaryOperator;
1282
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001283 // It is very unlikely that we are going to find a pointer or reference type
1284 // definition on the RHS of an assignment.
Daniel Jasperbb86d842014-11-23 19:15:35 +00001285 if (IsExpression && !Contexts.back().CaretFound)
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001286 return TT_BinaryOperator;
1287
1288 return TT_PointerOrReference;
1289 }
1290
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001291 TokenType determinePlusMinusCaretUsage(const FormatToken &Tok) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +00001292 const FormatToken *PrevToken = Tok.getPreviousNonComment();
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001293 if (!PrevToken || PrevToken->is(TT_CastRParen))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001294 return TT_UnaryOperator;
1295
1296 // Use heuristics to recognize unary operators.
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001297 if (PrevToken->isOneOf(tok::equal, tok::l_paren, tok::comma, tok::l_square,
1298 tok::question, tok::colon, tok::kw_return,
1299 tok::kw_case, tok::at, tok::l_brace))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001300 return TT_UnaryOperator;
1301
Nico Weberb76de882013-02-05 16:21:00 +00001302 // There can't be two consecutive binary operators.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001303 if (PrevToken->is(TT_BinaryOperator))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001304 return TT_UnaryOperator;
1305
1306 // Fall back to marking the token as binary operator.
1307 return TT_BinaryOperator;
1308 }
1309
1310 /// \brief Determine whether ++/-- are pre- or post-increments/-decrements.
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001311 TokenType determineIncrementUsage(const FormatToken &Tok) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +00001312 const FormatToken *PrevToken = Tok.getPreviousNonComment();
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001313 if (!PrevToken || PrevToken->is(TT_CastRParen))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001314 return TT_UnaryOperator;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001315 if (PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::identifier))
Daniel Jasper3a9370c2013-02-04 07:21:18 +00001316 return TT_TrailingUnaryOperator;
1317
1318 return TT_UnaryOperator;
1319 }
Daniel Jasperc697ad22013-02-06 10:05:46 +00001320
1321 SmallVector<Context, 8> Contexts;
1322
Daniel Jasper8de9ed02013-08-22 15:00:41 +00001323 const FormatStyle &Style;
Daniel Jasperc697ad22013-02-06 10:05:46 +00001324 AnnotatedLine &Line;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001325 FormatToken *CurrentToken;
Daniel Jasper6cdec7c2013-07-09 14:36:48 +00001326 bool AutoFound;
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001327 const AdditionalKeywords &Keywords;
Daniel Jasper4d9ec172015-05-06 08:38:24 +00001328
1329 // Set of "<" tokens that do not open a template parameter list. If parseAngle
1330 // determines that a specific token can't be a template opener, it will make
1331 // same decision irrespective of the decisions for tokens leading up to it.
1332 // Store this information to prevent this from causing exponential runtime.
1333 llvm::SmallPtrSet<FormatToken *, 16> NonTemplateLess;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001334};
1335
Benjamin Kramer28b45ce2015-03-08 16:06:46 +00001336static const int PrecedenceUnaryOperator = prec::PointerToMember + 1;
1337static const int PrecedenceArrowAndPeriod = prec::PointerToMember + 2;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001338
Daniel Jasper400adc62013-02-08 15:28:42 +00001339/// \brief Parses binary expressions by inserting fake parenthesis based on
1340/// operator precedence.
1341class ExpressionParser {
1342public:
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001343 ExpressionParser(const FormatStyle &Style, const AdditionalKeywords &Keywords,
1344 AnnotatedLine &Line)
1345 : Style(Style), Keywords(Keywords), Current(Line.First) {}
Daniel Jasper400adc62013-02-08 15:28:42 +00001346
1347 /// \brief Parse expressions with the given operatore precedence.
Daniel Jaspercd8599e2013-02-23 21:01:55 +00001348 void parse(int Precedence = 0) {
Daniel Jasperf48b5ab2013-11-07 19:23:49 +00001349 // Skip 'return' and ObjC selector colons as they are not part of a binary
1350 // expression.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001351 while (Current && (Current->is(tok::kw_return) ||
1352 (Current->is(tok::colon) &&
1353 Current->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral))))
Daniel Jaspereabede62013-09-30 08:29:03 +00001354 next();
1355
Craig Topper2145bc02014-05-09 08:15:10 +00001356 if (!Current || Precedence > PrecedenceArrowAndPeriod)
Daniel Jasper0649d362013-08-23 15:14:03 +00001357 return;
1358
Daniel Jasper2c611c02013-05-31 14:56:12 +00001359 // Conditional expressions need to be parsed separately for proper nesting.
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001360 if (Precedence == prec::Conditional) {
Daniel Jasper2c611c02013-05-31 14:56:12 +00001361 parseConditionalExpr();
1362 return;
1363 }
Daniel Jasper0649d362013-08-23 15:14:03 +00001364
1365 // Parse unary operators, which all have a higher precedence than binary
1366 // operators.
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001367 if (Precedence == PrecedenceUnaryOperator) {
Daniel Jasper0649d362013-08-23 15:14:03 +00001368 parseUnaryOperator();
Daniel Jasper400adc62013-02-08 15:28:42 +00001369 return;
Daniel Jasper0649d362013-08-23 15:14:03 +00001370 }
Daniel Jasper400adc62013-02-08 15:28:42 +00001371
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001372 FormatToken *Start = Current;
Craig Topper2145bc02014-05-09 08:15:10 +00001373 FormatToken *LatestOperator = nullptr;
Daniel Jasper0e617842014-04-16 12:26:54 +00001374 unsigned OperatorIndex = 0;
Daniel Jasper400adc62013-02-08 15:28:42 +00001375
Daniel Jaspercd8599e2013-02-23 21:01:55 +00001376 while (Current) {
Daniel Jasper400adc62013-02-08 15:28:42 +00001377 // Consume operators with higher precedence.
Daniel Jasper6bee6822013-04-08 20:33:42 +00001378 parse(Precedence + 1);
Daniel Jasper400adc62013-02-08 15:28:42 +00001379
Daniel Jasper0649d362013-08-23 15:14:03 +00001380 int CurrentPrecedence = getCurrentPrecedence();
1381
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001382 if (Current && Current->is(TT_SelectorName) &&
Daniel Jasperb88b25f2013-12-23 07:29:06 +00001383 Precedence == CurrentPrecedence) {
1384 if (LatestOperator)
1385 addFakeParenthesis(Start, prec::Level(Precedence));
Daniel Jasper0649d362013-08-23 15:14:03 +00001386 Start = Current;
Daniel Jasperb88b25f2013-12-23 07:29:06 +00001387 }
Daniel Jaspercd8599e2013-02-23 21:01:55 +00001388
Daniel Jasper400adc62013-02-08 15:28:42 +00001389 // At the end of the line or when an operator with higher precedence is
1390 // found, insert fake parenthesis and return.
Daniel Jasper86296e32014-10-20 11:12:51 +00001391 if (!Current || (Current->closesScope() && Current->MatchingParen) ||
Daniel Jasper6c22c442014-11-14 13:03:40 +00001392 (CurrentPrecedence != -1 && CurrentPrecedence < Precedence) ||
1393 (CurrentPrecedence == prec::Conditional &&
1394 Precedence == prec::Assignment && Current->is(tok::colon))) {
Daniel Jasper83791072014-12-03 13:20:49 +00001395 break;
Daniel Jasper400adc62013-02-08 15:28:42 +00001396 }
1397
1398 // Consume scopes: (), [], <> and {}
Daniel Jasperc04baae2013-04-10 09:49:49 +00001399 if (Current->opensScope()) {
1400 while (Current && !Current->closesScope()) {
Daniel Jasper400adc62013-02-08 15:28:42 +00001401 next();
1402 parse();
1403 }
1404 next();
1405 } else {
1406 // Operator found.
Daniel Jasper0e617842014-04-16 12:26:54 +00001407 if (CurrentPrecedence == Precedence) {
Daniel Jasper00492f92016-01-05 13:03:50 +00001408 if (LatestOperator)
1409 LatestOperator->NextOperator = Current;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001410 LatestOperator = Current;
Daniel Jasper0e617842014-04-16 12:26:54 +00001411 Current->OperatorIndex = OperatorIndex;
1412 ++OperatorIndex;
1413 }
Daniel Jasper3eb341c2014-11-11 23:04:51 +00001414 next(/*SkipPastLeadingComments=*/Precedence > 0);
Daniel Jasper400adc62013-02-08 15:28:42 +00001415 }
1416 }
Daniel Jasper83791072014-12-03 13:20:49 +00001417
1418 if (LatestOperator && (Current || Precedence > 0)) {
Daniel Jasper00492f92016-01-05 13:03:50 +00001419 // LatestOperator->LastOperator = true;
Daniel Jasper83791072014-12-03 13:20:49 +00001420 if (Precedence == PrecedenceArrowAndPeriod) {
1421 // Call expressions don't have a binary operator precedence.
1422 addFakeParenthesis(Start, prec::Unknown);
1423 } else {
1424 addFakeParenthesis(Start, prec::Level(Precedence));
1425 }
1426 }
Daniel Jasper400adc62013-02-08 15:28:42 +00001427 }
1428
1429private:
Daniel Jasper0649d362013-08-23 15:14:03 +00001430 /// \brief Gets the precedence (+1) of the given token for binary operators
1431 /// and other tokens that we treat like binary operators.
1432 int getCurrentPrecedence() {
1433 if (Current) {
Daniel Jasper97bfb7b2014-09-05 08:29:31 +00001434 const FormatToken *NextNonComment = Current->getNextNonComment();
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001435 if (Current->is(TT_ConditionalExpr))
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001436 return prec::Conditional;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001437 if (NextNonComment && NextNonComment->is(tok::colon) &&
1438 NextNonComment->is(TT_DictLiteral))
Daniel Jasper97bfb7b2014-09-05 08:29:31 +00001439 return prec::Comma;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001440 if (Current->is(TT_LambdaArrow))
Daniel Jasper8354ea82014-11-21 12:14:12 +00001441 return prec::Comma;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001442 if (Current->is(TT_JsFatArrow))
Daniel Jasper3b0f3042015-06-05 08:25:37 +00001443 return prec::Assignment;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001444 if (Current->isOneOf(tok::semi, TT_InlineASMColon, TT_SelectorName,
1445 TT_JsComputedPropertyName) ||
1446 (Current->is(tok::comment) && NextNonComment &&
1447 NextNonComment->is(TT_SelectorName)))
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001448 return 0;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001449 if (Current->is(TT_RangeBasedForLoopColon))
Daniel Jasper9cc3e972014-02-07 10:09:46 +00001450 return prec::Comma;
Daniel Jasper043ac052015-07-03 10:12:53 +00001451 if ((Style.Language == FormatStyle::LK_Java ||
1452 Style.Language == FormatStyle::LK_JavaScript) &&
1453 Current->is(Keywords.kw_instanceof))
1454 return prec::Relational;
Daniel Jasper1ce41112016-02-01 11:20:47 +00001455 if (Style.Language == FormatStyle::LK_JavaScript &&
1456 Current->is(Keywords.kw_in))
1457 return prec::Relational;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001458 if (Current->is(TT_BinaryOperator) || Current->is(tok::comma))
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001459 return Current->getPrecedence();
Daniel Jasper3c306e82015-06-03 17:08:40 +00001460 if (Current->isOneOf(tok::period, tok::arrow))
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001461 return PrecedenceArrowAndPeriod;
Daniel Jasper3c306e82015-06-03 17:08:40 +00001462 if (Style.Language == FormatStyle::LK_Java &&
1463 Current->isOneOf(Keywords.kw_extends, Keywords.kw_implements,
1464 Keywords.kw_throws))
Daniel Jasper50b4bd72014-11-02 19:16:41 +00001465 return 0;
Daniel Jasper0649d362013-08-23 15:14:03 +00001466 }
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001467 return -1;
Daniel Jasper0649d362013-08-23 15:14:03 +00001468 }
1469
Daniel Jasper2c611c02013-05-31 14:56:12 +00001470 void addFakeParenthesis(FormatToken *Start, prec::Level Precedence) {
1471 Start->FakeLParens.push_back(Precedence);
Daniel Jasper562ecd42013-09-06 08:08:14 +00001472 if (Precedence > prec::Unknown)
1473 Start->StartsBinaryExpression = true;
1474 if (Current) {
Daniel Jasper119ff532014-11-14 12:31:14 +00001475 FormatToken *Previous = Current->Previous;
Daniel Jasperc0956632014-12-03 14:02:59 +00001476 while (Previous->is(tok::comment) && Previous->Previous)
Daniel Jasper119ff532014-11-14 12:31:14 +00001477 Previous = Previous->Previous;
1478 ++Previous->FakeRParens;
Daniel Jasper562ecd42013-09-06 08:08:14 +00001479 if (Precedence > prec::Unknown)
Daniel Jasper119ff532014-11-14 12:31:14 +00001480 Previous->EndsBinaryExpression = true;
Daniel Jasper562ecd42013-09-06 08:08:14 +00001481 }
Daniel Jasper2c611c02013-05-31 14:56:12 +00001482 }
1483
Daniel Jasper0649d362013-08-23 15:14:03 +00001484 /// \brief Parse unary operator expressions and surround them with fake
1485 /// parentheses if appropriate.
1486 void parseUnaryOperator() {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001487 if (!Current || Current->isNot(TT_UnaryOperator)) {
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001488 parse(PrecedenceArrowAndPeriod);
Daniel Jasper0649d362013-08-23 15:14:03 +00001489 return;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001490 }
Daniel Jasper0649d362013-08-23 15:14:03 +00001491
1492 FormatToken *Start = Current;
1493 next();
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001494 parseUnaryOperator();
Daniel Jasper0649d362013-08-23 15:14:03 +00001495
Daniel Jasper0649d362013-08-23 15:14:03 +00001496 // The actual precedence doesn't matter.
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001497 addFakeParenthesis(Start, prec::Unknown);
Daniel Jasper0649d362013-08-23 15:14:03 +00001498 }
1499
Daniel Jasper2c611c02013-05-31 14:56:12 +00001500 void parseConditionalExpr() {
Daniel Jasper1a31bab2014-10-16 09:10:11 +00001501 while (Current && Current->isTrailingComment()) {
1502 next();
1503 }
Daniel Jasper2c611c02013-05-31 14:56:12 +00001504 FormatToken *Start = Current;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001505 parse(prec::LogicalOr);
Daniel Jasper2c611c02013-05-31 14:56:12 +00001506 if (!Current || !Current->is(tok::question))
1507 return;
1508 next();
Daniel Jasper6c22c442014-11-14 13:03:40 +00001509 parse(prec::Assignment);
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001510 if (!Current || Current->isNot(TT_ConditionalExpr))
Daniel Jasper2c611c02013-05-31 14:56:12 +00001511 return;
1512 next();
Daniel Jasper6c22c442014-11-14 13:03:40 +00001513 parse(prec::Assignment);
Daniel Jasper2c611c02013-05-31 14:56:12 +00001514 addFakeParenthesis(Start, prec::Conditional);
1515 }
1516
Daniel Jasper94e11d02014-09-04 14:58:30 +00001517 void next(bool SkipPastLeadingComments = true) {
Alexander Kornienkoafaa8f52013-06-17 13:19:53 +00001518 if (Current)
1519 Current = Current->Next;
Daniel Jasper94e11d02014-09-04 14:58:30 +00001520 while (Current &&
1521 (Current->NewlinesBefore == 0 || SkipPastLeadingComments) &&
1522 Current->isTrailingComment())
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001523 Current = Current->Next;
Daniel Jasper400adc62013-02-08 15:28:42 +00001524 }
1525
Daniel Jasper50b4bd72014-11-02 19:16:41 +00001526 const FormatStyle &Style;
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001527 const AdditionalKeywords &Keywords;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001528 FormatToken *Current;
Daniel Jasper400adc62013-02-08 15:28:42 +00001529};
1530
Craig Topper318ed7c2013-07-01 04:03:19 +00001531} // end anonymous namespace
1532
Nico Weberbeb03932015-01-09 23:25:06 +00001533void TokenAnnotator::setCommentLineLevels(
1534 SmallVectorImpl<AnnotatedLine *> &Lines) {
Craig Topper2145bc02014-05-09 08:15:10 +00001535 const AnnotatedLine *NextNonCommentLine = nullptr;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001536 for (SmallVectorImpl<AnnotatedLine *>::reverse_iterator I = Lines.rbegin(),
1537 E = Lines.rend();
1538 I != E; ++I) {
1539 if (NextNonCommentLine && (*I)->First->is(tok::comment) &&
Craig Topper2145bc02014-05-09 08:15:10 +00001540 (*I)->First->Next == nullptr)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001541 (*I)->Level = NextNonCommentLine->Level;
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001542 else
Craig Topper2145bc02014-05-09 08:15:10 +00001543 NextNonCommentLine = (*I)->First->isNot(tok::r_brace) ? (*I) : nullptr;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001544
1545 setCommentLineLevels((*I)->Children);
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001546 }
1547}
1548
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001549void TokenAnnotator::annotate(AnnotatedLine &Line) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001550 for (SmallVectorImpl<AnnotatedLine *>::iterator I = Line.Children.begin(),
1551 E = Line.Children.end();
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001552 I != E; ++I) {
1553 annotate(**I);
1554 }
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001555 AnnotatingParser Parser(Style, Line, Keywords);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001556 Line.Type = Parser.parseLine();
1557 if (Line.Type == LT_Invalid)
1558 return;
1559
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00001560 ExpressionParser ExprParser(Style, Keywords, Line);
Daniel Jasper400adc62013-02-08 15:28:42 +00001561 ExprParser.parse();
1562
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001563 if (Line.startsWith(TT_ObjCMethodSpecifier))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001564 Line.Type = LT_ObjCMethodDecl;
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001565 else if (Line.startsWith(TT_ObjCDecl))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001566 Line.Type = LT_ObjCDecl;
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001567 else if (Line.startsWith(TT_ObjCProperty))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001568 Line.Type = LT_ObjCProperty;
1569
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001570 Line.First->SpacesRequiredBefore = 1;
1571 Line.First->CanBreakBefore = Line.First->MustBreakBefore;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001572}
1573
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001574// This function heuristically determines whether 'Current' starts the name of a
1575// function declaration.
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001576static bool isFunctionDeclarationName(const FormatToken &Current,
1577 const AnnotatedLine &Line) {
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001578 auto skipOperatorName = [](const FormatToken* Next) -> const FormatToken* {
1579 for (; Next; Next = Next->Next) {
1580 if (Next->is(TT_OverloadedOperatorLParen))
1581 return Next;
1582 if (Next->is(TT_OverloadedOperator))
1583 continue;
1584 if (Next->isOneOf(tok::kw_new, tok::kw_delete)) {
1585 // For 'new[]' and 'delete[]'.
1586 if (Next->Next && Next->Next->is(tok::l_square) &&
1587 Next->Next->Next && Next->Next->Next->is(tok::r_square))
1588 Next = Next->Next->Next;
1589 continue;
1590 }
1591
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001592 break;
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001593 }
1594 return nullptr;
1595 };
1596
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001597 // Find parentheses of parameter list.
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001598 const FormatToken *Next = Current.Next;
1599 if (Current.is(tok::kw_operator)) {
1600 if (Current.Previous && Current.Previous->is(tok::coloncolon))
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001601 return false;
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001602 Next = skipOperatorName(Next);
1603 } else {
1604 if (!Current.is(TT_StartOfName) || Current.NestingLevel != 0)
1605 return false;
1606 for (; Next; Next = Next->Next) {
1607 if (Next->is(TT_TemplateOpener)) {
1608 Next = Next->MatchingParen;
1609 } else if (Next->is(tok::coloncolon)) {
1610 Next = Next->Next;
1611 if (!Next)
1612 return false;
1613 if (Next->is(tok::kw_operator)) {
1614 Next = skipOperatorName(Next->Next);
1615 break;
1616 }
1617 if (!Next->is(tok::identifier))
1618 return false;
1619 } else if (Next->is(tok::l_paren)) {
1620 break;
1621 } else {
1622 return false;
1623 }
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001624 }
1625 }
Birunthan Mohanathas525579d2015-07-15 19:11:58 +00001626
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001627 // Check whether parameter list can be long to a function declaration.
1628 if (!Next || !Next->is(tok::l_paren) || !Next->MatchingParen)
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001629 return false;
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001630 // If the lines ends with "{", this is likely an function definition.
1631 if (Line.Last->is(tok::l_brace))
1632 return true;
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001633 if (Next->Next == Next->MatchingParen)
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001634 return true; // Empty parentheses.
1635 // If there is an &/&& after the r_paren, this is likely a function.
1636 if (Next->MatchingParen->Next &&
1637 Next->MatchingParen->Next->is(TT_PointerOrReference))
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001638 return true;
Daniel Jasper193cdd32015-01-19 10:52:16 +00001639 for (const FormatToken *Tok = Next->Next; Tok && Tok != Next->MatchingParen;
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001640 Tok = Tok->Next) {
1641 if (Tok->is(tok::kw_const) || Tok->isSimpleTypeSpecifier() ||
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001642 Tok->isOneOf(TT_PointerOrReference, TT_StartOfName, tok::ellipsis))
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001643 return true;
Daniel Jasper0faa9132015-04-23 13:58:40 +00001644 if (Tok->isOneOf(tok::l_brace, tok::string_literal, TT_ObjCMethodExpr) ||
1645 Tok->Tok.isLiteral())
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001646 return false;
1647 }
1648 return false;
1649}
1650
Zachary Turner448592e2015-12-18 22:20:15 +00001651bool TokenAnnotator::mustBreakForReturnType(const AnnotatedLine &Line) const {
1652 assert(Line.MightBeFunctionDecl);
1653
1654 if ((Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_TopLevel ||
1655 Style.AlwaysBreakAfterReturnType ==
1656 FormatStyle::RTBS_TopLevelDefinitions) &&
1657 Line.Level > 0)
1658 return false;
1659
1660 switch (Style.AlwaysBreakAfterReturnType) {
1661 case FormatStyle::RTBS_None:
1662 return false;
1663 case FormatStyle::RTBS_All:
1664 case FormatStyle::RTBS_TopLevel:
1665 return true;
1666 case FormatStyle::RTBS_AllDefinitions:
1667 case FormatStyle::RTBS_TopLevelDefinitions:
1668 return Line.mightBeFunctionDefinition();
1669 }
1670
1671 return false;
1672}
1673
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001674void TokenAnnotator::calculateFormattingInformation(AnnotatedLine &Line) {
Daniel Jasper5f3ea472014-05-22 08:36:53 +00001675 for (SmallVectorImpl<AnnotatedLine *>::iterator I = Line.Children.begin(),
1676 E = Line.Children.end();
1677 I != E; ++I) {
1678 calculateFormattingInformation(**I);
1679 }
1680
Alexander Kornienko39856b72013-09-10 09:38:25 +00001681 Line.First->TotalLength =
1682 Line.First->IsMultiline ? Style.ColumnLimit : Line.First->ColumnWidth;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001683 if (!Line.First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001684 return;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001685 FormatToken *Current = Line.First->Next;
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001686 bool InFunctionDecl = Line.MightBeFunctionDecl;
Craig Topper2145bc02014-05-09 08:15:10 +00001687 while (Current) {
Daniel Jasperc3ff0cd2016-04-18 11:31:21 +00001688 if (isFunctionDeclarationName(*Current, Line))
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001689 Current->Type = TT_FunctionDeclarationName;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001690 if (Current->is(TT_LineComment)) {
Daniel Jasper84a12e12014-03-10 15:06:25 +00001691 if (Current->Previous->BlockKind == BK_BracedInit &&
1692 Current->Previous->opensScope())
Daniel Jasper5a611392013-12-19 21:41:37 +00001693 Current->SpacesRequiredBefore = Style.Cpp11BracedListStyle ? 0 : 1;
1694 else
1695 Current->SpacesRequiredBefore = Style.SpacesBeforeTrailingComments;
Daniel Jasper14e58e52014-03-21 11:58:45 +00001696
1697 // If we find a trailing comment, iterate backwards to determine whether
1698 // it seems to relate to a specific parameter. If so, break before that
1699 // parameter to avoid changing the comment's meaning. E.g. don't move 'b'
1700 // to the previous line in:
1701 // SomeFunction(a,
1702 // b, // comment
1703 // c);
Daniel Jasper28df0a32014-03-21 12:15:40 +00001704 if (!Current->HasUnescapedNewline) {
Daniel Jasper14e58e52014-03-21 11:58:45 +00001705 for (FormatToken *Parameter = Current->Previous; Parameter;
1706 Parameter = Parameter->Previous) {
1707 if (Parameter->isOneOf(tok::comment, tok::r_brace))
1708 break;
1709 if (Parameter->Previous && Parameter->Previous->is(tok::comma)) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001710 if (!Parameter->Previous->is(TT_CtorInitializerComma) &&
Daniel Jasper14e58e52014-03-21 11:58:45 +00001711 Parameter->HasUnescapedNewline)
1712 Parameter->MustBreakBefore = true;
1713 break;
1714 }
1715 }
1716 }
Daniel Jasperb88b25f2013-12-23 07:29:06 +00001717 } else if (Current->SpacesRequiredBefore == 0 &&
Daniel Jasper166c19b2014-05-06 14:12:21 +00001718 spaceRequiredBefore(Line, *Current)) {
Alexander Kornienko384b40b2013-10-11 21:43:05 +00001719 Current->SpacesRequiredBefore = 1;
Daniel Jasper5a611392013-12-19 21:41:37 +00001720 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001721
Daniel Jasperfb81b092013-09-17 09:52:48 +00001722 Current->MustBreakBefore =
1723 Current->MustBreakBefore || mustBreakBefore(Line, *Current);
1724
Zachary Turner448592e2015-12-18 22:20:15 +00001725 if (!Current->MustBreakBefore && InFunctionDecl &&
1726 Current->is(TT_FunctionDeclarationName))
1727 Current->MustBreakBefore = mustBreakForReturnType(Line);
Daniel Jasperca4ea1c2014-08-05 12:16:31 +00001728
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001729 Current->CanBreakBefore =
1730 Current->MustBreakBefore || canBreakBefore(Line, *Current);
Daniel Jasper5f3ea472014-05-22 08:36:53 +00001731 unsigned ChildSize = 0;
1732 if (Current->Previous->Children.size() == 1) {
1733 FormatToken &LastOfChild = *Current->Previous->Children[0]->Last;
1734 ChildSize = LastOfChild.isTrailingComment() ? Style.ColumnLimit
1735 : LastOfChild.TotalLength + 1;
1736 }
Nico Weberbeb03932015-01-09 23:25:06 +00001737 const FormatToken *Prev = Current->Previous;
Daniel Jasper56346192014-10-27 16:31:46 +00001738 if (Current->MustBreakBefore || Prev->Children.size() > 1 ||
1739 (Prev->Children.size() == 1 &&
1740 Prev->Children[0]->First->MustBreakBefore) ||
Alexander Kornienko39856b72013-09-10 09:38:25 +00001741 Current->IsMultiline)
Daniel Jasper56346192014-10-27 16:31:46 +00001742 Current->TotalLength = Prev->TotalLength + Style.ColumnLimit;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001743 else
Daniel Jasper56346192014-10-27 16:31:46 +00001744 Current->TotalLength = Prev->TotalLength + Current->ColumnWidth +
1745 ChildSize + Current->SpacesRequiredBefore;
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001746
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001747 if (Current->is(TT_CtorInitializerColon))
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001748 InFunctionDecl = false;
1749
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001750 // FIXME: Only calculate this if CanBreakBefore is true once static
1751 // initializers etc. are sorted out.
1752 // FIXME: Move magic numbers to a better place.
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001753 Current->SplitPenalty = 20 * Current->BindingStrength +
1754 splitPenalty(Line, *Current, InFunctionDecl);
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001755
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001756 Current = Current->Next;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001757 }
Daniel Jasper6bee6822013-04-08 20:33:42 +00001758
Manuel Klimek4fe43002013-05-22 12:51:29 +00001759 calculateUnbreakableTailLengths(Line);
Craig Topper2145bc02014-05-09 08:15:10 +00001760 for (Current = Line.First; Current != nullptr; Current = Current->Next) {
Daniel Jasper8de9ed02013-08-22 15:00:41 +00001761 if (Current->Role)
1762 Current->Role->precomputeFormattingInfos(Current);
1763 }
1764
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001765 DEBUG({ printDebugInfo(Line); });
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001766}
1767
Manuel Klimek4fe43002013-05-22 12:51:29 +00001768void TokenAnnotator::calculateUnbreakableTailLengths(AnnotatedLine &Line) {
1769 unsigned UnbreakableTailLength = 0;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001770 FormatToken *Current = Line.Last;
Craig Topper2145bc02014-05-09 08:15:10 +00001771 while (Current) {
Manuel Klimek4fe43002013-05-22 12:51:29 +00001772 Current->UnbreakableTailLength = UnbreakableTailLength;
1773 if (Current->CanBreakBefore ||
1774 Current->isOneOf(tok::comment, tok::string_literal)) {
1775 UnbreakableTailLength = 0;
1776 } else {
1777 UnbreakableTailLength +=
Alexander Kornienko39856b72013-09-10 09:38:25 +00001778 Current->ColumnWidth + Current->SpacesRequiredBefore;
Manuel Klimek4fe43002013-05-22 12:51:29 +00001779 }
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001780 Current = Current->Previous;
Manuel Klimek4fe43002013-05-22 12:51:29 +00001781 }
1782}
1783
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001784unsigned TokenAnnotator::splitPenalty(const AnnotatedLine &Line,
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001785 const FormatToken &Tok,
1786 bool InFunctionDecl) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001787 const FormatToken &Left = *Tok.Previous;
1788 const FormatToken &Right = Tok;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001789
Daniel Jasperbca4bbe2013-05-28 11:30:49 +00001790 if (Left.is(tok::semi))
1791 return 0;
Daniel Jasper734d52b2014-11-14 10:15:56 +00001792
1793 if (Style.Language == FormatStyle::LK_Java) {
Daniel Jasper375815d2014-11-26 12:31:19 +00001794 if (Right.isOneOf(Keywords.kw_extends, Keywords.kw_throws))
Daniel Jasper734d52b2014-11-14 10:15:56 +00001795 return 1;
1796 if (Right.is(Keywords.kw_implements))
1797 return 2;
1798 if (Left.is(tok::comma) && Left.NestingLevel == 0)
1799 return 3;
Daniel Jasper41368e92014-11-27 15:37:42 +00001800 } else if (Style.Language == FormatStyle::LK_JavaScript) {
Daniel Jasper7325aee2015-05-08 08:38:52 +00001801 if (Right.is(Keywords.kw_function) && Left.isNot(tok::comma))
Daniel Jasper41368e92014-11-27 15:37:42 +00001802 return 100;
Daniel Jasperb9a52812015-07-10 13:39:26 +00001803 if (Left.is(TT_JsTypeColon))
Daniel Jasperf412e262016-01-08 10:51:24 +00001804 return 35;
Daniel Jasper734d52b2014-11-14 10:15:56 +00001805 }
1806
Daniel Jasper783bac62014-04-15 09:54:30 +00001807 if (Left.is(tok::comma) || (Right.is(tok::identifier) && Right.Next &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001808 Right.Next->is(TT_DictLiteral)))
Daniel Jasperbca4bbe2013-05-28 11:30:49 +00001809 return 1;
Daniel Jasper7052ce62014-01-19 09:04:08 +00001810 if (Right.is(tok::l_square)) {
Daniel Jaspere1afb9b2015-12-30 12:23:00 +00001811 if (Style.Language == FormatStyle::LK_Proto)
Daniel Jasper7052ce62014-01-19 09:04:08 +00001812 return 1;
Daniel Jaspere1afb9b2015-12-30 12:23:00 +00001813 if (Left.is(tok::r_square))
Daniel Jasperf9168de2016-03-01 04:19:55 +00001814 return 200;
Daniel Jasper0ad28142015-05-13 08:47:16 +00001815 // Slightly prefer formatting local lambda definitions like functions.
1816 if (Right.is(TT_LambdaLSquare) && Left.is(tok::equal))
Daniel Jasper9c8a7742016-01-04 07:29:40 +00001817 return 35;
Daniel Jasper9970df12015-06-03 08:57:36 +00001818 if (!Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare,
1819 TT_ArrayInitializerLSquare))
Daniel Jasperecaba172014-06-10 13:27:57 +00001820 return 500;
Daniel Jasper7052ce62014-01-19 09:04:08 +00001821 }
Daniel Jasper734d52b2014-11-14 10:15:56 +00001822
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001823 if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
1824 Right.is(tok::kw_operator)) {
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001825 if (Line.startsWith(tok::kw_for) && Right.PartOfMultiVariableDeclStmt)
Daniel Jasper26d1b1d2013-02-24 18:54:32 +00001826 return 3;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001827 if (Left.is(TT_StartOfName))
Daniel Jasper3ca283a2015-05-15 09:58:11 +00001828 return 110;
Daniel Jasper63af7c42013-12-09 14:40:19 +00001829 if (InFunctionDecl && Right.NestingLevel == 0)
Daniel Jasper26d1b1d2013-02-24 18:54:32 +00001830 return Style.PenaltyReturnTypeOnItsOwnLine;
Daniel Jasper53643062013-08-19 10:16:18 +00001831 return 200;
Daniel Jasper26d1b1d2013-02-24 18:54:32 +00001832 }
Daniel Jasperb754a742015-03-12 15:04:53 +00001833 if (Right.is(TT_PointerOrReference))
Daniel Jasper414c9c62015-03-19 09:40:16 +00001834 return 190;
Daniel Jasper6f2b88a2015-06-05 13:18:09 +00001835 if (Right.is(TT_LambdaArrow))
Daniel Jaspere6623162015-03-02 10:35:13 +00001836 return 110;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001837 if (Left.is(tok::equal) && Right.is(tok::l_brace))
1838 return 150;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001839 if (Left.is(TT_CastRParen))
Daniel Jasper1bc1b502013-07-05 07:58:34 +00001840 return 100;
Daniel Jasper215d6c82014-01-22 08:04:52 +00001841 if (Left.is(tok::coloncolon) ||
1842 (Right.is(tok::period) && Style.Language == FormatStyle::LK_Proto))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001843 return 500;
Daniel Jasper83193602013-04-05 17:22:09 +00001844 if (Left.isOneOf(tok::kw_class, tok::kw_struct))
1845 return 5000;
Daniel Jasper99302ed2016-05-27 08:59:34 +00001846 if (Left.is(tok::comment))
1847 return 1000;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001848
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001849 if (Left.isOneOf(TT_RangeBasedForLoopColon, TT_InheritanceColon))
Daniel Jasper16b35622013-02-26 13:18:08 +00001850 return 2;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001851
Daniel Jasper4c6e0052013-08-27 14:24:43 +00001852 if (Right.isMemberAccess()) {
Daniel Jasperf901a572015-12-07 19:50:48 +00001853 // Breaking before the "./->" of a chained call/member access is reasonably
1854 // cheap, as formatting those with one call per line is generally
1855 // desirable. In particular, it should be cheaper to break before the call
1856 // than it is to break inside a call's parameters, which could lead to weird
1857 // "hanging" indents. The exception is the very last "./->" to support this
1858 // frequent pattern:
1859 //
1860 // aaaaaaaa.aaaaaaaa.bbbbbbb().ccccccccccccccccccccc(
1861 // dddddddd);
1862 //
1863 // which might otherwise be blown up onto many lines. Here, clang-format
1864 // won't produce "hanging" indents anyway as there is no other trailing
1865 // call.
Daniel Jasper00492f92016-01-05 13:03:50 +00001866 //
1867 // Also apply higher penalty is not a call as that might lead to a wrapping
1868 // like:
1869 //
1870 // aaaaaaa
1871 // .aaaaaaaaa.bbbbbbbb(cccccccc);
1872 return !Right.NextOperator || !Right.NextOperator->Previous->closesScope()
1873 ? 150
1874 : 35;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001875 }
1876
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001877 if (Right.is(TT_TrailingAnnotation) &&
Daniel Jaspere3f907f2014-06-02 09:52:08 +00001878 (!Right.Next || Right.Next->isNot(tok::l_paren))) {
Daniel Jasperec8e8382014-10-11 08:24:56 +00001879 // Moving trailing annotations to the next line is fine for ObjC method
1880 // declarations.
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001881 if (Line.startsWith(TT_ObjCMethodSpecifier))
Daniel Jasperec8e8382014-10-11 08:24:56 +00001882 return 10;
Daniel Jasper5550de62014-02-17 07:57:46 +00001883 // Generally, breaking before a trailing annotation is bad unless it is
1884 // function-like. It seems to be especially preferable to keep standard
1885 // annotations (i.e. "const", "final" and "override") on the same line.
Daniel Jasper43e6a282013-12-16 15:01:54 +00001886 // Use a slightly higher penalty after ")" so that annotations like
1887 // "const override" are kept together.
Daniel Jasperb48d3af2014-04-09 10:01:49 +00001888 bool is_short_annotation = Right.TokenText.size() < 10;
Daniel Jasperb05a81d2014-05-09 13:11:16 +00001889 return (Left.is(tok::r_paren) ? 100 : 120) + (is_short_annotation ? 50 : 0);
Daniel Jasper43e6a282013-12-16 15:01:54 +00001890 }
Daniel Jasper13c37b32013-05-22 08:28:26 +00001891
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001892 // In for-loops, prefer breaking at ',' and ';'.
Daniel Jaspere285b8d2015-06-17 09:43:56 +00001893 if (Line.startsWith(tok::kw_for) && Left.is(tok::equal))
Daniel Jasper37905f72013-02-21 15:00:29 +00001894 return 4;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001895
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001896 // In Objective-C method expressions, prefer breaking before "param:" over
1897 // breaking after it.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001898 if (Right.is(TT_SelectorName))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001899 return 0;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001900 if (Left.is(tok::colon) && Left.is(TT_ObjCMethodExpr))
Daniel Jasper4bf0d802013-11-23 14:27:27 +00001901 return Line.MightBeFunctionDecl ? 50 : 500;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001902
Daniel Jasper6501f7e2015-10-27 12:38:37 +00001903 if (Left.is(tok::l_paren) && InFunctionDecl &&
1904 Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign)
Daniel Jasper6728fc12013-04-11 14:29:13 +00001905 return 100;
Daniel Jasper3bacc4d2015-07-07 16:09:39 +00001906 if (Left.is(tok::l_paren) && Left.Previous &&
1907 Left.Previous->isOneOf(tok::kw_if, tok::kw_for))
Daniel Jaspera42de762015-02-26 09:49:08 +00001908 return 1000;
Daniel Jasper126153a2013-12-27 06:39:56 +00001909 if (Left.is(tok::equal) && InFunctionDecl)
1910 return 110;
Daniel Jaspera5621202014-08-08 12:00:13 +00001911 if (Right.is(tok::r_brace))
1912 return 1;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001913 if (Left.is(TT_TemplateOpener))
Daniel Jasperea79ea12014-08-15 05:00:39 +00001914 return 100;
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +00001915 if (Left.opensScope()) {
Daniel Jasper6501f7e2015-10-27 12:38:37 +00001916 if (Style.AlignAfterOpenBracket == FormatStyle::BAS_DontAlign)
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +00001917 return 0;
Daniel Jasper33b909c2013-10-25 14:29:37 +00001918 return Left.ParameterCount > 1 ? Style.PenaltyBreakBeforeFirstCallParameter
1919 : 19;
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +00001920 }
Daniel Jasper190fbda2015-01-14 10:36:31 +00001921 if (Left.is(TT_JavaAnnotation))
1922 return 50;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001923
Daniel Jasperba9ddb62013-02-06 21:04:05 +00001924 if (Right.is(tok::lessless)) {
Daniel Jasper2fd16632015-05-17 07:27:09 +00001925 if (Left.is(tok::string_literal) &&
Daniel Jasper00492f92016-01-05 13:03:50 +00001926 (Right.NextOperator || Right.OperatorIndex != 1)) {
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001927 StringRef Content = Left.TokenText;
Daniel Jasper0b1f76b2013-09-29 12:02:57 +00001928 if (Content.startswith("\""))
1929 Content = Content.drop_front(1);
1930 if (Content.endswith("\""))
1931 Content = Content.drop_back(1);
1932 Content = Content.trim();
Daniel Jasperf38a0ac2013-03-14 14:00:17 +00001933 if (Content.size() > 1 &&
1934 (Content.back() == ':' || Content.back() == '='))
Daniel Jasperfa21c072013-07-15 14:33:14 +00001935 return 25;
Daniel Jasperba9ddb62013-02-06 21:04:05 +00001936 }
Daniel Jasper49a94482013-07-15 15:04:42 +00001937 return 1; // Breaking at a << is really cheap.
Daniel Jasperba9ddb62013-02-06 21:04:05 +00001938 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001939 if (Left.is(TT_ConditionalExpr))
Daniel Jasper70bc8742013-02-26 13:59:14 +00001940 return prec::Conditional;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001941 prec::Level Level = Left.getPrecedence();
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001942 if (Level != prec::Unknown)
1943 return Level;
Daniel Jaspere92bf6f2015-05-06 14:23:38 +00001944 Level = Right.getPrecedence();
1945 if (Level != prec::Unknown)
1946 return Level;
Daniel Jasperf9a84b52013-03-01 16:48:32 +00001947
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001948 return 3;
1949}
1950
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001951bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001952 const FormatToken &Left,
1953 const FormatToken &Right) {
Daniel Jasper166c19b2014-05-06 14:12:21 +00001954 if (Left.is(tok::kw_return) && Right.isNot(tok::semi))
1955 return true;
Daniel Jaspere9beea22014-01-28 15:20:33 +00001956 if (Style.ObjCSpaceAfterProperty && Line.Type == LT_ObjCProperty &&
1957 Left.Tok.getObjCKeywordID() == tok::objc_property)
1958 return true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001959 if (Right.is(tok::hashhash))
1960 return Left.is(tok::hash);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001961 if (Left.isOneOf(tok::hashhash, tok::hash))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001962 return Right.is(tok::hash);
Daniel Jasperb55acad2013-08-20 12:36:34 +00001963 if (Left.is(tok::l_paren) && Right.is(tok::r_paren))
1964 return Style.SpaceInEmptyParentheses;
1965 if (Left.is(tok::l_paren) || Right.is(tok::r_paren))
Nico Weberbeb03932015-01-09 23:25:06 +00001966 return (Right.is(TT_CastRParen) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001967 (Left.MatchingParen && Left.MatchingParen->is(TT_CastRParen)))
Daniel Jasperb55acad2013-08-20 12:36:34 +00001968 ? Style.SpacesInCStyleCastParentheses
1969 : Style.SpacesInParentheses;
1970 if (Right.isOneOf(tok::semi, tok::comma))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001971 return false;
1972 if (Right.is(tok::less) &&
Daniel Jasper20e15562015-04-16 07:02:19 +00001973 (Left.is(tok::kw_template) ||
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001974 (Line.Type == LT_ObjCDecl && Style.ObjCSpaceBeforeProtocolList)))
1975 return true;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001976 if (Left.isOneOf(tok::exclaim, tok::tilde))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001977 return false;
1978 if (Left.is(tok::at) &&
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001979 Right.isOneOf(tok::identifier, tok::string_literal, tok::char_constant,
1980 tok::numeric_constant, tok::l_paren, tok::l_brace,
1981 tok::kw_true, tok::kw_false))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001982 return false;
Daniel Jasperffbad0e2016-01-04 07:28:12 +00001983 if (Left.is(tok::colon))
1984 return !Left.is(TT_ObjCMethodExpr);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001985 if (Left.is(tok::coloncolon))
1986 return false;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001987 if (Left.is(tok::less) || Right.isOneOf(tok::greater, tok::less))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001988 return false;
Daniel Jasperbafa6b72013-07-01 09:47:25 +00001989 if (Right.is(tok::ellipsis))
Daniel Jaspere2fab132016-05-19 06:19:17 +00001990 return Left.Tok.isLiteral() || (Left.is(tok::identifier) && Left.Previous &&
1991 Left.Previous->is(tok::kw_case));
Manuel Klimekbab25fd2013-09-04 08:20:47 +00001992 if (Left.is(tok::l_square) && Right.is(tok::amp))
1993 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001994 if (Right.is(TT_PointerOrReference))
Daniel Jasper2b4d6ea2016-06-08 08:23:46 +00001995 return (Left.is(tok::r_paren) && Line.MightBeFunctionDecl) ||
Daniel Jasper1c220482015-02-25 10:30:06 +00001996 (Left.Tok.isLiteral() ||
1997 (!Left.isOneOf(TT_PointerOrReference, tok::l_paren) &&
Daniel Jasperbea1ab42015-03-01 18:55:26 +00001998 (Style.PointerAlignment != FormatStyle::PAS_Left ||
1999 Line.IsMultiVariableDeclStmt)));
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002000 if (Right.is(TT_FunctionTypeLParen) && Left.isNot(tok::l_paren) &&
2001 (!Left.is(TT_PointerOrReference) ||
Daniel Jasperbea1ab42015-03-01 18:55:26 +00002002 (Style.PointerAlignment != FormatStyle::PAS_Right &&
2003 !Line.IsMultiVariableDeclStmt)))
Daniel Jaspercfda5172013-05-08 14:58:20 +00002004 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002005 if (Left.is(TT_PointerOrReference))
Daniel Jasper5d7f06f2015-08-24 14:28:08 +00002006 return Right.Tok.isLiteral() ||
2007 Right.isOneOf(TT_BlockComment, Keywords.kw_final,
2008 Keywords.kw_override) ||
Daniel Jasper60ba32d2015-06-12 09:59:16 +00002009 (Right.is(tok::l_brace) && Right.BlockKind == BK_Block) ||
Daniel Jasper532a0312015-04-23 10:23:53 +00002010 (!Right.isOneOf(TT_PointerOrReference, TT_ArraySubscriptLSquare,
2011 tok::l_paren) &&
Daniel Jasperbea1ab42015-03-01 18:55:26 +00002012 (Style.PointerAlignment != FormatStyle::PAS_Right &&
2013 !Line.IsMultiVariableDeclStmt) &&
2014 Left.Previous &&
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002015 !Left.Previous->isOneOf(tok::l_paren, tok::coloncolon));
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002016 if (Right.is(tok::star) && Left.is(tok::l_paren))
2017 return false;
Nico Weber2a726b62013-02-10 02:08:05 +00002018 if (Left.is(tok::l_square))
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002019 return (Left.is(TT_ArrayInitializerLSquare) &&
Daniel Jasperad981f82014-08-26 11:41:14 +00002020 Style.SpacesInContainerLiterals && Right.isNot(tok::r_square)) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002021 (Left.is(TT_ArraySubscriptLSquare) && Style.SpacesInSquareBrackets &&
2022 Right.isNot(tok::r_square));
Nico Weber2a726b62013-02-10 02:08:05 +00002023 if (Right.is(tok::r_square))
Daniel Jasperad981f82014-08-26 11:41:14 +00002024 return Right.MatchingParen &&
2025 ((Style.SpacesInContainerLiterals &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002026 Right.MatchingParen->is(TT_ArrayInitializerLSquare)) ||
Daniel Jasperad981f82014-08-26 11:41:14 +00002027 (Style.SpacesInSquareBrackets &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002028 Right.MatchingParen->is(TT_ArraySubscriptLSquare)));
2029 if (Right.is(tok::l_square) &&
2030 !Right.isOneOf(TT_ObjCMethodExpr, TT_LambdaLSquare) &&
2031 !Left.isOneOf(tok::numeric_constant, TT_DictLiteral))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002032 return false;
Daniel Jasper610381f2014-08-26 09:37:52 +00002033 if (Left.is(tok::l_brace) && Right.is(tok::r_brace))
2034 return !Left.Children.empty(); // No spaces in "{}".
2035 if ((Left.is(tok::l_brace) && Left.BlockKind != BK_Block) ||
2036 (Right.is(tok::r_brace) && Right.MatchingParen &&
2037 Right.MatchingParen->BlockKind != BK_Block))
2038 return !Style.Cpp11BracedListStyle;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002039 if (Left.is(TT_BlockComment))
Daniel Jasper484033b2014-05-06 14:41:29 +00002040 return !Left.TokenText.endswith("=*/");
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002041 if (Right.is(tok::l_paren)) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002042 if (Left.is(tok::r_paren) && Left.is(TT_AttributeParen))
Daniel Jasperee6d6502013-07-17 20:25:02 +00002043 return true;
Daniel Jasper79121232014-11-27 14:55:17 +00002044 return Line.Type == LT_ObjCDecl || Left.is(tok::semi) ||
Alexander Kornienkofdca83d2013-12-10 10:18:34 +00002045 (Style.SpaceBeforeParens != FormatStyle::SBPO_Never &&
Daniel Jasperd7884572015-08-14 12:44:06 +00002046 (Left.isOneOf(tok::kw_if, tok::pp_elif, tok::kw_for, tok::kw_while,
Daniel Jasper9cb1ac282015-10-07 15:09:08 +00002047 tok::kw_switch, tok::kw_case, TT_ForEachMacro,
2048 TT_ObjCForIn) ||
Nico Weberfac23712015-02-04 15:26:27 +00002049 (Left.isOneOf(tok::kw_try, Keywords.kw___except, tok::kw_catch,
2050 tok::kw_new, tok::kw_delete) &&
Daniel Jasper66cb8c52015-05-04 09:22:29 +00002051 (!Left.Previous || Left.Previous->isNot(tok::period))))) ||
Alexander Kornienkofdca83d2013-12-10 10:18:34 +00002052 (Style.SpaceBeforeParens == FormatStyle::SBPO_Always &&
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +00002053 (Left.is(tok::identifier) || Left.isFunctionLikeKeyword() ||
2054 Left.is(tok::r_paren)) &&
Alexander Kornienkofdca83d2013-12-10 10:18:34 +00002055 Line.Type != LT_PreprocessorDirective);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002056 }
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002057 if (Left.is(tok::at) && Right.Tok.getObjCKeywordID() != tok::objc_not_keyword)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002058 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002059 if (Right.is(TT_UnaryOperator))
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +00002060 return !Left.isOneOf(tok::l_paren, tok::l_square, tok::at) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002061 (Left.isNot(tok::colon) || Left.isNot(TT_ObjCMethodExpr));
Daniel Jasper4afc6b32014-06-02 10:57:55 +00002062 if ((Left.isOneOf(tok::identifier, tok::greater, tok::r_square,
2063 tok::r_paren) ||
Daniel Jasper7a2d60e2014-05-07 07:59:03 +00002064 Left.isSimpleTypeSpecifier()) &&
Manuel Klimekbab25fd2013-09-04 08:20:47 +00002065 Right.is(tok::l_brace) && Right.getNextNonComment() &&
2066 Right.BlockKind != BK_Block)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002067 return false;
Daniel Jasperbca4bbe2013-05-28 11:30:49 +00002068 if (Left.is(tok::period) || Right.is(tok::period))
2069 return false;
Alexander Kornienkod8d47fa2013-09-10 13:41:43 +00002070 if (Right.is(tok::hash) && Left.is(tok::identifier) && Left.TokenText == "L")
2071 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002072 if (Left.is(TT_TemplateCloser) && Left.MatchingParen &&
Daniel Jasper5ffcb7f2014-10-21 11:13:31 +00002073 Left.MatchingParen->Previous &&
2074 Left.MatchingParen->Previous->is(tok::period))
2075 // A.<B>DoSomething();
2076 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002077 if (Left.is(TT_TemplateCloser) && Right.is(tok::l_square))
Daniel Jasper6761b422014-11-18 23:48:01 +00002078 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002079 return true;
2080}
2081
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00002082bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
Daniel Jasper38efc132014-10-21 07:51:54 +00002083 const FormatToken &Right) {
2084 const FormatToken &Left = *Right.Previous;
Daniel Jasper23d3bcf2015-06-25 08:38:46 +00002085 if (Right.Tok.getIdentifierInfo() && Left.Tok.getIdentifierInfo())
2086 return true; // Never ever merge two identifiers.
2087 if (Style.Language == FormatStyle::LK_Cpp) {
2088 if (Left.is(tok::kw_operator))
2089 return Right.is(tok::coloncolon);
2090 } else if (Style.Language == FormatStyle::LK_Proto) {
Daniel Jasper38efc132014-10-21 07:51:54 +00002091 if (Right.is(tok::period) &&
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002092 Left.isOneOf(Keywords.kw_optional, Keywords.kw_required,
Daniel Jasperd8d98392015-11-20 14:32:54 +00002093 Keywords.kw_repeated, Keywords.kw_extend))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002094 return true;
Daniel Jasper38efc132014-10-21 07:51:54 +00002095 if (Right.is(tok::l_paren) &&
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002096 Left.isOneOf(Keywords.kw_returns, Keywords.kw_option))
Daniel Jasper38efc132014-10-21 07:51:54 +00002097 return true;
2098 } else if (Style.Language == FormatStyle::LK_JavaScript) {
Daniel Jaspera4607e12016-03-17 12:17:59 +00002099 if (Left.is(TT_JsFatArrow))
2100 return true;
Martin Probst5f8445b2016-04-24 22:05:09 +00002101 if (Right.is(tok::star) &&
2102 Left.isOneOf(Keywords.kw_function, Keywords.kw_yield))
2103 return false;
Daniel Jaspera4607e12016-03-17 12:17:59 +00002104 if (Left.isOneOf(Keywords.kw_let, Keywords.kw_var, Keywords.kw_in,
Daniel Jasper5dbcd3b2016-05-19 07:18:07 +00002105 Keywords.kw_of, tok::kw_const) &&
Daniel Jaspera4607e12016-03-17 12:17:59 +00002106 (!Left.Previous || !Left.Previous->is(tok::period)))
Daniel Jasper38efc132014-10-21 07:51:54 +00002107 return true;
Daniel Jasper5e271462016-01-04 16:10:36 +00002108 if (Left.is(tok::kw_default) && Left.Previous &&
2109 Left.Previous->is(tok::kw_export))
2110 return true;
Daniel Jasper779c66f2015-12-30 08:00:58 +00002111 if (Left.is(Keywords.kw_is) && Right.is(tok::l_brace))
2112 return true;
Daniel Jaspera74f5072015-04-13 15:01:40 +00002113 if (Right.isOneOf(TT_JsTypeColon, TT_JsTypeOptionalQuestion))
Daniel Jasperb10bdff2015-02-18 17:09:53 +00002114 return false;
Daniel Jasper91b1d1a2016-03-21 17:57:31 +00002115 if (Left.is(TT_JsTypeOperator) || Right.is(TT_JsTypeOperator))
2116 return false;
Daniel Jasper354aa512015-02-19 16:07:32 +00002117 if ((Left.is(tok::l_brace) || Right.is(tok::r_brace)) &&
Daniel Jasperfca735c2015-02-19 16:14:18 +00002118 Line.First->isOneOf(Keywords.kw_import, tok::kw_export))
Daniel Jasper354aa512015-02-19 16:07:32 +00002119 return false;
Daniel Jasper08051992015-05-26 07:18:56 +00002120 if (Left.is(tok::ellipsis))
2121 return false;
Daniel Jasperbc46b932015-03-15 13:59:51 +00002122 if (Left.is(TT_TemplateCloser) &&
Daniel Jasperd2219062015-05-02 07:54:58 +00002123 !Right.isOneOf(tok::equal, tok::l_brace, tok::comma, tok::l_square,
Daniel Jasperbc46b932015-03-15 13:59:51 +00002124 Keywords.kw_implements, Keywords.kw_extends))
2125 // Type assertions ('<type>expr') are not followed by whitespace. Other
2126 // locations that should have whitespace following are identified by the
2127 // above set of follower tokens.
2128 return false;
Martin Probst0eb40cf2016-06-13 00:49:54 +00002129 // Postfix non-null assertion operator, as in `foo!.bar()`.
2130 if (Right.is(tok::exclaim) && (Left.isOneOf(tok::identifier, tok::r_paren,
2131 tok::r_square, tok::r_brace) ||
2132 Left.Tok.isLiteral()))
2133 return false;
Daniel Jasperb9d3db62014-11-02 22:00:57 +00002134 } else if (Style.Language == FormatStyle::LK_Java) {
Daniel Jaspera0143fa2014-11-23 20:54:37 +00002135 if (Left.is(tok::r_square) && Right.is(tok::l_brace))
2136 return true;
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002137 if (Left.is(Keywords.kw_synchronized) && Right.is(tok::l_paren))
Daniel Jasperb9d3db62014-11-02 22:00:57 +00002138 return Style.SpaceBeforeParens != FormatStyle::SBPO_Never;
Daniel Jasper82c92752014-11-21 12:19:07 +00002139 if ((Left.isOneOf(tok::kw_static, tok::kw_public, tok::kw_private,
2140 tok::kw_protected) ||
Nico Webered501662015-01-13 22:32:50 +00002141 Left.isOneOf(Keywords.kw_final, Keywords.kw_abstract,
2142 Keywords.kw_native)) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002143 Right.is(TT_TemplateOpener))
Daniel Jasperdb9a7a22014-11-03 02:35:14 +00002144 return true;
Daniel Jasper38efc132014-10-21 07:51:54 +00002145 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002146 if (Left.is(TT_ImplicitStringLiteral))
Daniel Jasper38efc132014-10-21 07:51:54 +00002147 return Right.WhitespaceRange.getBegin() != Right.WhitespaceRange.getEnd();
2148 if (Line.Type == LT_ObjCMethodDecl) {
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002149 if (Left.is(TT_ObjCMethodSpecifier))
Daniel Jasper38efc132014-10-21 07:51:54 +00002150 return true;
2151 if (Left.is(tok::r_paren) && Right.is(tok::identifier))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002152 // Don't space between ')' and <id>
2153 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002154 }
2155 if (Line.Type == LT_ObjCProperty &&
Daniel Jasper38efc132014-10-21 07:51:54 +00002156 (Right.is(tok::equal) || Left.is(tok::equal)))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002157 return false;
2158
Daniel Jasper6f2b88a2015-06-05 13:18:09 +00002159 if (Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow) ||
2160 Left.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow))
Daniel Jasper6cdec7c2013-07-09 14:36:48 +00002161 return true;
Daniel Jasper804a2762016-01-09 15:56:40 +00002162 if (Right.is(TT_OverloadedOperatorLParen))
2163 return Style.SpaceBeforeParens == FormatStyle::SBPO_Always;
Daniel Jasper38efc132014-10-21 07:51:54 +00002164 if (Left.is(tok::comma))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002165 return true;
Daniel Jasper38efc132014-10-21 07:51:54 +00002166 if (Right.is(tok::comma))
Daniel Jasperff6c3a92013-02-28 13:40:17 +00002167 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002168 if (Right.isOneOf(TT_CtorInitializerColon, TT_ObjCBlockLParen))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002169 return true;
Daniel Jasper9326f912015-05-05 08:40:32 +00002170 if (Right.is(tok::colon)) {
2171 if (Line.First->isOneOf(tok::kw_case, tok::kw_default) ||
Daniel Jasper1fe0d5c2015-05-06 15:19:47 +00002172 !Right.getNextNonComment() || Right.getNextNonComment()->is(tok::semi))
Daniel Jasper9326f912015-05-05 08:40:32 +00002173 return false;
2174 if (Right.is(TT_ObjCMethodExpr))
2175 return false;
2176 if (Left.is(tok::question))
2177 return false;
2178 if (Right.is(TT_InlineASMColon) && Left.is(tok::coloncolon))
2179 return false;
2180 if (Right.is(TT_DictLiteral))
2181 return Style.SpacesInContainerLiterals;
2182 return true;
2183 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002184 if (Left.is(TT_UnaryOperator))
2185 return Right.is(TT_BinaryOperator);
Daniel Jaspercdb58b22015-05-15 09:05:31 +00002186
2187 // If the next token is a binary operator or a selector name, we have
2188 // incorrectly classified the parenthesis as a cast. FIXME: Detect correctly.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002189 if (Left.is(TT_CastRParen))
Daniel Jaspercdb58b22015-05-15 09:05:31 +00002190 return Style.SpaceAfterCStyleCast ||
2191 Right.isOneOf(TT_BinaryOperator, TT_SelectorName);
2192
Daniel Jaspere497bed2015-06-02 22:06:07 +00002193 if (Left.is(tok::greater) && Right.is(tok::greater))
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002194 return Right.is(TT_TemplateCloser) && Left.is(TT_TemplateCloser) &&
Daniel Jasperdd978ae2013-10-29 14:52:02 +00002195 (Style.Standard != FormatStyle::LS_Cpp11 || Style.SpacesInAngles);
Daniel Jasper38efc132014-10-21 07:51:54 +00002196 if (Right.isOneOf(tok::arrow, tok::period, tok::arrowstar, tok::periodstar) ||
2197 Left.isOneOf(tok::arrow, tok::period, tok::arrowstar, tok::periodstar))
Daniel Jasperff6c3a92013-02-28 13:40:17 +00002198 return false;
Daniel Jasperd94bff32013-09-25 15:15:02 +00002199 if (!Style.SpaceBeforeAssignmentOperators &&
Daniel Jasper38efc132014-10-21 07:51:54 +00002200 Right.getPrecedence() == prec::Assignment)
Daniel Jasperd94bff32013-09-25 15:15:02 +00002201 return false;
Daniel Jasper2b2c9672016-05-08 18:14:01 +00002202 if (Right.is(tok::coloncolon) && !Left.isOneOf(tok::l_brace, tok::comment))
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002203 return (Left.is(TT_TemplateOpener) &&
Daniel Jasperf322eb52014-10-23 20:22:22 +00002204 Style.Standard == FormatStyle::LS_Cpp03) ||
Manuel Klimek27f278182016-01-19 14:05:32 +00002205 !(Left.isOneOf(tok::identifier, tok::l_paren, tok::r_paren,
2206 tok::l_square) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002207 Left.isOneOf(TT_TemplateCloser, TT_TemplateOpener));
2208 if ((Left.is(TT_TemplateOpener)) != (Right.is(TT_TemplateCloser)))
Daniel Jasper16b107e2014-10-21 09:57:09 +00002209 return Style.SpacesInAngles;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002210 if ((Right.is(TT_BinaryOperator) && !Left.is(tok::l_paren)) ||
Daniel Jasper7fa524b2015-11-20 15:26:50 +00002211 (Left.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) &&
2212 !Right.is(tok::r_paren)))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002213 return true;
Daniel Jasperbeaa3222015-02-26 11:30:50 +00002214 if (Left.is(TT_TemplateCloser) && Right.is(tok::l_paren) &&
2215 Right.isNot(TT_FunctionTypeLParen))
Chad Rosier0a84f172014-08-05 17:58:54 +00002216 return Style.SpaceBeforeParens == FormatStyle::SBPO_Always;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002217 if (Right.is(TT_TemplateOpener) && Left.is(tok::r_paren) &&
2218 Left.MatchingParen && Left.MatchingParen->is(TT_OverloadedOperatorLParen))
Daniel Jasper8835a322014-10-20 13:56:30 +00002219 return false;
Daniel Jasper38efc132014-10-21 07:51:54 +00002220 if (Right.is(tok::less) && Left.isNot(tok::l_paren) &&
Daniel Jaspere285b8d2015-06-17 09:43:56 +00002221 Line.startsWith(tok::hash))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002222 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002223 if (Right.is(TT_TrailingUnaryOperator))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002224 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002225 if (Left.is(TT_RegexLiteral))
Daniel Jasperf9ae3122014-05-08 07:01:45 +00002226 return false;
Daniel Jasper38efc132014-10-21 07:51:54 +00002227 return spaceRequiredBetween(Line, Left, Right);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002228}
2229
Daniel Jaspere18ff372014-06-02 10:17:32 +00002230// Returns 'true' if 'Tok' is a brace we'd want to break before in Allman style.
2231static bool isAllmanBrace(const FormatToken &Tok) {
2232 return Tok.is(tok::l_brace) && Tok.BlockKind == BK_Block &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002233 !Tok.isOneOf(TT_ObjCBlockLBrace, TT_DictLiteral);
Daniel Jaspere18ff372014-06-02 10:17:32 +00002234}
2235
Daniel Jasperfb81b092013-09-17 09:52:48 +00002236bool TokenAnnotator::mustBreakBefore(const AnnotatedLine &Line,
2237 const FormatToken &Right) {
Daniel Jaspera125d532014-03-21 12:38:57 +00002238 const FormatToken &Left = *Right.Previous;
Manuel Klimek9e321992015-07-28 15:50:24 +00002239 if (Right.NewlinesBefore > 1 && Style.MaxEmptyLinesToKeep > 0)
Daniel Jaspera69ca9b2014-06-04 12:40:57 +00002240 return true;
Daniel Jasper64a328e2014-11-11 19:34:57 +00002241
Daniel Jasper9f4ec152015-06-17 09:44:07 +00002242 if (Style.Language == FormatStyle::LK_JavaScript) {
2243 // FIXME: This might apply to other languages and token kinds.
Daniel Jasperabd1f572016-03-02 22:44:03 +00002244 if (Right.is(tok::string_literal) && Left.is(tok::plus) && Left.Previous &&
2245 Left.Previous->is(tok::string_literal))
Daniel Jasper9f4ec152015-06-17 09:44:07 +00002246 return true;
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +00002247 if (Left.is(TT_DictLiteral) && Left.is(tok::l_brace) && Line.Level == 0 &&
2248 Left.Previous && Left.Previous->is(tok::equal) &&
2249 Line.First->isOneOf(tok::identifier, Keywords.kw_import, tok::kw_export,
2250 tok::kw_const) &&
Daniel Jasper9f642f72015-09-28 14:28:08 +00002251 // kw_var/kw_let are pseudo-tokens that are tok::identifier, so match
2252 // above.
2253 !Line.First->isOneOf(Keywords.kw_var, Keywords.kw_let))
Daniel Jasper9f4ec152015-06-17 09:44:07 +00002254 // Object literals on the top level of a file are treated as "enum-style".
2255 // Each key/value pair is put on a separate line, instead of bin-packing.
2256 return true;
2257 if (Left.is(tok::l_brace) && Line.Level == 0 &&
2258 (Line.startsWith(tok::kw_enum) ||
2259 Line.startsWith(tok::kw_export, tok::kw_enum)))
2260 // JavaScript top-level enum key/value pairs are put on separate lines
2261 // instead of bin-packing.
2262 return true;
2263 if (Right.is(tok::r_brace) && Left.is(tok::l_brace) &&
2264 !Left.Children.empty())
2265 // Support AllowShortFunctionsOnASingleLine for JavaScript.
2266 return Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_None ||
Daniel Jasper71e57452015-11-20 16:44:28 +00002267 Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_Empty ||
Daniel Jasper9f4ec152015-06-17 09:44:07 +00002268 (Left.NestingLevel == 0 && Line.Level == 0 &&
2269 Style.AllowShortFunctionsOnASingleLine ==
2270 FormatStyle::SFS_Inline);
2271 } else if (Style.Language == FormatStyle::LK_Java) {
2272 if (Right.is(tok::plus) && Left.is(tok::string_literal) && Right.Next &&
2273 Right.Next->is(tok::string_literal))
2274 return true;
2275 }
2276
Daniel Jasper64a328e2014-11-11 19:34:57 +00002277 // If the last token before a '}' is a comma or a trailing comment, the
2278 // intention is to insert a line break after it in order to make shuffling
2279 // around entries easier.
2280 const FormatToken *BeforeClosingBrace = nullptr;
Daniel Jasper308062b2015-02-27 08:41:05 +00002281 if (Left.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) &&
2282 Left.BlockKind != BK_Block && Left.MatchingParen)
Daniel Jasper64a328e2014-11-11 19:34:57 +00002283 BeforeClosingBrace = Left.MatchingParen->Previous;
Daniel Jasper308062b2015-02-27 08:41:05 +00002284 else if (Right.MatchingParen &&
2285 Right.MatchingParen->isOneOf(tok::l_brace,
2286 TT_ArrayInitializerLSquare))
Daniel Jasper64a328e2014-11-11 19:34:57 +00002287 BeforeClosingBrace = &Left;
2288 if (BeforeClosingBrace && (BeforeClosingBrace->is(tok::comma) ||
2289 BeforeClosingBrace->isTrailingComment()))
2290 return true;
2291
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002292 if (Right.is(tok::comment))
Daniel Jasper64a328e2014-11-11 19:34:57 +00002293 return Left.BlockKind != BK_BracedInit &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002294 Left.isNot(TT_CtorInitializerColon) &&
Manuel Klimek1fcbe672014-04-11 12:27:47 +00002295 (Right.NewlinesBefore > 0 && Right.HasUnescapedNewline);
Daniel Jasper015c7a92015-05-11 15:15:48 +00002296 if (Left.isTrailingComment())
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +00002297 return true;
Daniel Jasper015c7a92015-05-11 15:15:48 +00002298 if (Left.isStringLiteral() &&
2299 (Right.isStringLiteral() || Right.is(TT_ObjCStringLiteral)))
Daniel Jasperfb81b092013-09-17 09:52:48 +00002300 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002301 if (Right.Previous->IsUnterminatedLiteral)
Daniel Jasperfb81b092013-09-17 09:52:48 +00002302 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002303 if (Right.is(tok::lessless) && Right.Next &&
2304 Right.Previous->is(tok::string_literal) &&
2305 Right.Next->is(tok::string_literal))
Daniel Jasperfb81b092013-09-17 09:52:48 +00002306 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002307 if (Right.Previous->ClosesTemplateDeclaration &&
2308 Right.Previous->MatchingParen &&
2309 Right.Previous->MatchingParen->NestingLevel == 0 &&
2310 Style.AlwaysBreakTemplateDeclarations)
Daniel Jasperfb81b092013-09-17 09:52:48 +00002311 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002312 if ((Right.isOneOf(TT_CtorInitializerComma, TT_CtorInitializerColon)) &&
2313 Style.BreakConstructorInitializersBeforeComma &&
2314 !Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
Daniel Jasperfb81b092013-09-17 09:52:48 +00002315 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002316 if (Right.is(tok::string_literal) && Right.TokenText.startswith("R\""))
Daniel Jasperc39b56f2013-12-16 07:23:08 +00002317 // Raw string literals are special wrt. line breaks. The author has made a
2318 // deliberate choice and might have aligned the contents of the string
2319 // literal accordingly. Thus, we try keep existing line breaks.
2320 return Right.NewlinesBefore > 0;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002321 if (Right.Previous->is(tok::l_brace) && Right.NestingLevel == 1 &&
2322 Style.Language == FormatStyle::LK_Proto)
Daniel Jasperce2fdb02014-10-27 13:25:59 +00002323 // Don't put enums onto single lines in protocol buffers.
Daniel Jasper7052ce62014-01-19 09:04:08 +00002324 return true;
Daniel Jasperc6366072015-05-10 08:42:04 +00002325 if (Right.is(TT_InlineASMBrace))
2326 return Right.HasUnescapedNewline;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002327 if (isAllmanBrace(Left) || isAllmanBrace(Right))
Daniel Jasperc1bc38e2015-09-29 14:57:55 +00002328 return (Line.startsWith(tok::kw_enum) && Style.BraceWrapping.AfterEnum) ||
2329 (Line.startsWith(tok::kw_class) && Style.BraceWrapping.AfterClass) ||
2330 (Line.startsWith(tok::kw_struct) && Style.BraceWrapping.AfterStruct);
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002331 if (Style.Language == FormatStyle::LK_Proto && Left.isNot(tok::l_brace) &&
2332 Right.is(TT_SelectorName))
Daniel Jaspera382cbe2014-07-28 14:08:09 +00002333 return true;
Daniel Jasperd05d3a82015-01-08 13:56:57 +00002334 if (Left.is(TT_ObjCBlockLBrace) && !Style.AllowShortBlocksOnASingleLine)
Daniel Jasper76284682014-10-22 09:12:44 +00002335 return true;
Daniel Jasperb175d572014-04-09 09:53:23 +00002336
Daniel Jasper354aa512015-02-19 16:07:32 +00002337 if ((Style.Language == FormatStyle::LK_Java ||
2338 Style.Language == FormatStyle::LK_JavaScript) &&
2339 Left.is(TT_LeadingJavaAnnotation) &&
2340 Right.isNot(TT_LeadingJavaAnnotation) && Right.isNot(tok::l_paren) &&
Nico Weber2cd92f12015-10-15 16:03:01 +00002341 (Line.Last->is(tok::l_brace) || Style.BreakAfterJavaFieldAnnotations))
Daniel Jasper354aa512015-02-19 16:07:32 +00002342 return true;
2343
Daniel Jasperfb81b092013-09-17 09:52:48 +00002344 return false;
2345}
2346
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00002347bool TokenAnnotator::canBreakBefore(const AnnotatedLine &Line,
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002348 const FormatToken &Right) {
2349 const FormatToken &Left = *Right.Previous;
Daniel Jasperf26c7552014-10-17 13:36:14 +00002350
Daniel Jasperc83d7692015-06-09 11:39:22 +00002351 // Language-specific stuff.
Daniel Jasperf26c7552014-10-17 13:36:14 +00002352 if (Style.Language == FormatStyle::LK_Java) {
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002353 if (Left.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
2354 Keywords.kw_implements))
Daniel Jasperf26c7552014-10-17 13:36:14 +00002355 return false;
Daniel Jasperd0ec0d62014-11-04 12:41:02 +00002356 if (Right.isOneOf(Keywords.kw_throws, Keywords.kw_extends,
2357 Keywords.kw_implements))
Daniel Jasper58fcf6d2014-11-04 10:53:14 +00002358 return true;
Daniel Jasperc83d7692015-06-09 11:39:22 +00002359 } else if (Style.Language == FormatStyle::LK_JavaScript) {
Daniel Jasper11a87652016-01-14 05:37:52 +00002360 if (Left.is(tok::kw_return))
2361 return false; // Otherwise a semicolon is inserted.
Daniel Jasperc83d7692015-06-09 11:39:22 +00002362 if (Left.is(TT_JsFatArrow) && Right.is(tok::l_brace))
2363 return false;
Daniel Jasper5a3de1d2015-07-03 10:37:23 +00002364 if (Left.is(TT_JsTypeColon))
2365 return true;
Daniel Jasper779c66f2015-12-30 08:00:58 +00002366 if (Right.NestingLevel == 0 && Right.is(Keywords.kw_is))
2367 return false;
Daniel Jasper1ce41112016-02-01 11:20:47 +00002368 if (Left.is(Keywords.kw_in))
2369 return Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None;
2370 if (Right.is(Keywords.kw_in))
2371 return Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None;
Daniel Jasperf26c7552014-10-17 13:36:14 +00002372 }
2373
Daniel Jasper4bf0d802013-11-23 14:27:27 +00002374 if (Left.is(tok::at))
2375 return false;
Daniel Jasper437c3f52014-04-28 07:34:48 +00002376 if (Left.Tok.getObjCKeywordID() == tok::objc_interface)
2377 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002378 if (Left.isOneOf(TT_JavaAnnotation, TT_LeadingJavaAnnotation))
Daniel Jasper3e1bd142015-01-14 09:51:32 +00002379 return !Right.is(tok::l_paren);
Daniel Jasperb754a742015-03-12 15:04:53 +00002380 if (Right.is(TT_PointerOrReference))
2381 return Line.IsMultiVariableDeclStmt ||
2382 (Style.PointerAlignment == FormatStyle::PAS_Right &&
2383 (!Right.Next || Right.Next->isNot(TT_FunctionDeclarationName)));
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002384 if (Right.isOneOf(TT_StartOfName, TT_FunctionDeclarationName) ||
2385 Right.is(tok::kw_operator))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002386 return true;
Daniel Jasper414c9c62015-03-19 09:40:16 +00002387 if (Left.is(TT_PointerOrReference))
2388 return false;
Daniel Jasper165b29e2013-11-08 00:57:11 +00002389 if (Right.isTrailingComment())
2390 // We rely on MustBreakBefore being set correctly here as we should not
2391 // change the "binding" behavior of a comment.
Daniel Jasper5a611392013-12-19 21:41:37 +00002392 // The first comment in a braced lists is always interpreted as belonging to
2393 // the first list element. Otherwise, it should be placed outside of the
2394 // list.
2395 return Left.BlockKind == BK_BracedInit;
Daniel Jasper165b29e2013-11-08 00:57:11 +00002396 if (Left.is(tok::question) && Right.is(tok::colon))
2397 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002398 if (Right.is(TT_ConditionalExpr) || Right.is(tok::question))
Daniel Jasper165b29e2013-11-08 00:57:11 +00002399 return Style.BreakBeforeTernaryOperators;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002400 if (Left.is(TT_ConditionalExpr) || Left.is(tok::question))
Daniel Jasper165b29e2013-11-08 00:57:11 +00002401 return !Style.BreakBeforeTernaryOperators;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002402 if (Right.is(TT_InheritanceColon))
Daniel Jasper3a122c02014-02-14 18:22:40 +00002403 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002404 if (Right.is(tok::colon) &&
2405 !Right.isOneOf(TT_CtorInitializerColon, TT_InlineASMColon))
Daniel Jasperd39312ec2014-05-28 10:09:11 +00002406 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002407 if (Left.is(tok::colon) && (Left.isOneOf(TT_DictLiteral, TT_ObjCMethodExpr)))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002408 return true;
Daniel Jaspera7b14262015-05-13 10:23:03 +00002409 if (Right.is(TT_SelectorName) || (Right.is(tok::identifier) && Right.Next &&
2410 Right.Next->is(TT_ObjCMethodExpr)))
Daniel Jaspered41f772015-05-19 11:06:33 +00002411 return Left.isNot(tok::period); // FIXME: Properly parse ObjC calls.
Daniel Jasper9688ff12013-08-01 13:46:58 +00002412 if (Left.is(tok::r_paren) && Line.Type == LT_ObjCProperty)
2413 return true;
Daniel Jasper788ffd72015-08-24 15:10:01 +00002414 if (Left.ClosesTemplateDeclaration || Left.is(TT_FunctionAnnotationRParen))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002415 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002416 if (Right.isOneOf(TT_RangeBasedForLoopColon, TT_OverloadedOperatorLParen,
2417 TT_OverloadedOperator))
Daniel Jaspereead02b2013-02-14 08:42:54 +00002418 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002419 if (Left.is(TT_RangeBasedForLoopColon))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002420 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002421 if (Right.is(TT_RangeBasedForLoopColon))
Daniel Jasper37905f72013-02-21 15:00:29 +00002422 return false;
Daniel Jasperb754a742015-03-12 15:04:53 +00002423 if (Left.isOneOf(TT_TemplateCloser, TT_UnaryOperator) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002424 Left.is(tok::kw_operator))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002425 return false;
Daniel Jaspercaf84fe2015-04-23 12:59:09 +00002426 if (Left.is(tok::equal) && !Right.isOneOf(tok::kw_default, tok::kw_delete) &&
Daniel Jasper100ffc62015-08-21 11:44:57 +00002427 Line.Type == LT_VirtualFunctionDecl && Left.NestingLevel == 0)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002428 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002429 if (Left.is(tok::l_paren) && Left.is(TT_AttributeParen))
Daniel Jasper559b63c2014-01-28 20:13:43 +00002430 return false;
2431 if (Left.is(tok::l_paren) && Left.Previous &&
Daniel Jaspera42de762015-02-26 09:49:08 +00002432 (Left.Previous->isOneOf(TT_BinaryOperator, TT_CastRParen)))
Daniel Jasper559b63c2014-01-28 20:13:43 +00002433 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002434 if (Right.is(TT_ImplicitStringLiteral))
Daniel Jasper98857842013-10-30 13:54:53 +00002435 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002436
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002437 if (Right.is(tok::r_paren) || Right.is(TT_TemplateCloser))
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00002438 return false;
Daniel Jasperb9edcfb2015-07-07 13:50:50 +00002439 if (Right.is(tok::r_square) && Right.MatchingParen &&
2440 Right.MatchingParen->is(TT_LambdaLSquare))
2441 return false;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00002442
Daniel Jasper13c37b32013-05-22 08:28:26 +00002443 // We only break before r_brace if there was a corresponding break before
2444 // the l_brace, which is tracked by BreakBeforeClosingBrace.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00002445 if (Right.is(tok::r_brace))
2446 return Right.MatchingParen && Right.MatchingParen->BlockKind == BK_Block;
Daniel Jasper13c37b32013-05-22 08:28:26 +00002447
Daniel Jasperf9a09062014-04-09 10:29:11 +00002448 // Allow breaking after a trailing annotation, e.g. after a method
2449 // declaration.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002450 if (Left.is(TT_TrailingAnnotation))
Daniel Jasperf9a09062014-04-09 10:29:11 +00002451 return !Right.isOneOf(tok::l_brace, tok::semi, tok::equal, tok::l_paren,
2452 tok::less, tok::coloncolon);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002453
Daniel Jasperbf4755b2013-03-14 09:50:46 +00002454 if (Right.is(tok::kw___attribute))
2455 return true;
2456
Daniel Jasperaf5ba0e2013-02-23 07:46:38 +00002457 if (Left.is(tok::identifier) && Right.is(tok::string_literal))
2458 return true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +00002459
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002460 if (Right.is(tok::identifier) && Right.Next && Right.Next->is(TT_DictLiteral))
Daniel Jasper783bac62014-04-15 09:54:30 +00002461 return true;
2462
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002463 if (Left.is(TT_CtorInitializerComma) &&
Daniel Jaspere33d4af2013-07-26 16:56:36 +00002464 Style.BreakConstructorInitializersBeforeComma)
2465 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002466 if (Right.is(TT_CtorInitializerComma) &&
Daniel Jasperec01cd62013-10-08 05:11:18 +00002467 Style.BreakConstructorInitializersBeforeComma)
2468 return true;
Jacques Pienaarfc275112015-02-18 23:48:37 +00002469 if ((Left.is(tok::greater) && Right.is(tok::greater)) ||
2470 (Left.is(tok::less) && Right.is(tok::less)))
Daniel Jasper0de8efa2013-09-17 08:15:46 +00002471 return false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002472 if (Right.is(TT_BinaryOperator) &&
Daniel Jasperac043c92014-09-15 11:11:00 +00002473 Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None &&
2474 (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_All ||
2475 Right.getPrecedence() != prec::Assignment))
Daniel Jasper0a1e5ac2014-05-13 08:01:47 +00002476 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00002477 if (Left.is(TT_ArrayInitializerLSquare))
Daniel Jasper1db6c382013-10-22 15:30:28 +00002478 return true;
Daniel Jasper598dd332014-08-12 13:22:26 +00002479 if (Right.is(tok::kw_typename) && Left.isNot(tok::kw_const))
2480 return true;
Daniel Jasper043ac052015-07-03 10:12:53 +00002481 if ((Left.isBinaryOperator() || Left.is(TT_BinaryOperator)) &&
2482 !Left.isOneOf(tok::arrowstar, tok::lessless) &&
Daniel Jasperac043c92014-09-15 11:11:00 +00002483 Style.BreakBeforeBinaryOperators != FormatStyle::BOS_All &&
2484 (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None ||
2485 Left.getPrecedence() == prec::Assignment))
2486 return true;
2487 return Left.isOneOf(tok::comma, tok::coloncolon, tok::semi, tok::l_brace,
Daniel Jasper99302ed2016-05-27 08:59:34 +00002488 tok::kw_class, tok::kw_struct, tok::comment) ||
Daniel Jasper05cd9292015-03-26 18:46:28 +00002489 Right.isMemberAccess() ||
2490 Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow, tok::lessless,
2491 tok::colon, tok::l_square, tok::at) ||
Daniel Jasper1bc1b502013-07-05 07:58:34 +00002492 (Left.is(tok::r_paren) &&
Daniel Jasper559b63c2014-01-28 20:13:43 +00002493 Right.isOneOf(tok::identifier, tok::kw_const)) ||
Daniel Jasper1db6c382013-10-22 15:30:28 +00002494 (Left.is(tok::l_paren) && !Right.is(tok::r_paren));
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002495}
2496
Daniel Jasper6bee6822013-04-08 20:33:42 +00002497void TokenAnnotator::printDebugInfo(const AnnotatedLine &Line) {
2498 llvm::errs() << "AnnotatedTokens:\n";
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002499 const FormatToken *Tok = Line.First;
Daniel Jasper6bee6822013-04-08 20:33:42 +00002500 while (Tok) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002501 llvm::errs() << " M=" << Tok->MustBreakBefore
Birunthan Mohanathas67d81c82015-07-13 16:19:34 +00002502 << " C=" << Tok->CanBreakBefore
2503 << " T=" << getTokenTypeName(Tok->Type)
Daniel Jasperb10cbc42013-07-10 14:02:49 +00002504 << " S=" << Tok->SpacesRequiredBefore
Daniel Jasper17062ff2014-06-10 14:44:02 +00002505 << " B=" << Tok->BlockParameterCount
Daniel Jasperb10cbc42013-07-10 14:02:49 +00002506 << " P=" << Tok->SplitPenalty << " Name=" << Tok->Tok.getName()
Manuel Klimek71814b42013-10-11 21:25:45 +00002507 << " L=" << Tok->TotalLength << " PPK=" << Tok->PackingKind
2508 << " FakeLParens=";
Daniel Jasper6bee6822013-04-08 20:33:42 +00002509 for (unsigned i = 0, e = Tok->FakeLParens.size(); i != e; ++i)
2510 llvm::errs() << Tok->FakeLParens[i] << "/";
2511 llvm::errs() << " FakeRParens=" << Tok->FakeRParens << "\n";
Daniel Jasperb05a81d2014-05-09 13:11:16 +00002512 if (!Tok->Next)
Manuel Klimek71814b42013-10-11 21:25:45 +00002513 assert(Tok == Line.Last);
Manuel Klimek6e6310e2013-05-29 14:47:47 +00002514 Tok = Tok->Next;
Daniel Jasper6bee6822013-04-08 20:33:42 +00002515 }
2516 llvm::errs() << "----\n";
2517}
2518
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00002519} // namespace format
2520} // namespace clang