blob: 54644ad768ec9b7d2876890193268de597daf76d [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 Jasper6bee6822013-04-08 20:33:42 +000018#include "llvm/Support/Debug.h"
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000019
Chandler Carruth57f5fbe2014-04-21 22:55:36 +000020#define DEBUG_TYPE "format-token-annotator"
21
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000022namespace clang {
23namespace format {
24
Craig Topper318ed7c2013-07-01 04:03:19 +000025namespace {
26
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000027/// \brief A parser that gathers additional information about tokens.
28///
Alexander Kornienkoa5151272013-03-12 16:28:18 +000029/// The \c TokenAnnotator tries to match parenthesis and square brakets and
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000030/// store a parenthesis levels. It also tries to resolve matching "<" and ">"
31/// into template parameter lists.
32class AnnotatingParser {
33public:
Daniel Jasper8de9ed02013-08-22 15:00:41 +000034 AnnotatingParser(const FormatStyle &Style, AnnotatedLine &Line,
35 IdentifierInfo &Ident_in)
36 : Style(Style), Line(Line), CurrentToken(Line.First),
Daniel Jasperbc5cb4e2013-11-07 17:43:07 +000037 KeywordVirtualFound(false), AutoFound(false), Ident_in(Ident_in) {
Nico Weber9096fc02013-06-26 00:30:14 +000038 Contexts.push_back(Context(tok::unknown, 1, /*IsExpression=*/false));
Manuel Klimek819788d2014-03-18 11:22:45 +000039 resetTokenMetadata(CurrentToken);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000040 }
41
Nico Weber44449172013-02-12 16:17:07 +000042private:
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000043 bool parseAngle() {
Craig Topper2145bc02014-05-09 08:15:10 +000044 if (!CurrentToken)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000045 return false;
Daniel Jasper40aacf42013-03-14 13:45:21 +000046 ScopedContextCreator ContextCreator(*this, tok::less, 10);
Manuel Klimek6e6310e2013-05-29 14:47:47 +000047 FormatToken *Left = CurrentToken->Previous;
Daniel Jasperc697ad22013-02-06 10:05:46 +000048 Contexts.back().IsExpression = false;
Manuel Klimekf81e5c02014-03-27 11:17:36 +000049 // If there's a template keyword before the opening angle bracket, this is a
50 // template parameter, not an argument.
51 Contexts.back().InTemplateArgument =
Craig Topper2145bc02014-05-09 08:15:10 +000052 Left->Previous && Left->Previous->Tok.isNot(tok::kw_template);
Manuel Klimekf81e5c02014-03-27 11:17:36 +000053
Craig Topper2145bc02014-05-09 08:15:10 +000054 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000055 if (CurrentToken->is(tok::greater)) {
56 Left->MatchingParen = CurrentToken;
57 CurrentToken->MatchingParen = Left;
58 CurrentToken->Type = TT_TemplateCloser;
59 next();
60 return true;
61 }
Alexander Kornienko62b85b92013-03-13 14:41:29 +000062 if (CurrentToken->isOneOf(tok::r_paren, tok::r_square, tok::r_brace,
Daniel Jasper6f05e592013-05-15 13:46:48 +000063 tok::question, tok::colon))
64 return false;
Daniel Jasperd5893912013-06-01 18:56:00 +000065 // If a && or || is found and interpreted as a binary operator, this set
Daniel Jasper1027c6e2013-06-03 16:16:41 +000066 // of angles is likely part of something like "a < b && c > d". If the
Daniel Jasperd5893912013-06-01 18:56:00 +000067 // angles are inside an expression, the ||/&& might also be a binary
68 // operator that was misinterpreted because we are parsing template
69 // parameters.
70 // FIXME: This is getting out of hand, write a decent parser.
Manuel Klimek6e6310e2013-05-29 14:47:47 +000071 if (CurrentToken->Previous->isOneOf(tok::pipepipe, tok::ampamp) &&
Daniel Jasper6ba16382014-07-28 13:19:58 +000072 CurrentToken->Previous->Type == TT_BinaryOperator &&
73 Contexts[Contexts.size() - 2].IsExpression &&
Manuel Klimek6e6310e2013-05-29 14:47:47 +000074 Line.First->isNot(tok::kw_template))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000075 return false;
Daniel Jaspere11095a2013-02-14 15:01:34 +000076 updateParameterCount(Left, CurrentToken);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000077 if (!consumeToken())
78 return false;
79 }
80 return false;
81 }
82
83 bool parseParens(bool LookForDecls = false) {
Craig Topper2145bc02014-05-09 08:15:10 +000084 if (!CurrentToken)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000085 return false;
Daniel Jasper40aacf42013-03-14 13:45:21 +000086 ScopedContextCreator ContextCreator(*this, tok::l_paren, 1);
Daniel Jasperc697ad22013-02-06 10:05:46 +000087
88 // FIXME: This is a bit of a hack. Do better.
89 Contexts.back().ColonIsForRangeExpr =
90 Contexts.size() == 2 && Contexts[0].ColonIsForRangeExpr;
91
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000092 bool StartsObjCMethodExpr = false;
Manuel Klimek6e6310e2013-05-29 14:47:47 +000093 FormatToken *Left = CurrentToken->Previous;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000094 if (CurrentToken->is(tok::caret)) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +000095 // (^ can start a block type.
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000096 Left->Type = TT_ObjCBlockLParen;
Manuel Klimek6e6310e2013-05-29 14:47:47 +000097 } else if (FormatToken *MaybeSel = Left->Previous) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +000098 // @selector( starts a selector.
Manuel Klimek6e6310e2013-05-29 14:47:47 +000099 if (MaybeSel->isObjCAtKeyword(tok::objc_selector) && MaybeSel->Previous &&
100 MaybeSel->Previous->is(tok::at)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000101 StartsObjCMethodExpr = true;
102 }
103 }
104
Daniel Jaspera65e8872014-03-25 10:52:45 +0000105 if (Left->Previous &&
106 (Left->Previous->isOneOf(tok::kw_static_assert, tok::kw_if,
107 tok::kw_while, tok::l_paren, tok::comma) ||
108 Left->Previous->Type == TT_BinaryOperator)) {
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000109 // static_assert, if and while usually contain expressions.
Daniel Jasper8b1c6352013-08-01 17:58:23 +0000110 Contexts.back().IsExpression = true;
Daniel Jasper72ab43b2014-04-14 12:50:02 +0000111 } else if (Line.InPPDirective &&
Daniel Jasper866468a2014-04-14 13:15:29 +0000112 (!Left->Previous ||
113 (Left->Previous->isNot(tok::identifier) &&
114 Left->Previous->Type != TT_OverloadedOperator))) {
Daniel Jasper72ab43b2014-04-14 12:50:02 +0000115 Contexts.back().IsExpression = true;
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000116 } else if (Left->Previous && Left->Previous->is(tok::r_square) &&
117 Left->Previous->MatchingParen &&
118 Left->Previous->MatchingParen->Type == TT_LambdaLSquare) {
119 // This is a parameter list of a lambda expression.
120 Contexts.back().IsExpression = false;
Daniel Jasperc13ee342014-03-27 09:43:54 +0000121 } else if (Contexts[Contexts.size() - 2].CaretFound) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000122 // This is the parameter list of an ObjC block.
123 Contexts.back().IsExpression = false;
Daniel Jasper559b63c2014-01-28 20:13:43 +0000124 } else if (Left->Previous && Left->Previous->is(tok::kw___attribute)) {
125 Left->Type = TT_AttributeParen;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000126 } else if (Left->Previous && Left->Previous->IsForEachMacro) {
127 // The first argument to a foreach macro is a declaration.
128 Contexts.back().IsForEachMacro = true;
129 Contexts.back().IsExpression = false;
Daniel Jasperd46e07e2013-10-20 18:15:30 +0000130 }
Daniel Jasper8b1c6352013-08-01 17:58:23 +0000131
Daniel Jasperc697ad22013-02-06 10:05:46 +0000132 if (StartsObjCMethodExpr) {
133 Contexts.back().ColonIsObjCMethodExpr = true;
134 Left->Type = TT_ObjCMethodExpr;
135 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000136
Daniel Jasper37194282013-05-28 08:33:00 +0000137 bool MightBeFunctionType = CurrentToken->is(tok::star);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000138 bool HasMultipleLines = false;
139 bool HasMultipleParametersOnALine = false;
Craig Topper2145bc02014-05-09 08:15:10 +0000140 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000141 // LookForDecls is set when "if (" has been seen. Check for
142 // 'identifier' '*' 'identifier' followed by not '=' -- this
143 // '*' has to be a binary operator but determineStarAmpUsage() will
144 // categorize it as an unary operator, so set the right type here.
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000145 if (LookForDecls && CurrentToken->Next) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000146 FormatToken *Prev = CurrentToken->getPreviousNonComment();
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000147 if (Prev) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000148 FormatToken *PrevPrev = Prev->getPreviousNonComment();
Alexander Kornienkodd7ece52013-06-07 16:02:52 +0000149 FormatToken *Next = CurrentToken->Next;
150 if (PrevPrev && PrevPrev->is(tok::identifier) &&
151 Prev->isOneOf(tok::star, tok::amp, tok::ampamp) &&
152 CurrentToken->is(tok::identifier) && Next->isNot(tok::equal)) {
153 Prev->Type = TT_BinaryOperator;
154 LookForDecls = false;
155 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000156 }
157 }
158
Daniel Jasper59036852013-08-12 12:16:34 +0000159 if (CurrentToken->Previous->Type == TT_PointerOrReference &&
160 CurrentToken->Previous->Previous->isOneOf(tok::l_paren,
161 tok::coloncolon))
162 MightBeFunctionType = true;
Daniel Jasper91beebd2014-06-30 13:44:47 +0000163 if (CurrentToken->Previous->Type == TT_BinaryOperator)
164 Contexts.back().IsExpression = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000165 if (CurrentToken->is(tok::r_paren)) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000166 if (MightBeFunctionType && CurrentToken->Next &&
Daniel Jasper655d96a2013-07-16 11:37:21 +0000167 (CurrentToken->Next->is(tok::l_paren) ||
168 (CurrentToken->Next->is(tok::l_square) &&
169 !Contexts.back().IsExpression)))
Daniel Jasper37194282013-05-28 08:33:00 +0000170 Left->Type = TT_FunctionTypeLParen;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000171 Left->MatchingParen = CurrentToken;
172 CurrentToken->MatchingParen = Left;
173
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000174 if (StartsObjCMethodExpr) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000175 CurrentToken->Type = TT_ObjCMethodExpr;
Craig Topper2145bc02014-05-09 08:15:10 +0000176 if (Contexts.back().FirstObjCSelectorName) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000177 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
178 Contexts.back().LongestObjCSelectorName;
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000179 }
180 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000181
Daniel Jasper559b63c2014-01-28 20:13:43 +0000182 if (Left->Type == TT_AttributeParen)
183 CurrentToken->Type = TT_AttributeParen;
184
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000185 if (!HasMultipleLines)
186 Left->PackingKind = PPK_Inconclusive;
187 else if (HasMultipleParametersOnALine)
188 Left->PackingKind = PPK_BinPacked;
189 else
190 Left->PackingKind = PPK_OnePerLine;
191
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000192 next();
193 return true;
194 }
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000195 if (CurrentToken->isOneOf(tok::r_square, tok::r_brace))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000196 return false;
Daniel Jasper31745732014-01-19 07:46:32 +0000197 else if (CurrentToken->is(tok::l_brace))
198 Left->Type = TT_Unknown; // Not TT_ObjCBlockLParen
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000199 if (CurrentToken->is(tok::comma) && CurrentToken->Next &&
200 !CurrentToken->Next->HasUnescapedNewline &&
201 !CurrentToken->Next->isTrailingComment())
202 HasMultipleParametersOnALine = true;
Daniel Jaspercc7bf7f2014-04-03 09:00:49 +0000203 if (CurrentToken->isOneOf(tok::kw_const, tok::kw_auto) ||
Daniel Jasperc580af92014-03-11 09:29:46 +0000204 CurrentToken->isSimpleTypeSpecifier())
205 Contexts.back().IsExpression = false;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000206 FormatToken *Tok = CurrentToken;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000207 if (!consumeToken())
208 return false;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000209 updateParameterCount(Left, Tok);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000210 if (CurrentToken && CurrentToken->HasUnescapedNewline)
211 HasMultipleLines = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000212 }
213 return false;
214 }
215
216 bool parseSquare() {
217 if (!CurrentToken)
218 return false;
219
Alexander Kornienkoafaa8f52013-06-17 13:19:53 +0000220 // A '[' could be an index subscript (after an identifier or after
Nico Weber2a726b62013-02-10 02:08:05 +0000221 // ')' or ']'), it could be the start of an Objective-C method
222 // expression, or it could the the start of an Objective-C array literal.
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000223 FormatToken *Left = CurrentToken->Previous;
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000224 FormatToken *Parent = Left->getPreviousNonComment();
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000225 bool StartsObjCMethodExpr =
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000226 Contexts.back().CanBeExpression && Left->Type != TT_LambdaLSquare &&
Daniel Jasper89519082014-05-09 10:26:08 +0000227 CurrentToken->isNot(tok::l_brace) &&
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000228 (!Parent || Parent->isOneOf(tok::colon, tok::l_square, tok::l_paren,
229 tok::kw_return, tok::kw_throw) ||
Daniel Jasperc04baae2013-04-10 09:49:49 +0000230 Parent->isUnaryOperator() || Parent->Type == TT_ObjCForIn ||
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000231 Parent->Type == TT_CastRParen ||
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000232 getBinOpPrecedence(Parent->Tok.getKind(), true, true) > prec::Unknown);
Daniel Jasper40aacf42013-03-14 13:45:21 +0000233 ScopedContextCreator ContextCreator(*this, tok::l_square, 10);
Daniel Jasper97b89482013-03-13 07:49:51 +0000234 Contexts.back().IsExpression = true;
Daniel Jaspera1ea4cb2013-10-26 17:00:22 +0000235 bool ColonFound = false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000236
Daniel Jasperc697ad22013-02-06 10:05:46 +0000237 if (StartsObjCMethodExpr) {
238 Contexts.back().ColonIsObjCMethodExpr = true;
239 Left->Type = TT_ObjCMethodExpr;
Daniel Jasper1db6c382013-10-22 15:30:28 +0000240 } else if (Parent && Parent->is(tok::at)) {
241 Left->Type = TT_ArrayInitializerLSquare;
242 } else if (Left->Type == TT_Unknown) {
243 Left->Type = TT_ArraySubscriptLSquare;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000244 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000245
Craig Topper2145bc02014-05-09 08:15:10 +0000246 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000247 if (CurrentToken->is(tok::r_square)) {
Daniel Jasper9a8d48b2013-09-05 10:04:31 +0000248 if (CurrentToken->Next && CurrentToken->Next->is(tok::l_paren) &&
249 Left->Type == TT_ObjCMethodExpr) {
Nico Weber5d2624e2013-02-06 06:20:11 +0000250 // An ObjC method call is rarely followed by an open parenthesis.
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000251 // FIXME: Do we incorrectly label ":" with this?
252 StartsObjCMethodExpr = false;
253 Left->Type = TT_Unknown;
254 }
Daniel Jasper139d4a32014-04-08 13:07:41 +0000255 if (StartsObjCMethodExpr && CurrentToken->Previous != Left) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000256 CurrentToken->Type = TT_ObjCMethodExpr;
Nico Weber5d2624e2013-02-06 06:20:11 +0000257 // determineStarAmpUsage() thinks that '*' '[' is allocating an
258 // array of pointers, but if '[' starts a selector then '*' is a
259 // binary operator.
Craig Topper2145bc02014-05-09 08:15:10 +0000260 if (Parent && Parent->Type == TT_PointerOrReference)
Nico Weberac9bde22013-02-06 16:54:35 +0000261 Parent->Type = TT_BinaryOperator;
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000262 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000263 Left->MatchingParen = CurrentToken;
264 CurrentToken->MatchingParen = Left;
Craig Topper2145bc02014-05-09 08:15:10 +0000265 if (Contexts.back().FirstObjCSelectorName) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000266 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
267 Contexts.back().LongestObjCSelectorName;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000268 if (Left->BlockParameterCount > 1)
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000269 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName = 0;
270 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000271 next();
272 return true;
273 }
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000274 if (CurrentToken->isOneOf(tok::r_paren, tok::r_brace))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000275 return false;
Daniel Jaspera1ea4cb2013-10-26 17:00:22 +0000276 if (CurrentToken->is(tok::colon))
277 ColonFound = true;
Daniel Jasper1db6c382013-10-22 15:30:28 +0000278 if (CurrentToken->is(tok::comma) &&
Daniel Jaspera0e9be22014-01-28 18:51:11 +0000279 Style.Language != FormatStyle::LK_Proto &&
Daniel Jasperb596fb22013-10-24 10:31:50 +0000280 (Left->Type == TT_ArraySubscriptLSquare ||
Daniel Jaspera1ea4cb2013-10-26 17:00:22 +0000281 (Left->Type == TT_ObjCMethodExpr && !ColonFound)))
Daniel Jasper1db6c382013-10-22 15:30:28 +0000282 Left->Type = TT_ArrayInitializerLSquare;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000283 FormatToken* Tok = CurrentToken;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000284 if (!consumeToken())
285 return false;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000286 updateParameterCount(Left, Tok);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000287 }
288 return false;
289 }
290
291 bool parseBrace() {
Craig Topper2145bc02014-05-09 08:15:10 +0000292 if (CurrentToken) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000293 FormatToken *Left = CurrentToken->Previous;
Daniel Jasperc13ee342014-03-27 09:43:54 +0000294
295 if (Contexts.back().CaretFound)
296 Left->Type = TT_ObjCBlockLBrace;
297 Contexts.back().CaretFound = false;
298
Daniel Jasperb596fb22013-10-24 10:31:50 +0000299 ScopedContextCreator ContextCreator(*this, tok::l_brace, 1);
300 Contexts.back().ColonIsDictLiteral = true;
Daniel Jasper39485162014-05-22 09:00:33 +0000301 if (Left->BlockKind == BK_BracedInit)
302 Contexts.back().IsExpression = true;
Nico Weberced7d412013-05-26 05:39:26 +0000303
Craig Topper2145bc02014-05-09 08:15:10 +0000304 while (CurrentToken) {
Daniel Jasper8e357692013-05-06 08:27:33 +0000305 if (CurrentToken->is(tok::r_brace)) {
306 Left->MatchingParen = CurrentToken;
307 CurrentToken->MatchingParen = Left;
308 next();
309 return true;
310 }
311 if (CurrentToken->isOneOf(tok::r_paren, tok::r_square))
312 return false;
313 updateParameterCount(Left, CurrentToken);
Daniel Jaspera382cbe2014-07-28 14:08:09 +0000314 if (CurrentToken->is(tok::colon)) {
Daniel Jasper17062ff2014-06-10 14:44:02 +0000315 if (CurrentToken->getPreviousNonComment()->is(tok::identifier))
316 CurrentToken->getPreviousNonComment()->Type = TT_SelectorName;
Daniel Jasperb596fb22013-10-24 10:31:50 +0000317 Left->Type = TT_DictLiteral;
Daniel Jasper17062ff2014-06-10 14:44:02 +0000318 }
Daniel Jasper8e357692013-05-06 08:27:33 +0000319 if (!consumeToken())
320 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000321 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000322 }
323 return true;
324 }
Daniel Jasperdc7d5812013-02-20 12:56:39 +0000325
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000326 void updateParameterCount(FormatToken *Left, FormatToken *Current) {
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000327 if (Current->Type == TT_LambdaLSquare ||
328 (Current->is(tok::caret) && Current->Type == TT_UnaryOperator) ||
329 (Style.Language == FormatStyle::LK_JavaScript &&
330 Current->TokenText == "function")) {
331 ++Left->BlockParameterCount;
332 }
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000333 if (Current->is(tok::comma)) {
Daniel Jaspere11095a2013-02-14 15:01:34 +0000334 ++Left->ParameterCount;
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000335 if (!Left->Role)
336 Left->Role.reset(new CommaSeparatedList(Style));
337 Left->Role->CommaFound(Current);
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000338 } else if (Left->ParameterCount == 0 && Current->isNot(tok::comment)) {
Daniel Jaspere11095a2013-02-14 15:01:34 +0000339 Left->ParameterCount = 1;
Daniel Jasperb10cbc42013-07-10 14:02:49 +0000340 }
Daniel Jaspere11095a2013-02-14 15:01:34 +0000341 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000342
343 bool parseConditional() {
Craig Topper2145bc02014-05-09 08:15:10 +0000344 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000345 if (CurrentToken->is(tok::colon)) {
346 CurrentToken->Type = TT_ConditionalExpr;
347 next();
348 return true;
349 }
350 if (!consumeToken())
351 return false;
352 }
353 return false;
354 }
355
356 bool parseTemplateDeclaration() {
Craig Topper2145bc02014-05-09 08:15:10 +0000357 if (CurrentToken && CurrentToken->is(tok::less)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000358 CurrentToken->Type = TT_TemplateOpener;
359 next();
360 if (!parseAngle())
361 return false;
Craig Topper2145bc02014-05-09 08:15:10 +0000362 if (CurrentToken)
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000363 CurrentToken->Previous->ClosesTemplateDeclaration = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000364 return true;
365 }
366 return false;
367 }
368
369 bool consumeToken() {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000370 FormatToken *Tok = CurrentToken;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000371 next();
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000372 switch (Tok->Tok.getKind()) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000373 case tok::plus:
374 case tok::minus:
Craig Topper2145bc02014-05-09 08:15:10 +0000375 if (!Tok->Previous && Line.MustBeDeclaration)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000376 Tok->Type = TT_ObjCMethodSpecifier;
377 break;
378 case tok::colon:
Craig Topper2145bc02014-05-09 08:15:10 +0000379 if (!Tok->Previous)
Daniel Jasper850677d2013-03-18 12:50:26 +0000380 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000381 // Colons from ?: are handled in parseConditional().
Daniel Jasper031e2402014-04-28 07:48:36 +0000382 if (Tok->Previous->is(tok::r_paren) && Contexts.size() == 1 &&
383 Line.First->isNot(tok::kw_case)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000384 Tok->Type = TT_CtorInitializerColon;
Daniel Jasperb596fb22013-10-24 10:31:50 +0000385 } else if (Contexts.back().ColonIsDictLiteral) {
386 Tok->Type = TT_DictLiteral;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000387 } else if (Contexts.back().ColonIsObjCMethodExpr ||
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000388 Line.First->Type == TT_ObjCMethodSpecifier) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000389 Tok->Type = TT_ObjCMethodExpr;
Daniel Jasper17062ff2014-06-10 14:44:02 +0000390 Tok->Previous->Type = TT_SelectorName;
Alexander Kornienko39856b72013-09-10 09:38:25 +0000391 if (Tok->Previous->ColumnWidth >
Alexander Kornienkoffcc0102013-06-05 14:09:10 +0000392 Contexts.back().LongestObjCSelectorName) {
Alexander Kornienko60d1b042013-10-10 13:36:20 +0000393 Contexts.back().LongestObjCSelectorName = Tok->Previous->ColumnWidth;
Alexander Kornienkoffcc0102013-06-05 14:09:10 +0000394 }
Craig Topper2145bc02014-05-09 08:15:10 +0000395 if (!Contexts.back().FirstObjCSelectorName)
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000396 Contexts.back().FirstObjCSelectorName = Tok->Previous;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000397 } else if (Contexts.back().ColonIsForRangeExpr) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000398 Tok->Type = TT_RangeBasedForLoopColon;
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000399 } else if (CurrentToken && CurrentToken->is(tok::numeric_constant)) {
Alexander Kornienko60d1b042013-10-10 13:36:20 +0000400 Tok->Type = TT_BitFieldColon;
Daniel Jasperd39312ec2014-05-28 10:09:11 +0000401 } else if (Contexts.size() == 1 &&
402 !Line.First->isOneOf(tok::kw_enum, tok::kw_case)) {
Daniel Jaspereead02b2013-02-14 08:42:54 +0000403 Tok->Type = TT_InheritanceColon;
Daniel Jasper40aacf42013-03-14 13:45:21 +0000404 } else if (Contexts.back().ContextKind == tok::l_paren) {
405 Tok->Type = TT_InlineASMColon;
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000406 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000407 break;
408 case tok::kw_if:
409 case tok::kw_while:
Craig Topper2145bc02014-05-09 08:15:10 +0000410 if (CurrentToken && CurrentToken->is(tok::l_paren)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000411 next();
Nico Weber9096fc02013-06-26 00:30:14 +0000412 if (!parseParens(/*LookForDecls=*/true))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000413 return false;
414 }
415 break;
416 case tok::kw_for:
Daniel Jasperc697ad22013-02-06 10:05:46 +0000417 Contexts.back().ColonIsForRangeExpr = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000418 next();
419 if (!parseParens())
420 return false;
421 break;
422 case tok::l_paren:
423 if (!parseParens())
424 return false;
Daniel Jasperbc5cb4e2013-11-07 17:43:07 +0000425 if (Line.MustBeDeclaration && Contexts.size() == 1 &&
Daniel Jasperf10a28d2014-05-05 13:48:09 +0000426 !Contexts.back().IsExpression &&
427 Line.First->Type != TT_ObjCProperty &&
428 (!Tok->Previous || Tok->Previous->isNot(tok::kw_decltype)))
Daniel Jasper26d1b1d2013-02-24 18:54:32 +0000429 Line.MightBeFunctionDecl = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000430 break;
431 case tok::l_square:
432 if (!parseSquare())
433 return false;
434 break;
435 case tok::l_brace:
436 if (!parseBrace())
437 return false;
438 break;
439 case tok::less:
Daniel Jasper62c0ac02013-07-30 22:37:19 +0000440 if (Tok->Previous && !Tok->Previous->Tok.isLiteral() && parseAngle())
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000441 Tok->Type = TT_TemplateOpener;
442 else {
443 Tok->Type = TT_BinaryOperator;
444 CurrentToken = Tok;
445 next();
446 }
447 break;
448 case tok::r_paren:
449 case tok::r_square:
450 return false;
451 case tok::r_brace:
452 // Lines can start with '}'.
Craig Topper2145bc02014-05-09 08:15:10 +0000453 if (Tok->Previous)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000454 return false;
455 break;
456 case tok::greater:
457 Tok->Type = TT_BinaryOperator;
458 break;
459 case tok::kw_operator:
Daniel Jasper42401c82013-09-02 09:20:39 +0000460 while (CurrentToken &&
461 !CurrentToken->isOneOf(tok::l_paren, tok::semi, tok::r_paren)) {
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000462 if (CurrentToken->isOneOf(tok::star, tok::amp))
Daniel Jasper35d2dc72013-02-11 08:01:18 +0000463 CurrentToken->Type = TT_PointerOrReference;
464 consumeToken();
Daniel Jasper42401c82013-09-02 09:20:39 +0000465 if (CurrentToken && CurrentToken->Previous->Type == TT_BinaryOperator)
Daniel Jasperd215b8b2013-08-28 07:27:35 +0000466 CurrentToken->Previous->Type = TT_OverloadedOperator;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000467 }
Daniel Jasper8f9624b2013-05-10 07:59:58 +0000468 if (CurrentToken) {
Daniel Jasper35d2dc72013-02-11 08:01:18 +0000469 CurrentToken->Type = TT_OverloadedOperatorLParen;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000470 if (CurrentToken->Previous->Type == TT_BinaryOperator)
471 CurrentToken->Previous->Type = TT_OverloadedOperator;
Daniel Jasper8f9624b2013-05-10 07:59:58 +0000472 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000473 break;
474 case tok::question:
475 parseConditional();
476 break;
477 case tok::kw_template:
478 parseTemplateDeclaration();
479 break;
Nico Weber29f9dea2013-02-11 15:32:15 +0000480 case tok::identifier:
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000481 if (Line.First->is(tok::kw_for) &&
482 Tok->Tok.getIdentifierInfo() == &Ident_in)
Nico Weber29f9dea2013-02-11 15:32:15 +0000483 Tok->Type = TT_ObjCForIn;
484 break;
Daniel Jaspera628c982013-04-03 13:36:17 +0000485 case tok::comma:
486 if (Contexts.back().FirstStartOfName)
487 Contexts.back().FirstStartOfName->PartOfMultiVariableDeclStmt = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000488 if (Contexts.back().InCtorInitializer)
489 Tok->Type = TT_CtorInitializerComma;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000490 if (Contexts.back().IsForEachMacro)
491 Contexts.back().IsExpression = true;
Daniel Jaspera628c982013-04-03 13:36:17 +0000492 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000493 default:
494 break;
495 }
496 return true;
497 }
498
499 void parseIncludeDirective() {
500 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000501 if (CurrentToken && CurrentToken->is(tok::less)) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000502 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000503 while (CurrentToken) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000504 if (CurrentToken->isNot(tok::comment) || CurrentToken->Next)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000505 CurrentToken->Type = TT_ImplicitStringLiteral;
506 next();
507 }
508 } else {
Craig Topper2145bc02014-05-09 08:15:10 +0000509 while (CurrentToken) {
Daniel Jasperaf5ba0e2013-02-23 07:46:38 +0000510 if (CurrentToken->is(tok::string_literal))
511 // Mark these string literals as "implicit" literals, too, so that
512 // they are not split or line-wrapped.
513 CurrentToken->Type = TT_ImplicitStringLiteral;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000514 next();
515 }
516 }
517 }
518
519 void parseWarningOrError() {
520 next();
521 // We still want to format the whitespace left of the first token of the
522 // warning or error.
523 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000524 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000525 CurrentToken->Type = TT_ImplicitStringLiteral;
526 next();
527 }
528 }
529
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000530 void parsePragma() {
531 next(); // Consume "pragma".
532 if (CurrentToken && CurrentToken->TokenText == "mark") {
533 next(); // Consume "mark".
534 next(); // Consume first token (so we fix leading whitespace).
Craig Topper2145bc02014-05-09 08:15:10 +0000535 while (CurrentToken) {
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000536 CurrentToken->Type = TT_ImplicitStringLiteral;
537 next();
538 }
539 }
540 }
541
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000542 void parsePreprocessorDirective() {
543 next();
Craig Topper2145bc02014-05-09 08:15:10 +0000544 if (!CurrentToken)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000545 return;
Alexander Kornienko384b40b2013-10-11 21:43:05 +0000546 if (CurrentToken->Tok.is(tok::numeric_constant)) {
547 CurrentToken->SpacesRequiredBefore = 1;
548 return;
549 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000550 // Hashes in the middle of a line can lead to any strange token
551 // sequence.
Craig Topper2145bc02014-05-09 08:15:10 +0000552 if (!CurrentToken->Tok.getIdentifierInfo())
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000553 return;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000554 switch (CurrentToken->Tok.getIdentifierInfo()->getPPKeywordID()) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000555 case tok::pp_include:
556 case tok::pp_import:
557 parseIncludeDirective();
558 break;
559 case tok::pp_error:
560 case tok::pp_warning:
561 parseWarningOrError();
562 break;
Daniel Jasperdc32c1b2014-01-09 13:56:49 +0000563 case tok::pp_pragma:
564 parsePragma();
565 break;
Daniel Jasper4431aa92013-04-23 13:54:04 +0000566 case tok::pp_if:
567 case tok::pp_elif:
Daniel Jasper7cfde412014-01-21 08:56:09 +0000568 Contexts.back().IsExpression = true;
Daniel Jasper4431aa92013-04-23 13:54:04 +0000569 parseLine();
570 break;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000571 default:
572 break;
573 }
Craig Topper2145bc02014-05-09 08:15:10 +0000574 while (CurrentToken)
Daniel Jaspera885dbe2013-02-05 09:34:14 +0000575 next();
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000576 }
577
Nico Weber44449172013-02-12 16:17:07 +0000578public:
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000579 LineType parseLine() {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000580 if (CurrentToken->is(tok::hash)) {
581 parsePreprocessorDirective();
582 return LT_PreprocessorDirective;
583 }
Daniel Jasper7cfde412014-01-21 08:56:09 +0000584
Daniel Jasper47ef6dd2014-01-17 16:21:39 +0000585 // Directly allow to 'import <string-literal>' to support protocol buffer
586 // definitions (code.google.com/p/protobuf) or missing "#" (either way we
587 // should not break the line).
588 IdentifierInfo *Info = CurrentToken->Tok.getIdentifierInfo();
589 if (Info && Info->getPPKeywordID() == tok::pp_import &&
590 CurrentToken->Next && CurrentToken->Next->is(tok::string_literal))
591 parseIncludeDirective();
592
Craig Topper2145bc02014-05-09 08:15:10 +0000593 while (CurrentToken) {
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000594 if (CurrentToken->is(tok::kw_virtual))
595 KeywordVirtualFound = true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000596 if (!consumeToken())
597 return LT_Invalid;
598 }
599 if (KeywordVirtualFound)
600 return LT_VirtualFunctionDecl;
601
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000602 if (Line.First->Type == TT_ObjCMethodSpecifier) {
Craig Topper2145bc02014-05-09 08:15:10 +0000603 if (Contexts.back().FirstObjCSelectorName)
Daniel Jasperc697ad22013-02-06 10:05:46 +0000604 Contexts.back().FirstObjCSelectorName->LongestObjCSelectorName =
605 Contexts.back().LongestObjCSelectorName;
Daniel Jasper1ac3e052013-02-05 10:07:47 +0000606 return LT_ObjCMethodDecl;
607 }
608
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000609 return LT_Other;
610 }
611
Nico Weber44449172013-02-12 16:17:07 +0000612private:
Manuel Klimek819788d2014-03-18 11:22:45 +0000613 void resetTokenMetadata(FormatToken *Token) {
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000614 if (!Token)
615 return;
Manuel Klimek819788d2014-03-18 11:22:45 +0000616
617 // Reset token type in case we have already looked at it and then
618 // recovered from an error (e.g. failure to find the matching >).
619 if (CurrentToken->Type != TT_LambdaLSquare &&
620 CurrentToken->Type != TT_FunctionLBrace &&
621 CurrentToken->Type != TT_ImplicitStringLiteral &&
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000622 CurrentToken->Type != TT_RegexLiteral &&
Manuel Klimek819788d2014-03-18 11:22:45 +0000623 CurrentToken->Type != TT_TrailingReturnArrow)
624 CurrentToken->Type = TT_Unknown;
David Blaikie3875a822014-07-19 01:06:45 +0000625 CurrentToken->Role.reset();
Manuel Klimek819788d2014-03-18 11:22:45 +0000626 CurrentToken->FakeLParens.clear();
627 CurrentToken->FakeRParens = 0;
628 }
629
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000630 void next() {
Craig Topper2145bc02014-05-09 08:15:10 +0000631 if (CurrentToken) {
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000632 determineTokenType(*CurrentToken);
Daniel Jasperc697ad22013-02-06 10:05:46 +0000633 CurrentToken->BindingStrength = Contexts.back().BindingStrength;
Daniel Jasper63af7c42013-12-09 14:40:19 +0000634 CurrentToken->NestingLevel = Contexts.size() - 1;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000635 CurrentToken = CurrentToken->Next;
Daniel Jasperf9ae3122014-05-08 07:01:45 +0000636 }
Daniel Jasper5065bc42013-02-18 12:44:35 +0000637
Manuel Klimek819788d2014-03-18 11:22:45 +0000638 resetTokenMetadata(CurrentToken);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000639 }
640
Daniel Jasperc697ad22013-02-06 10:05:46 +0000641 /// \brief A struct to hold information valid in a specific context, e.g.
642 /// a pair of parenthesis.
643 struct Context {
Daniel Jasper40aacf42013-03-14 13:45:21 +0000644 Context(tok::TokenKind ContextKind, unsigned BindingStrength,
645 bool IsExpression)
646 : ContextKind(ContextKind), BindingStrength(BindingStrength),
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000647 LongestObjCSelectorName(0), ColonIsForRangeExpr(false),
648 ColonIsDictLiteral(false), ColonIsObjCMethodExpr(false),
649 FirstObjCSelectorName(nullptr), FirstStartOfName(nullptr),
650 IsExpression(IsExpression), CanBeExpression(true),
651 InTemplateArgument(false), InCtorInitializer(false),
652 CaretFound(false), IsForEachMacro(false) {}
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000653
Daniel Jasper40aacf42013-03-14 13:45:21 +0000654 tok::TokenKind ContextKind;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000655 unsigned BindingStrength;
656 unsigned LongestObjCSelectorName;
657 bool ColonIsForRangeExpr;
Daniel Jasperb596fb22013-10-24 10:31:50 +0000658 bool ColonIsDictLiteral;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000659 bool ColonIsObjCMethodExpr;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000660 FormatToken *FirstObjCSelectorName;
661 FormatToken *FirstStartOfName;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000662 bool IsExpression;
Daniel Jasper97b89482013-03-13 07:49:51 +0000663 bool CanBeExpression;
Manuel Klimekf81e5c02014-03-27 11:17:36 +0000664 bool InTemplateArgument;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000665 bool InCtorInitializer;
Daniel Jaspera225bce2014-01-16 19:14:34 +0000666 bool CaretFound;
Daniel Jaspere1e43192014-04-01 12:55:11 +0000667 bool IsForEachMacro;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000668 };
669
670 /// \brief Puts a new \c Context onto the stack \c Contexts for the lifetime
671 /// of each instance.
672 struct ScopedContextCreator {
673 AnnotatingParser &P;
674
Daniel Jasper40aacf42013-03-14 13:45:21 +0000675 ScopedContextCreator(AnnotatingParser &P, tok::TokenKind ContextKind,
676 unsigned Increase)
677 : P(P) {
Daniel Jasper3ac9b9e2013-07-08 14:34:09 +0000678 P.Contexts.push_back(Context(ContextKind,
679 P.Contexts.back().BindingStrength + Increase,
680 P.Contexts.back().IsExpression));
Daniel Jasperc697ad22013-02-06 10:05:46 +0000681 }
682
683 ~ScopedContextCreator() { P.Contexts.pop_back(); }
684 };
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000685
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000686 void determineTokenType(FormatToken &Current) {
687 if (Current.getPrecedence() == prec::Assignment &&
Daniel Jasper59036852013-08-12 12:16:34 +0000688 !Line.First->isOneOf(tok::kw_template, tok::kw_using) &&
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000689 (!Current.Previous || Current.Previous->isNot(tok::kw_operator))) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000690 Contexts.back().IsExpression = true;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000691 for (FormatToken *Previous = Current.Previous;
Daniel Jasper5ca9b712013-09-11 20:37:10 +0000692 Previous && !Previous->isOneOf(tok::comma, tok::semi);
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000693 Previous = Previous->Previous) {
Daniel Jasper942d9712014-04-28 09:19:28 +0000694 if (Previous->isOneOf(tok::r_square, tok::r_paren))
Daniel Jasper8e559272013-02-27 11:43:50 +0000695 Previous = Previous->MatchingParen;
Daniel Jasper8184d662014-07-28 12:24:21 +0000696 if ((Previous->Type == TT_BinaryOperator ||
697 Previous->Type == TT_UnaryOperator) &&
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000698 Previous->isOneOf(tok::star, tok::amp)) {
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000699 Previous->Type = TT_PointerOrReference;
700 }
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000701 }
Daniel Jasper3682fcd2013-12-16 08:36:18 +0000702 } else if (Current.isOneOf(tok::kw_return, tok::kw_throw)) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000703 Contexts.back().IsExpression = true;
Daniel Jasper3682fcd2013-12-16 08:36:18 +0000704 } else if (Current.is(tok::l_paren) && !Line.MustBeDeclaration &&
Dinesh Dwivedi2e92e662014-05-06 11:46:49 +0000705 !Line.InPPDirective &&
706 (!Current.Previous ||
707 Current.Previous->isNot(tok::kw_decltype))) {
Daniel Jasper3682fcd2013-12-16 08:36:18 +0000708 bool ParametersOfFunctionType =
709 Current.Previous && Current.Previous->is(tok::r_paren) &&
710 Current.Previous->MatchingParen &&
711 Current.Previous->MatchingParen->Type == TT_FunctionTypeLParen;
712 bool IsForOrCatch = Current.Previous &&
713 Current.Previous->isOneOf(tok::kw_for, tok::kw_catch);
714 Contexts.back().IsExpression = !ParametersOfFunctionType && !IsForOrCatch;
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000715 } else if (Current.isOneOf(tok::r_paren, tok::greater, tok::comma)) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000716 for (FormatToken *Previous = Current.Previous;
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000717 Previous && Previous->isOneOf(tok::star, tok::amp);
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000718 Previous = Previous->Previous)
Nico Weber44449172013-02-12 16:17:07 +0000719 Previous->Type = TT_PointerOrReference;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000720 } else if (Current.Previous &&
721 Current.Previous->Type == TT_CtorInitializerColon) {
Daniel Jasper5065bc42013-02-18 12:44:35 +0000722 Contexts.back().IsExpression = true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +0000723 Contexts.back().InCtorInitializer = true;
Daniel Jasper97b89482013-03-13 07:49:51 +0000724 } else if (Current.is(tok::kw_new)) {
725 Contexts.back().CanBeExpression = false;
Daniel Jaspera98da3d2013-11-07 19:56:07 +0000726 } else if (Current.is(tok::semi) || Current.is(tok::exclaim)) {
Daniel Jasperc37de302013-05-03 14:41:24 +0000727 // This should be the condition or increment in a for-loop.
728 Contexts.back().IsExpression = true;
Nico Weber44449172013-02-12 16:17:07 +0000729 }
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000730
731 if (Current.Type == TT_Unknown) {
Daniel Jasperf3167902013-09-27 08:29:16 +0000732 // Line.MightBeFunctionDecl can only be true after the parentheses of a
733 // function declaration have been found. In this case, 'Current' is a
734 // trailing token of this declaration and thus cannot be a name.
735 if (isStartOfName(Current) && !Line.MightBeFunctionDecl) {
Daniel Jaspera628c982013-04-03 13:36:17 +0000736 Contexts.back().FirstStartOfName = &Current;
Daniel Jasper26d1b1d2013-02-24 18:54:32 +0000737 Current.Type = TT_StartOfName;
Daniel Jasper6cdec7c2013-07-09 14:36:48 +0000738 } else if (Current.is(tok::kw_auto)) {
739 AutoFound = true;
Daniel Jaspera3501d42013-07-11 14:33:06 +0000740 } else if (Current.is(tok::arrow) && AutoFound &&
741 Line.MustBeDeclaration) {
Daniel Jasper6cdec7c2013-07-09 14:36:48 +0000742 Current.Type = TT_TrailingReturnArrow;
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000743 } else if (Current.isOneOf(tok::star, tok::amp, tok::ampamp)) {
Daniel Jasperc697ad22013-02-06 10:05:46 +0000744 Current.Type =
Daniel Jasper6f9c8d22013-07-05 13:30:40 +0000745 determineStarAmpUsage(Current, Contexts.back().CanBeExpression &&
Manuel Klimekf81e5c02014-03-27 11:17:36 +0000746 Contexts.back().IsExpression,
747 Contexts.back().InTemplateArgument);
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000748 } else if (Current.isOneOf(tok::minus, tok::plus, tok::caret)) {
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000749 Current.Type = determinePlusMinusCaretUsage(Current);
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000750 if (Current.Type == TT_UnaryOperator && Current.is(tok::caret))
Daniel Jasperb77105d2014-04-08 14:04:31 +0000751 Contexts.back().CaretFound = true;
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000752 } else if (Current.isOneOf(tok::minusminus, tok::plusplus)) {
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000753 Current.Type = determineIncrementUsage(Current);
Daniel Jasper2ac3fdf2014-07-28 12:08:16 +0000754 } else if (Current.isOneOf(tok::exclaim, tok::tilde)) {
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000755 Current.Type = TT_UnaryOperator;
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000756 } else if (Current.is(tok::question)) {
757 Current.Type = TT_ConditionalExpr;
Manuel Klimekbab25fd2013-09-04 08:20:47 +0000758 } else if (Current.isBinaryOperator() &&
759 (!Current.Previous ||
760 Current.Previous->isNot(tok::l_square))) {
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000761 Current.Type = TT_BinaryOperator;
762 } else if (Current.is(tok::comment)) {
Alexander Kornienkoffcc0102013-06-05 14:09:10 +0000763 if (Current.TokenText.startswith("//"))
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000764 Current.Type = TT_LineComment;
765 else
766 Current.Type = TT_BlockComment;
Nico Weberc6fe2162013-02-13 04:13:13 +0000767 } else if (Current.is(tok::r_paren)) {
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +0000768 if (rParenEndsCast(Current))
Nico Weberc6fe2162013-02-13 04:13:13 +0000769 Current.Type = TT_CastRParen;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000770 } else if (Current.is(tok::at) && Current.Next) {
771 switch (Current.Next->Tok.getObjCKeywordID()) {
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000772 case tok::objc_interface:
773 case tok::objc_implementation:
774 case tok::objc_protocol:
775 Current.Type = TT_ObjCDecl;
776 break;
777 case tok::objc_property:
778 Current.Type = TT_ObjCProperty;
779 break;
780 default:
781 break;
782 }
Daniel Jasperbca4bbe2013-05-28 11:30:49 +0000783 } else if (Current.is(tok::period)) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000784 FormatToken *PreviousNoComment = Current.getPreviousNonComment();
Daniel Jasperbca4bbe2013-05-28 11:30:49 +0000785 if (PreviousNoComment &&
786 PreviousNoComment->isOneOf(tok::comma, tok::l_brace))
787 Current.Type = TT_DesignatedInitializerPeriod;
Daniel Jasper43e6a282013-12-16 15:01:54 +0000788 } else if (Current.isOneOf(tok::identifier, tok::kw_const) &&
Daniel Jasper35ec2b22014-04-14 08:15:20 +0000789 Current.Previous && Current.Previous->isNot(tok::equal) &&
Daniel Jasper43e6a282013-12-16 15:01:54 +0000790 Line.MightBeFunctionDecl && Contexts.size() == 1) {
791 // Line.MightBeFunctionDecl can only be true after the parentheses of a
792 // function declaration have been found.
793 Current.Type = TT_TrailingAnnotation;
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000794 }
795 }
796 }
797
Daniel Jasperdba1c552013-07-02 09:47:29 +0000798 /// \brief Take a guess at whether \p Tok starts a name of a function or
799 /// variable declaration.
800 ///
801 /// This is a heuristic based on whether \p Tok is an identifier following
802 /// something that is likely a type.
803 bool isStartOfName(const FormatToken &Tok) {
Craig Topper2145bc02014-05-09 08:15:10 +0000804 if (Tok.isNot(tok::identifier) || !Tok.Previous)
Daniel Jasperdba1c552013-07-02 09:47:29 +0000805 return false;
806
807 // Skip "const" as it does not have an influence on whether this is a name.
808 FormatToken *PreviousNotConst = Tok.Previous;
Craig Topper2145bc02014-05-09 08:15:10 +0000809 while (PreviousNotConst && PreviousNotConst->is(tok::kw_const))
Daniel Jasperdba1c552013-07-02 09:47:29 +0000810 PreviousNotConst = PreviousNotConst->Previous;
811
Craig Topper2145bc02014-05-09 08:15:10 +0000812 if (!PreviousNotConst)
Daniel Jasperdba1c552013-07-02 09:47:29 +0000813 return false;
814
Daniel Jasper3ac9b9e2013-07-08 14:34:09 +0000815 bool IsPPKeyword = PreviousNotConst->is(tok::identifier) &&
816 PreviousNotConst->Previous &&
817 PreviousNotConst->Previous->is(tok::hash);
Daniel Jasperdba1c552013-07-02 09:47:29 +0000818
Daniel Jasper53643062013-08-19 10:16:18 +0000819 if (PreviousNotConst->Type == TT_TemplateCloser)
820 return PreviousNotConst && PreviousNotConst->MatchingParen &&
821 PreviousNotConst->MatchingParen->Previous &&
822 PreviousNotConst->MatchingParen->Previous->isNot(tok::kw_template);
823
Daniel Jasperf10a28d2014-05-05 13:48:09 +0000824 if (PreviousNotConst->is(tok::r_paren) && PreviousNotConst->MatchingParen &&
825 PreviousNotConst->MatchingParen->Previous &&
826 PreviousNotConst->MatchingParen->Previous->is(tok::kw_decltype))
827 return true;
828
Daniel Jasperdba1c552013-07-02 09:47:29 +0000829 return (!IsPPKeyword && PreviousNotConst->is(tok::identifier)) ||
830 PreviousNotConst->Type == TT_PointerOrReference ||
Daniel Jaspercb51cf42014-01-16 09:11:55 +0000831 PreviousNotConst->isSimpleTypeSpecifier();
Daniel Jasperdba1c552013-07-02 09:47:29 +0000832 }
833
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +0000834 /// \brief Determine whether ')' is ending a cast.
835 bool rParenEndsCast(const FormatToken &Tok) {
Craig Topper4b566922014-06-09 02:04:02 +0000836 FormatToken *LeftOfParens = nullptr;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +0000837 if (Tok.MatchingParen)
838 LeftOfParens = Tok.MatchingParen->getPreviousNonComment();
Daniel Jasper30646202014-07-14 12:38:38 +0000839 if (LeftOfParens && LeftOfParens->is(tok::r_paren))
840 return false;
Daniel Jasper8b76d602014-07-28 12:08:06 +0000841 if (LeftOfParens && LeftOfParens->is(tok::r_square) &&
842 LeftOfParens->MatchingParen &&
843 LeftOfParens->MatchingParen->Type == TT_LambdaLSquare)
844 return false;
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +0000845 bool IsCast = false;
846 bool ParensAreEmpty = Tok.Previous == Tok.MatchingParen;
847 bool ParensAreType = !Tok.Previous ||
848 Tok.Previous->Type == TT_PointerOrReference ||
849 Tok.Previous->Type == TT_TemplateCloser ||
850 Tok.Previous->isSimpleTypeSpecifier();
851 bool ParensCouldEndDecl =
852 Tok.Next && Tok.Next->isOneOf(tok::equal, tok::semi, tok::l_brace);
853 bool IsSizeOfOrAlignOf =
854 LeftOfParens && LeftOfParens->isOneOf(tok::kw_sizeof, tok::kw_alignof);
855 if (ParensAreType && !ParensCouldEndDecl && !IsSizeOfOrAlignOf &&
856 ((Contexts.size() > 1 && Contexts[Contexts.size() - 2].IsExpression) ||
857 (Tok.Next && Tok.Next->isBinaryOperator())))
858 IsCast = true;
859 else if (Tok.Next && Tok.Next->isNot(tok::string_literal) &&
860 (Tok.Next->Tok.isLiteral() ||
861 Tok.Next->isOneOf(tok::kw_sizeof, tok::kw_alignof)))
862 IsCast = true;
863 // If there is an identifier after the (), it is likely a cast, unless
864 // there is also an identifier before the ().
Craig Topper4b566922014-06-09 02:04:02 +0000865 else if (LeftOfParens &&
866 (LeftOfParens->Tok.getIdentifierInfo() == nullptr ||
867 LeftOfParens->is(tok::kw_return)) &&
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +0000868 LeftOfParens->Type != TT_OverloadedOperator &&
869 LeftOfParens->isNot(tok::at) &&
870 LeftOfParens->Type != TT_TemplateCloser && Tok.Next) {
871 if (Tok.Next->isOneOf(tok::identifier, tok::numeric_constant)) {
872 IsCast = true;
873 } else {
874 // Use heuristics to recognize c style casting.
875 FormatToken *Prev = Tok.Previous;
876 if (Prev && Prev->isOneOf(tok::amp, tok::star))
877 Prev = Prev->Previous;
878
879 if (Prev && Tok.Next && Tok.Next->Next) {
880 bool NextIsUnary = Tok.Next->isUnaryOperator() ||
881 Tok.Next->isOneOf(tok::amp, tok::star);
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000882 IsCast = NextIsUnary && Tok.Next->Next->isOneOf(
883 tok::identifier, tok::numeric_constant);
Dinesh Dwivedi13b9b7e2014-05-06 09:08:34 +0000884 }
885
886 for (; Prev != Tok.MatchingParen; Prev = Prev->Previous) {
887 if (!Prev || !Prev->isOneOf(tok::kw_const, tok::identifier)) {
888 IsCast = false;
889 break;
890 }
891 }
892 }
893 }
894 return IsCast && !ParensAreEmpty;
895 }
896
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000897 /// \brief Return the type of the given token assuming it is * or &.
Manuel Klimekf81e5c02014-03-27 11:17:36 +0000898 TokenType determineStarAmpUsage(const FormatToken &Tok, bool IsExpression,
899 bool InTemplateArgument) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000900 const FormatToken *PrevToken = Tok.getPreviousNonComment();
Craig Topper2145bc02014-05-09 08:15:10 +0000901 if (!PrevToken)
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000902 return TT_UnaryOperator;
903
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000904 const FormatToken *NextToken = Tok.getNextNonComment();
Daniel Jasper2520fe92014-06-30 13:54:27 +0000905 if (!NextToken || NextToken->is(tok::l_brace))
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000906 return TT_Unknown;
907
Daniel Jasper37194282013-05-28 08:33:00 +0000908 if (PrevToken->is(tok::coloncolon) ||
909 (PrevToken->is(tok::l_paren) && !IsExpression))
Daniel Jasper8eb371b2013-03-01 17:13:29 +0000910 return TT_PointerOrReference;
911
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000912 if (PrevToken->isOneOf(tok::l_paren, tok::l_square, tok::l_brace,
Daniel Jasperae907642013-03-14 10:50:25 +0000913 tok::comma, tok::semi, tok::kw_return, tok::colon,
Daniel Jasperdf620b22013-09-21 17:31:51 +0000914 tok::equal, tok::kw_delete, tok::kw_sizeof) ||
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000915 PrevToken->Type == TT_BinaryOperator ||
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000916 PrevToken->Type == TT_ConditionalExpr ||
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000917 PrevToken->Type == TT_UnaryOperator || PrevToken->Type == TT_CastRParen)
918 return TT_UnaryOperator;
919
Daniel Jasperea2d0422014-05-08 08:50:10 +0000920 if (NextToken->is(tok::l_square) && NextToken->Type != TT_LambdaLSquare)
Nico Weber5d2624e2013-02-06 06:20:11 +0000921 return TT_PointerOrReference;
Daniel Jasper6ba16382014-07-28 13:19:58 +0000922 if (NextToken->isOneOf(tok::kw_operator, tok::comma))
Daniel Jasper32ccb032014-06-23 07:36:18 +0000923 return TT_PointerOrReference;
Nico Weber5d2624e2013-02-06 06:20:11 +0000924
Daniel Jasper71665cd2013-09-10 10:26:38 +0000925 if (PrevToken->is(tok::r_paren) && PrevToken->MatchingParen &&
926 PrevToken->MatchingParen->Previous &&
Daniel Jasper4ac7de72014-06-11 07:35:16 +0000927 PrevToken->MatchingParen->Previous->isOneOf(tok::kw_typeof,
928 tok::kw_decltype))
Daniel Jasper71665cd2013-09-10 10:26:38 +0000929 return TT_PointerOrReference;
930
Manuel Klimek94815562014-03-28 09:27:09 +0000931 if (PrevToken->Tok.isLiteral() ||
932 PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::kw_true,
933 tok::kw_false) ||
934 NextToken->Tok.isLiteral() ||
935 NextToken->isOneOf(tok::kw_true, tok::kw_false) ||
936 NextToken->isUnaryOperator() ||
Manuel Klimekf81e5c02014-03-27 11:17:36 +0000937 // If we know we're in a template argument, there are no named
938 // declarations. Thus, having an identifier on the right-hand side
939 // indicates a binary operator.
940 (InTemplateArgument && NextToken->Tok.isAnyIdentifier()))
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000941 return TT_BinaryOperator;
942
Daniel Jasper7d028292014-06-02 11:54:20 +0000943 // This catches some cases where evaluation order is used as control flow:
944 // aaa && aaa->f();
945 const FormatToken *NextNextToken = NextToken->getNextNonComment();
946 if (NextNextToken && NextNextToken->is(tok::arrow))
947 return TT_BinaryOperator;
948
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000949 // It is very unlikely that we are going to find a pointer or reference type
950 // definition on the RHS of an assignment.
951 if (IsExpression)
952 return TT_BinaryOperator;
953
954 return TT_PointerOrReference;
955 }
956
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000957 TokenType determinePlusMinusCaretUsage(const FormatToken &Tok) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000958 const FormatToken *PrevToken = Tok.getPreviousNonComment();
Craig Topper2145bc02014-05-09 08:15:10 +0000959 if (!PrevToken || PrevToken->Type == TT_CastRParen)
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000960 return TT_UnaryOperator;
961
962 // Use heuristics to recognize unary operators.
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000963 if (PrevToken->isOneOf(tok::equal, tok::l_paren, tok::comma, tok::l_square,
964 tok::question, tok::colon, tok::kw_return,
965 tok::kw_case, tok::at, tok::l_brace))
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000966 return TT_UnaryOperator;
967
Nico Weberb76de882013-02-05 16:21:00 +0000968 // There can't be two consecutive binary operators.
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000969 if (PrevToken->Type == TT_BinaryOperator)
970 return TT_UnaryOperator;
971
972 // Fall back to marking the token as binary operator.
973 return TT_BinaryOperator;
974 }
975
976 /// \brief Determine whether ++/-- are pre- or post-increments/-decrements.
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000977 TokenType determineIncrementUsage(const FormatToken &Tok) {
Alexander Kornienko1efe0a02013-07-04 14:47:51 +0000978 const FormatToken *PrevToken = Tok.getPreviousNonComment();
Craig Topper2145bc02014-05-09 08:15:10 +0000979 if (!PrevToken || PrevToken->Type == TT_CastRParen)
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000980 return TT_UnaryOperator;
Alexander Kornienko62b85b92013-03-13 14:41:29 +0000981 if (PrevToken->isOneOf(tok::r_paren, tok::r_square, tok::identifier))
Daniel Jasper3a9370c2013-02-04 07:21:18 +0000982 return TT_TrailingUnaryOperator;
983
984 return TT_UnaryOperator;
985 }
Daniel Jasperc697ad22013-02-06 10:05:46 +0000986
987 SmallVector<Context, 8> Contexts;
988
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000989 const FormatStyle &Style;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000990 AnnotatedLine &Line;
Manuel Klimek6e6310e2013-05-29 14:47:47 +0000991 FormatToken *CurrentToken;
Daniel Jasperc697ad22013-02-06 10:05:46 +0000992 bool KeywordVirtualFound;
Daniel Jasper6cdec7c2013-07-09 14:36:48 +0000993 bool AutoFound;
Nico Weber29f9dea2013-02-11 15:32:15 +0000994 IdentifierInfo &Ident_in;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +0000995};
996
Daniel Jasperb27c4b72013-08-27 11:09:05 +0000997static int PrecedenceUnaryOperator = prec::PointerToMember + 1;
998static int PrecedenceArrowAndPeriod = prec::PointerToMember + 2;
999
Daniel Jasper400adc62013-02-08 15:28:42 +00001000/// \brief Parses binary expressions by inserting fake parenthesis based on
1001/// operator precedence.
1002class ExpressionParser {
1003public:
Daniel Jasper6dcecb62013-06-06 09:11:58 +00001004 ExpressionParser(AnnotatedLine &Line) : Current(Line.First) {
1005 // Skip leading "}", e.g. in "} else if (...) {".
1006 if (Current->is(tok::r_brace))
1007 next();
1008 }
Daniel Jasper400adc62013-02-08 15:28:42 +00001009
1010 /// \brief Parse expressions with the given operatore precedence.
Daniel Jaspercd8599e2013-02-23 21:01:55 +00001011 void parse(int Precedence = 0) {
Daniel Jasperf48b5ab2013-11-07 19:23:49 +00001012 // Skip 'return' and ObjC selector colons as they are not part of a binary
1013 // expression.
1014 while (Current &&
1015 (Current->is(tok::kw_return) ||
Daniel Jasper17062ff2014-06-10 14:44:02 +00001016 (Current->is(tok::colon) && (Current->Type == TT_ObjCMethodExpr ||
1017 Current->Type == TT_DictLiteral))))
Daniel Jaspereabede62013-09-30 08:29:03 +00001018 next();
1019
Craig Topper2145bc02014-05-09 08:15:10 +00001020 if (!Current || Precedence > PrecedenceArrowAndPeriod)
Daniel Jasper0649d362013-08-23 15:14:03 +00001021 return;
1022
Daniel Jasper2c611c02013-05-31 14:56:12 +00001023 // Conditional expressions need to be parsed separately for proper nesting.
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001024 if (Precedence == prec::Conditional) {
Daniel Jasper2c611c02013-05-31 14:56:12 +00001025 parseConditionalExpr();
1026 return;
1027 }
Daniel Jasper0649d362013-08-23 15:14:03 +00001028
1029 // Parse unary operators, which all have a higher precedence than binary
1030 // operators.
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001031 if (Precedence == PrecedenceUnaryOperator) {
Daniel Jasper0649d362013-08-23 15:14:03 +00001032 parseUnaryOperator();
Daniel Jasper400adc62013-02-08 15:28:42 +00001033 return;
Daniel Jasper0649d362013-08-23 15:14:03 +00001034 }
Daniel Jasper400adc62013-02-08 15:28:42 +00001035
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001036 FormatToken *Start = Current;
Craig Topper2145bc02014-05-09 08:15:10 +00001037 FormatToken *LatestOperator = nullptr;
Daniel Jasper0e617842014-04-16 12:26:54 +00001038 unsigned OperatorIndex = 0;
Daniel Jasper400adc62013-02-08 15:28:42 +00001039
Daniel Jaspercd8599e2013-02-23 21:01:55 +00001040 while (Current) {
Daniel Jasper400adc62013-02-08 15:28:42 +00001041 // Consume operators with higher precedence.
Daniel Jasper6bee6822013-04-08 20:33:42 +00001042 parse(Precedence + 1);
Daniel Jasper400adc62013-02-08 15:28:42 +00001043
Daniel Jasper0649d362013-08-23 15:14:03 +00001044 int CurrentPrecedence = getCurrentPrecedence();
1045
Daniel Jasper17062ff2014-06-10 14:44:02 +00001046 if (Current && Current->Type == TT_SelectorName &&
Daniel Jasperb88b25f2013-12-23 07:29:06 +00001047 Precedence == CurrentPrecedence) {
1048 if (LatestOperator)
1049 addFakeParenthesis(Start, prec::Level(Precedence));
Daniel Jasper0649d362013-08-23 15:14:03 +00001050 Start = Current;
Daniel Jasperb88b25f2013-12-23 07:29:06 +00001051 }
Daniel Jaspercd8599e2013-02-23 21:01:55 +00001052
Daniel Jasper400adc62013-02-08 15:28:42 +00001053 // At the end of the line or when an operator with higher precedence is
1054 // found, insert fake parenthesis and return.
Craig Topper2145bc02014-05-09 08:15:10 +00001055 if (!Current || Current->closesScope() ||
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001056 (CurrentPrecedence != -1 && CurrentPrecedence < Precedence)) {
1057 if (LatestOperator) {
Daniel Jasper0e617842014-04-16 12:26:54 +00001058 LatestOperator->LastOperator = true;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001059 if (Precedence == PrecedenceArrowAndPeriod) {
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001060 // Call expressions don't have a binary operator precedence.
1061 addFakeParenthesis(Start, prec::Unknown);
1062 } else {
1063 addFakeParenthesis(Start, prec::Level(Precedence));
1064 }
1065 }
Daniel Jasper400adc62013-02-08 15:28:42 +00001066 return;
1067 }
1068
1069 // Consume scopes: (), [], <> and {}
Daniel Jasperc04baae2013-04-10 09:49:49 +00001070 if (Current->opensScope()) {
1071 while (Current && !Current->closesScope()) {
Daniel Jasper400adc62013-02-08 15:28:42 +00001072 next();
1073 parse();
1074 }
1075 next();
1076 } else {
1077 // Operator found.
Daniel Jasper0e617842014-04-16 12:26:54 +00001078 if (CurrentPrecedence == Precedence) {
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001079 LatestOperator = Current;
Daniel Jasper0e617842014-04-16 12:26:54 +00001080 Current->OperatorIndex = OperatorIndex;
1081 ++OperatorIndex;
1082 }
Daniel Jasper400adc62013-02-08 15:28:42 +00001083
1084 next();
1085 }
1086 }
1087 }
1088
1089private:
Daniel Jasper0649d362013-08-23 15:14:03 +00001090 /// \brief Gets the precedence (+1) of the given token for binary operators
1091 /// and other tokens that we treat like binary operators.
1092 int getCurrentPrecedence() {
1093 if (Current) {
1094 if (Current->Type == TT_ConditionalExpr)
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001095 return prec::Conditional;
Daniel Jasperf48b5ab2013-11-07 19:23:49 +00001096 else if (Current->is(tok::semi) || Current->Type == TT_InlineASMColon ||
Daniel Jasper17062ff2014-06-10 14:44:02 +00001097 Current->Type == TT_SelectorName)
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001098 return 0;
Daniel Jasper9cc3e972014-02-07 10:09:46 +00001099 else if (Current->Type == TT_RangeBasedForLoopColon)
1100 return prec::Comma;
Daniel Jasper0649d362013-08-23 15:14:03 +00001101 else if (Current->Type == TT_BinaryOperator || Current->is(tok::comma))
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001102 return Current->getPrecedence();
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001103 else if (Current->isOneOf(tok::period, tok::arrow))
1104 return PrecedenceArrowAndPeriod;
Daniel Jasper0649d362013-08-23 15:14:03 +00001105 }
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001106 return -1;
Daniel Jasper0649d362013-08-23 15:14:03 +00001107 }
1108
Daniel Jasper2c611c02013-05-31 14:56:12 +00001109 void addFakeParenthesis(FormatToken *Start, prec::Level Precedence) {
1110 Start->FakeLParens.push_back(Precedence);
Daniel Jasper562ecd42013-09-06 08:08:14 +00001111 if (Precedence > prec::Unknown)
1112 Start->StartsBinaryExpression = true;
1113 if (Current) {
Daniel Jasper2c611c02013-05-31 14:56:12 +00001114 ++Current->Previous->FakeRParens;
Daniel Jasper562ecd42013-09-06 08:08:14 +00001115 if (Precedence > prec::Unknown)
1116 Current->Previous->EndsBinaryExpression = true;
1117 }
Daniel Jasper2c611c02013-05-31 14:56:12 +00001118 }
1119
Daniel Jasper0649d362013-08-23 15:14:03 +00001120 /// \brief Parse unary operator expressions and surround them with fake
1121 /// parentheses if appropriate.
1122 void parseUnaryOperator() {
Craig Topper2145bc02014-05-09 08:15:10 +00001123 if (!Current || Current->Type != TT_UnaryOperator) {
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001124 parse(PrecedenceArrowAndPeriod);
Daniel Jasper0649d362013-08-23 15:14:03 +00001125 return;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001126 }
Daniel Jasper0649d362013-08-23 15:14:03 +00001127
1128 FormatToken *Start = Current;
1129 next();
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001130 parseUnaryOperator();
Daniel Jasper0649d362013-08-23 15:14:03 +00001131
Daniel Jasper0649d362013-08-23 15:14:03 +00001132 // The actual precedence doesn't matter.
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001133 addFakeParenthesis(Start, prec::Unknown);
Daniel Jasper0649d362013-08-23 15:14:03 +00001134 }
1135
Daniel Jasper2c611c02013-05-31 14:56:12 +00001136 void parseConditionalExpr() {
1137 FormatToken *Start = Current;
Daniel Jasperb27c4b72013-08-27 11:09:05 +00001138 parse(prec::LogicalOr);
Daniel Jasper2c611c02013-05-31 14:56:12 +00001139 if (!Current || !Current->is(tok::question))
1140 return;
1141 next();
Daniel Jasperfc3861a2014-07-17 12:22:04 +00001142 parseConditionalExpr();
Daniel Jasper2c611c02013-05-31 14:56:12 +00001143 if (!Current || Current->Type != TT_ConditionalExpr)
1144 return;
1145 next();
1146 parseConditionalExpr();
1147 addFakeParenthesis(Start, prec::Conditional);
1148 }
1149
Daniel Jasper400adc62013-02-08 15:28:42 +00001150 void next() {
Alexander Kornienkoafaa8f52013-06-17 13:19:53 +00001151 if (Current)
1152 Current = Current->Next;
1153 while (Current && Current->isTrailingComment())
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001154 Current = Current->Next;
Daniel Jasper400adc62013-02-08 15:28:42 +00001155 }
1156
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001157 FormatToken *Current;
Daniel Jasper400adc62013-02-08 15:28:42 +00001158};
1159
Craig Topper318ed7c2013-07-01 04:03:19 +00001160} // end anonymous namespace
1161
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001162void
1163TokenAnnotator::setCommentLineLevels(SmallVectorImpl<AnnotatedLine *> &Lines) {
Craig Topper2145bc02014-05-09 08:15:10 +00001164 const AnnotatedLine *NextNonCommentLine = nullptr;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001165 for (SmallVectorImpl<AnnotatedLine *>::reverse_iterator I = Lines.rbegin(),
1166 E = Lines.rend();
1167 I != E; ++I) {
1168 if (NextNonCommentLine && (*I)->First->is(tok::comment) &&
Craig Topper2145bc02014-05-09 08:15:10 +00001169 (*I)->First->Next == nullptr)
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001170 (*I)->Level = NextNonCommentLine->Level;
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001171 else
Craig Topper2145bc02014-05-09 08:15:10 +00001172 NextNonCommentLine = (*I)->First->isNot(tok::r_brace) ? (*I) : nullptr;
Daniel Jasperbbf5c1c2013-11-05 19:10:03 +00001173
1174 setCommentLineLevels((*I)->Children);
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001175 }
1176}
1177
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001178void TokenAnnotator::annotate(AnnotatedLine &Line) {
Daniel Jasper1c5d9df2013-09-06 07:54:20 +00001179 for (SmallVectorImpl<AnnotatedLine *>::iterator I = Line.Children.begin(),
1180 E = Line.Children.end();
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001181 I != E; ++I) {
1182 annotate(**I);
1183 }
Daniel Jasper8de9ed02013-08-22 15:00:41 +00001184 AnnotatingParser Parser(Style, Line, Ident_in);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001185 Line.Type = Parser.parseLine();
1186 if (Line.Type == LT_Invalid)
1187 return;
1188
Daniel Jasper400adc62013-02-08 15:28:42 +00001189 ExpressionParser ExprParser(Line);
1190 ExprParser.parse();
1191
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001192 if (Line.First->Type == TT_ObjCMethodSpecifier)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001193 Line.Type = LT_ObjCMethodDecl;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001194 else if (Line.First->Type == TT_ObjCDecl)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001195 Line.Type = LT_ObjCDecl;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001196 else if (Line.First->Type == TT_ObjCProperty)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001197 Line.Type = LT_ObjCProperty;
1198
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001199 Line.First->SpacesRequiredBefore = 1;
1200 Line.First->CanBreakBefore = Line.First->MustBreakBefore;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001201}
1202
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001203// This function heuristically determines whether 'Current' starts the name of a
1204// function declaration.
1205static bool isFunctionDeclarationName(const FormatToken &Current) {
1206 if (Current.Type != TT_StartOfName ||
1207 Current.NestingLevel != 0 ||
1208 Current.Previous->Type == TT_StartOfName)
1209 return false;
1210 const FormatToken *Next = Current.Next;
1211 for (; Next; Next = Next->Next) {
1212 if (Next->Type == TT_TemplateOpener) {
1213 Next = Next->MatchingParen;
1214 } else if (Next->is(tok::coloncolon)) {
1215 Next = Next->Next;
1216 if (!Next || !Next->is(tok::identifier))
1217 return false;
1218 } else if (Next->is(tok::l_paren)) {
1219 break;
1220 } else {
1221 return false;
1222 }
1223 }
1224 if (!Next)
1225 return false;
1226 assert(Next->is(tok::l_paren));
1227 if (Next->Next == Next->MatchingParen)
1228 return true;
1229 for (const FormatToken *Tok = Next->Next; Tok != Next->MatchingParen;
1230 Tok = Tok->Next) {
1231 if (Tok->is(tok::kw_const) || Tok->isSimpleTypeSpecifier() ||
1232 Tok->Type == TT_PointerOrReference || Tok->Type == TT_StartOfName)
1233 return true;
1234 if (Tok->isOneOf(tok::l_brace, tok::string_literal) || Tok->Tok.isLiteral())
1235 return false;
1236 }
1237 return false;
1238}
1239
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001240void TokenAnnotator::calculateFormattingInformation(AnnotatedLine &Line) {
Daniel Jasper5f3ea472014-05-22 08:36:53 +00001241 for (SmallVectorImpl<AnnotatedLine *>::iterator I = Line.Children.begin(),
1242 E = Line.Children.end();
1243 I != E; ++I) {
1244 calculateFormattingInformation(**I);
1245 }
1246
Alexander Kornienko39856b72013-09-10 09:38:25 +00001247 Line.First->TotalLength =
1248 Line.First->IsMultiline ? Style.ColumnLimit : Line.First->ColumnWidth;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001249 if (!Line.First->Next)
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001250 return;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001251 FormatToken *Current = Line.First->Next;
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001252 bool InFunctionDecl = Line.MightBeFunctionDecl;
Craig Topper2145bc02014-05-09 08:15:10 +00001253 while (Current) {
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001254 if (isFunctionDeclarationName(*Current))
1255 Current->Type = TT_FunctionDeclarationName;
Daniel Jasper5a611392013-12-19 21:41:37 +00001256 if (Current->Type == TT_LineComment) {
Daniel Jasper84a12e12014-03-10 15:06:25 +00001257 if (Current->Previous->BlockKind == BK_BracedInit &&
1258 Current->Previous->opensScope())
Daniel Jasper5a611392013-12-19 21:41:37 +00001259 Current->SpacesRequiredBefore = Style.Cpp11BracedListStyle ? 0 : 1;
1260 else
1261 Current->SpacesRequiredBefore = Style.SpacesBeforeTrailingComments;
Daniel Jasper14e58e52014-03-21 11:58:45 +00001262
1263 // If we find a trailing comment, iterate backwards to determine whether
1264 // it seems to relate to a specific parameter. If so, break before that
1265 // parameter to avoid changing the comment's meaning. E.g. don't move 'b'
1266 // to the previous line in:
1267 // SomeFunction(a,
1268 // b, // comment
1269 // c);
Daniel Jasper28df0a32014-03-21 12:15:40 +00001270 if (!Current->HasUnescapedNewline) {
Daniel Jasper14e58e52014-03-21 11:58:45 +00001271 for (FormatToken *Parameter = Current->Previous; Parameter;
1272 Parameter = Parameter->Previous) {
1273 if (Parameter->isOneOf(tok::comment, tok::r_brace))
1274 break;
1275 if (Parameter->Previous && Parameter->Previous->is(tok::comma)) {
1276 if (Parameter->Previous->Type != TT_CtorInitializerComma &&
1277 Parameter->HasUnescapedNewline)
1278 Parameter->MustBreakBefore = true;
1279 break;
1280 }
1281 }
1282 }
Daniel Jasperb88b25f2013-12-23 07:29:06 +00001283 } else if (Current->SpacesRequiredBefore == 0 &&
Daniel Jasper166c19b2014-05-06 14:12:21 +00001284 spaceRequiredBefore(Line, *Current)) {
Alexander Kornienko384b40b2013-10-11 21:43:05 +00001285 Current->SpacesRequiredBefore = 1;
Daniel Jasper5a611392013-12-19 21:41:37 +00001286 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001287
Daniel Jasperfb81b092013-09-17 09:52:48 +00001288 Current->MustBreakBefore =
1289 Current->MustBreakBefore || mustBreakBefore(Line, *Current);
1290
Daniel Jasperca4ea1c2014-08-05 12:16:31 +00001291 if (Style.AlwaysBreakAfterDefinitionReturnType &&
1292 InFunctionDecl && Current->Type == TT_FunctionDeclarationName &&
1293 Line.Last->is(tok::l_brace)) // Only for definitions.
1294 Current->MustBreakBefore = true;
1295
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001296 Current->CanBreakBefore =
1297 Current->MustBreakBefore || canBreakBefore(Line, *Current);
Daniel Jasper5f3ea472014-05-22 08:36:53 +00001298 unsigned ChildSize = 0;
1299 if (Current->Previous->Children.size() == 1) {
1300 FormatToken &LastOfChild = *Current->Previous->Children[0]->Last;
1301 ChildSize = LastOfChild.isTrailingComment() ? Style.ColumnLimit
1302 : LastOfChild.TotalLength + 1;
1303 }
1304 if (Current->MustBreakBefore || Current->Previous->Children.size() > 1 ||
Alexander Kornienko39856b72013-09-10 09:38:25 +00001305 Current->IsMultiline)
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001306 Current->TotalLength = Current->Previous->TotalLength + Style.ColumnLimit;
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001307 else
Daniel Jasper3ac9b9e2013-07-08 14:34:09 +00001308 Current->TotalLength = Current->Previous->TotalLength +
Daniel Jasper5f3ea472014-05-22 08:36:53 +00001309 Current->ColumnWidth + ChildSize +
Daniel Jasper3ac9b9e2013-07-08 14:34:09 +00001310 Current->SpacesRequiredBefore;
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001311
1312 if (Current->Type == TT_CtorInitializerColon)
1313 InFunctionDecl = false;
1314
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001315 // FIXME: Only calculate this if CanBreakBefore is true once static
1316 // initializers etc. are sorted out.
1317 // FIXME: Move magic numbers to a better place.
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001318 Current->SplitPenalty = 20 * Current->BindingStrength +
1319 splitPenalty(Line, *Current, InFunctionDecl);
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001320
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001321 Current = Current->Next;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001322 }
Daniel Jasper6bee6822013-04-08 20:33:42 +00001323
Manuel Klimek4fe43002013-05-22 12:51:29 +00001324 calculateUnbreakableTailLengths(Line);
Craig Topper2145bc02014-05-09 08:15:10 +00001325 for (Current = Line.First; Current != nullptr; Current = Current->Next) {
Daniel Jasper8de9ed02013-08-22 15:00:41 +00001326 if (Current->Role)
1327 Current->Role->precomputeFormattingInfos(Current);
1328 }
1329
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001330 DEBUG({ printDebugInfo(Line); });
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001331}
1332
Manuel Klimek4fe43002013-05-22 12:51:29 +00001333void TokenAnnotator::calculateUnbreakableTailLengths(AnnotatedLine &Line) {
1334 unsigned UnbreakableTailLength = 0;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001335 FormatToken *Current = Line.Last;
Craig Topper2145bc02014-05-09 08:15:10 +00001336 while (Current) {
Manuel Klimek4fe43002013-05-22 12:51:29 +00001337 Current->UnbreakableTailLength = UnbreakableTailLength;
1338 if (Current->CanBreakBefore ||
1339 Current->isOneOf(tok::comment, tok::string_literal)) {
1340 UnbreakableTailLength = 0;
1341 } else {
1342 UnbreakableTailLength +=
Alexander Kornienko39856b72013-09-10 09:38:25 +00001343 Current->ColumnWidth + Current->SpacesRequiredBefore;
Manuel Klimek4fe43002013-05-22 12:51:29 +00001344 }
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001345 Current = Current->Previous;
Manuel Klimek4fe43002013-05-22 12:51:29 +00001346 }
1347}
1348
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001349unsigned TokenAnnotator::splitPenalty(const AnnotatedLine &Line,
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001350 const FormatToken &Tok,
1351 bool InFunctionDecl) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001352 const FormatToken &Left = *Tok.Previous;
1353 const FormatToken &Right = Tok;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001354
Daniel Jasperbca4bbe2013-05-28 11:30:49 +00001355 if (Left.is(tok::semi))
1356 return 0;
Daniel Jasper783bac62014-04-15 09:54:30 +00001357 if (Left.is(tok::comma) || (Right.is(tok::identifier) && Right.Next &&
1358 Right.Next->Type == TT_DictLiteral))
Daniel Jasperbca4bbe2013-05-28 11:30:49 +00001359 return 1;
Daniel Jasper7052ce62014-01-19 09:04:08 +00001360 if (Right.is(tok::l_square)) {
1361 if (Style.Language == FormatStyle::LK_Proto)
1362 return 1;
Daniel Jaspera2fb50f2014-06-24 09:15:49 +00001363 if (Right.Type != TT_ObjCMethodExpr && Right.Type != TT_LambdaLSquare)
Daniel Jasperecaba172014-06-10 13:27:57 +00001364 return 500;
Daniel Jasper7052ce62014-01-19 09:04:08 +00001365 }
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001366 if (Right.Type == TT_StartOfName ||
1367 Right.Type == TT_FunctionDeclarationName || Right.is(tok::kw_operator)) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001368 if (Line.First->is(tok::kw_for) && Right.PartOfMultiVariableDeclStmt)
Daniel Jasper26d1b1d2013-02-24 18:54:32 +00001369 return 3;
Daniel Jasper40db06a2013-07-11 12:34:23 +00001370 if (Left.Type == TT_StartOfName)
1371 return 20;
Daniel Jasper63af7c42013-12-09 14:40:19 +00001372 if (InFunctionDecl && Right.NestingLevel == 0)
Daniel Jasper26d1b1d2013-02-24 18:54:32 +00001373 return Style.PenaltyReturnTypeOnItsOwnLine;
Daniel Jasper53643062013-08-19 10:16:18 +00001374 return 200;
Daniel Jasper26d1b1d2013-02-24 18:54:32 +00001375 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001376 if (Left.is(tok::equal) && Right.is(tok::l_brace))
1377 return 150;
Daniel Jasper1bc1b502013-07-05 07:58:34 +00001378 if (Left.Type == TT_CastRParen)
1379 return 100;
Daniel Jasper215d6c82014-01-22 08:04:52 +00001380 if (Left.is(tok::coloncolon) ||
1381 (Right.is(tok::period) && Style.Language == FormatStyle::LK_Proto))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001382 return 500;
Daniel Jasper83193602013-04-05 17:22:09 +00001383 if (Left.isOneOf(tok::kw_class, tok::kw_struct))
1384 return 5000;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001385
Daniel Jaspereead02b2013-02-14 08:42:54 +00001386 if (Left.Type == TT_RangeBasedForLoopColon ||
1387 Left.Type == TT_InheritanceColon)
Daniel Jasper16b35622013-02-26 13:18:08 +00001388 return 2;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001389
Daniel Jasper4c6e0052013-08-27 14:24:43 +00001390 if (Right.isMemberAccess()) {
Daniel Jasper4d7a97a2014-01-10 08:40:17 +00001391 if (Left.is(tok::r_paren) && Left.MatchingParen &&
Daniel Jasper36c28ce2013-09-06 08:54:24 +00001392 Left.MatchingParen->ParameterCount > 0)
Daniel Jasper70bc8742013-02-26 13:59:14 +00001393 return 20; // Should be smaller than breaking at a nested comma.
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001394 return 150;
1395 }
1396
Daniel Jaspere3f907f2014-06-02 09:52:08 +00001397 if (Right.Type == TT_TrailingAnnotation &&
1398 (!Right.Next || Right.Next->isNot(tok::l_paren))) {
Daniel Jasper5550de62014-02-17 07:57:46 +00001399 // Generally, breaking before a trailing annotation is bad unless it is
1400 // function-like. It seems to be especially preferable to keep standard
1401 // annotations (i.e. "const", "final" and "override") on the same line.
Daniel Jasper43e6a282013-12-16 15:01:54 +00001402 // Use a slightly higher penalty after ")" so that annotations like
1403 // "const override" are kept together.
Daniel Jasperb48d3af2014-04-09 10:01:49 +00001404 bool is_short_annotation = Right.TokenText.size() < 10;
Daniel Jasperb05a81d2014-05-09 13:11:16 +00001405 return (Left.is(tok::r_paren) ? 100 : 120) + (is_short_annotation ? 50 : 0);
Daniel Jasper43e6a282013-12-16 15:01:54 +00001406 }
Daniel Jasper13c37b32013-05-22 08:28:26 +00001407
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001408 // In for-loops, prefer breaking at ',' and ';'.
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001409 if (Line.First->is(tok::kw_for) && Left.is(tok::equal))
Daniel Jasper37905f72013-02-21 15:00:29 +00001410 return 4;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001411
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001412 // In Objective-C method expressions, prefer breaking before "param:" over
1413 // breaking after it.
Daniel Jasper17062ff2014-06-10 14:44:02 +00001414 if (Right.Type == TT_SelectorName)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001415 return 0;
Daniel Jasper1ac3e052013-02-05 10:07:47 +00001416 if (Left.is(tok::colon) && Left.Type == TT_ObjCMethodExpr)
Daniel Jasper4bf0d802013-11-23 14:27:27 +00001417 return Line.MightBeFunctionDecl ? 50 : 500;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001418
Daniel Jasper4fcc8b92013-11-07 17:52:51 +00001419 if (Left.is(tok::l_paren) && InFunctionDecl)
Daniel Jasper6728fc12013-04-11 14:29:13 +00001420 return 100;
Daniel Jasper126153a2013-12-27 06:39:56 +00001421 if (Left.is(tok::equal) && InFunctionDecl)
1422 return 110;
Daniel Jasperc04baae2013-04-10 09:49:49 +00001423 if (Left.opensScope())
Daniel Jasper33b909c2013-10-25 14:29:37 +00001424 return Left.ParameterCount > 1 ? Style.PenaltyBreakBeforeFirstCallParameter
1425 : 19;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001426
Daniel Jasperba9ddb62013-02-06 21:04:05 +00001427 if (Right.is(tok::lessless)) {
1428 if (Left.is(tok::string_literal)) {
Alexander Kornienkoffcc0102013-06-05 14:09:10 +00001429 StringRef Content = Left.TokenText;
Daniel Jasper0b1f76b2013-09-29 12:02:57 +00001430 if (Content.startswith("\""))
1431 Content = Content.drop_front(1);
1432 if (Content.endswith("\""))
1433 Content = Content.drop_back(1);
1434 Content = Content.trim();
Daniel Jasperf38a0ac2013-03-14 14:00:17 +00001435 if (Content.size() > 1 &&
1436 (Content.back() == ':' || Content.back() == '='))
Daniel Jasperfa21c072013-07-15 14:33:14 +00001437 return 25;
Daniel Jasperba9ddb62013-02-06 21:04:05 +00001438 }
Daniel Jasper49a94482013-07-15 15:04:42 +00001439 return 1; // Breaking at a << is really cheap.
Daniel Jasperba9ddb62013-02-06 21:04:05 +00001440 }
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001441 if (Left.Type == TT_ConditionalExpr)
Daniel Jasper70bc8742013-02-26 13:59:14 +00001442 return prec::Conditional;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001443 prec::Level Level = Left.getPrecedence();
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001444
1445 if (Level != prec::Unknown)
1446 return Level;
Daniel Jasperf9a84b52013-03-01 16:48:32 +00001447
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001448 return 3;
1449}
1450
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001451bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001452 const FormatToken &Left,
1453 const FormatToken &Right) {
Daniel Jasper7052ce62014-01-19 09:04:08 +00001454 if (Style.Language == FormatStyle::LK_Proto) {
Daniel Jasper9c2820c2014-06-23 07:36:25 +00001455 if (Right.is(tok::period) &&
1456 (Left.TokenText == "optional" || Left.TokenText == "required" ||
1457 Left.TokenText == "repeated"))
1458 return true;
Daniel Jasper929b1db2014-01-20 16:47:22 +00001459 if (Right.is(tok::l_paren) &&
1460 (Left.TokenText == "returns" || Left.TokenText == "option"))
Daniel Jasper7052ce62014-01-19 09:04:08 +00001461 return true;
Daniel Jasper0dd52912014-05-19 07:37:07 +00001462 } else if (Style.Language == FormatStyle::LK_JavaScript) {
1463 if (Left.TokenText == "var")
1464 return true;
Daniel Jasper7052ce62014-01-19 09:04:08 +00001465 }
Daniel Jasper166c19b2014-05-06 14:12:21 +00001466 if (Left.is(tok::kw_return) && Right.isNot(tok::semi))
1467 return true;
Daniel Jaspere9beea22014-01-28 15:20:33 +00001468 if (Style.ObjCSpaceAfterProperty && Line.Type == LT_ObjCProperty &&
1469 Left.Tok.getObjCKeywordID() == tok::objc_property)
1470 return true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001471 if (Right.is(tok::hashhash))
1472 return Left.is(tok::hash);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001473 if (Left.isOneOf(tok::hashhash, tok::hash))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001474 return Right.is(tok::hash);
Daniel Jasperb55acad2013-08-20 12:36:34 +00001475 if (Left.is(tok::l_paren) && Right.is(tok::r_paren))
1476 return Style.SpaceInEmptyParentheses;
1477 if (Left.is(tok::l_paren) || Right.is(tok::r_paren))
Daniel Jasperf110e202013-08-21 08:39:01 +00001478 return (Right.Type == TT_CastRParen ||
1479 (Left.MatchingParen && Left.MatchingParen->Type == TT_CastRParen))
Daniel Jasperb55acad2013-08-20 12:36:34 +00001480 ? Style.SpacesInCStyleCastParentheses
1481 : Style.SpacesInParentheses;
Daniel Jasperdd978ae2013-10-29 14:52:02 +00001482 if (Style.SpacesInAngles &&
1483 ((Left.Type == TT_TemplateOpener) != (Right.Type == TT_TemplateCloser)))
1484 return true;
Daniel Jasperb55acad2013-08-20 12:36:34 +00001485 if (Right.isOneOf(tok::semi, tok::comma))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001486 return false;
1487 if (Right.is(tok::less) &&
Daniel Jasperdcf37fb2014-08-01 13:03:05 +00001488 (Left.isOneOf(tok::kw_template, tok::r_paren) ||
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001489 (Line.Type == LT_ObjCDecl && Style.ObjCSpaceBeforeProtocolList)))
1490 return true;
1491 if (Left.is(tok::arrow) || Right.is(tok::arrow))
1492 return false;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001493 if (Left.isOneOf(tok::exclaim, tok::tilde))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001494 return false;
1495 if (Left.is(tok::at) &&
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001496 Right.isOneOf(tok::identifier, tok::string_literal, tok::char_constant,
1497 tok::numeric_constant, tok::l_paren, tok::l_brace,
1498 tok::kw_true, tok::kw_false))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001499 return false;
1500 if (Left.is(tok::coloncolon))
1501 return false;
Daniel Jasper7620b662014-01-08 15:41:13 +00001502 if (Right.is(tok::coloncolon) && Left.isNot(tok::l_brace))
Daniel Jasperfba84ff2013-10-12 05:16:06 +00001503 return (Left.is(tok::less) && Style.Standard == FormatStyle::LS_Cpp03) ||
1504 !Left.isOneOf(tok::identifier, tok::greater, tok::l_paren,
1505 tok::r_paren, tok::less);
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001506 if (Left.is(tok::less) || Right.isOneOf(tok::greater, tok::less))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001507 return false;
Daniel Jasperbafa6b72013-07-01 09:47:25 +00001508 if (Right.is(tok::ellipsis))
Daniel Jasper2d0cd492013-10-20 16:56:16 +00001509 return Left.Tok.isLiteral();
Manuel Klimekbab25fd2013-09-04 08:20:47 +00001510 if (Left.is(tok::l_square) && Right.is(tok::amp))
1511 return false;
Alexander Kornienkoa5151272013-03-12 16:28:18 +00001512 if (Right.Type == TT_PointerOrReference)
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001513 return Left.Tok.isLiteral() ||
Alexander Kornienkoa5151272013-03-12 16:28:18 +00001514 ((Left.Type != TT_PointerOrReference) && Left.isNot(tok::l_paren) &&
Daniel Jasper553d4872014-06-17 12:40:34 +00001515 Style.PointerAlignment != FormatStyle::PAS_Left);
Daniel Jasper4d03d3b2013-05-28 15:27:10 +00001516 if (Right.Type == TT_FunctionTypeLParen && Left.isNot(tok::l_paren) &&
Daniel Jasperdcf37fb2014-08-01 13:03:05 +00001517 (Left.Type != TT_PointerOrReference ||
1518 Style.PointerAlignment != FormatStyle::PAS_Right))
Daniel Jaspercfda5172013-05-08 14:58:20 +00001519 return true;
Alexander Kornienkoa5151272013-03-12 16:28:18 +00001520 if (Left.Type == TT_PointerOrReference)
Daniel Jasper022612d2013-07-01 09:34:09 +00001521 return Right.Tok.isLiteral() || Right.Type == TT_BlockComment ||
Daniel Jasperb8914dd2013-03-20 09:53:18 +00001522 ((Right.Type != TT_PointerOrReference) &&
Daniel Jasperdcf37fb2014-08-01 13:03:05 +00001523 Right.isNot(tok::l_paren) &&
1524 Style.PointerAlignment != FormatStyle::PAS_Right && Left.Previous &&
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001525 !Left.Previous->isOneOf(tok::l_paren, tok::coloncolon));
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001526 if (Right.is(tok::star) && Left.is(tok::l_paren))
1527 return false;
Nico Weber2a726b62013-02-10 02:08:05 +00001528 if (Left.is(tok::l_square))
Daniel Jasper1db6c382013-10-22 15:30:28 +00001529 return Left.Type == TT_ArrayInitializerLSquare &&
Daniel Jasperb2e10a52014-01-15 15:09:08 +00001530 Style.SpacesInContainerLiterals && Right.isNot(tok::r_square);
Nico Weber2a726b62013-02-10 02:08:05 +00001531 if (Right.is(tok::r_square))
Daniel Jasperb2e10a52014-01-15 15:09:08 +00001532 return Right.MatchingParen && Style.SpacesInContainerLiterals &&
Daniel Jasper1db6c382013-10-22 15:30:28 +00001533 Right.MatchingParen->Type == TT_ArrayInitializerLSquare;
Daniel Jasper8ddfa842013-08-30 10:36:58 +00001534 if (Right.is(tok::l_square) && Right.Type != TT_ObjCMethodExpr &&
Daniel Jasper89519082014-05-09 10:26:08 +00001535 Right.Type != TT_LambdaLSquare && Left.isNot(tok::numeric_constant) &&
1536 Left.Type != TT_DictLiteral)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001537 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001538 if (Left.is(tok::colon))
1539 return Left.Type != TT_ObjCMethodExpr;
Daniel Jasper484033b2014-05-06 14:41:29 +00001540 if (Left.Type == TT_BlockComment)
1541 return !Left.TokenText.endswith("=*/");
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001542 if (Right.is(tok::l_paren)) {
Daniel Jasper559b63c2014-01-28 20:13:43 +00001543 if (Left.is(tok::r_paren) && Left.Type == TT_AttributeParen)
Daniel Jasperee6d6502013-07-17 20:25:02 +00001544 return true;
Alexander Kornienko62b85b92013-03-13 14:41:29 +00001545 return Line.Type == LT_ObjCDecl ||
Daniel Jasper166c19b2014-05-06 14:12:21 +00001546 Left.isOneOf(tok::kw_new, tok::kw_delete, tok::semi) ||
Alexander Kornienkofdca83d2013-12-10 10:18:34 +00001547 (Style.SpaceBeforeParens != FormatStyle::SBPO_Never &&
Daniel Jaspere1e43192014-04-01 12:55:11 +00001548 (Left.isOneOf(tok::kw_if, tok::kw_for, tok::kw_while,
Daniel Jasper031e2402014-04-28 07:48:36 +00001549 tok::kw_switch, tok::kw_catch, tok::kw_case) ||
Daniel Jaspere1e43192014-04-01 12:55:11 +00001550 Left.IsForEachMacro)) ||
Alexander Kornienkofdca83d2013-12-10 10:18:34 +00001551 (Style.SpaceBeforeParens == FormatStyle::SBPO_Always &&
Daniel Jasper78b194992014-08-06 14:15:41 +00001552 (Left.is(tok::identifier) || Left.isFunctionLikeKeyword()) &&
Alexander Kornienkofdca83d2013-12-10 10:18:34 +00001553 Line.Type != LT_PreprocessorDirective);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001554 }
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001555 if (Left.is(tok::at) && Right.Tok.getObjCKeywordID() != tok::objc_not_keyword)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001556 return false;
1557 if (Left.is(tok::l_brace) && Right.is(tok::r_brace))
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001558 return !Left.Children.empty(); // No spaces in "{}".
Daniel Jasper1a148b42014-01-05 13:23:23 +00001559 if ((Left.is(tok::l_brace) && Left.BlockKind != BK_Block) ||
1560 (Right.is(tok::r_brace) && Right.MatchingParen &&
1561 Right.MatchingParen->BlockKind != BK_Block))
Daniel Jasper6ab54682013-07-16 18:22:10 +00001562 return !Style.Cpp11BracedListStyle;
Daniel Jasper5bd0b9e2013-05-23 18:05:18 +00001563 if (Right.Type == TT_UnaryOperator)
1564 return !Left.isOneOf(tok::l_paren, tok::l_square, tok::at) &&
1565 (Left.isNot(tok::colon) || Left.Type != TT_ObjCMethodExpr);
Daniel Jasper4afc6b32014-06-02 10:57:55 +00001566 if ((Left.isOneOf(tok::identifier, tok::greater, tok::r_square,
1567 tok::r_paren) ||
Daniel Jasper7a2d60e2014-05-07 07:59:03 +00001568 Left.isSimpleTypeSpecifier()) &&
Manuel Klimekbab25fd2013-09-04 08:20:47 +00001569 Right.is(tok::l_brace) && Right.getNextNonComment() &&
1570 Right.BlockKind != BK_Block)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001571 return false;
Daniel Jasperbca4bbe2013-05-28 11:30:49 +00001572 if (Left.is(tok::period) || Right.is(tok::period))
1573 return false;
Alexander Kornienkod8d47fa2013-09-10 13:41:43 +00001574 if (Right.is(tok::hash) && Left.is(tok::identifier) && Left.TokenText == "L")
1575 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001576 return true;
1577}
1578
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001579bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001580 const FormatToken &Tok) {
1581 if (Tok.Tok.getIdentifierInfo() && Tok.Previous->Tok.getIdentifierInfo())
Daniel Jasper35d2dc72013-02-11 08:01:18 +00001582 return true; // Never ever merge two identifiers.
Daniel Jasper877615c2013-10-11 19:45:02 +00001583 if (Tok.Previous->Type == TT_ImplicitStringLiteral)
1584 return Tok.WhitespaceRange.getBegin() != Tok.WhitespaceRange.getEnd();
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001585 if (Line.Type == LT_ObjCMethodDecl) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001586 if (Tok.Previous->Type == TT_ObjCMethodSpecifier)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001587 return true;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001588 if (Tok.Previous->is(tok::r_paren) && Tok.is(tok::identifier))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001589 // Don't space between ')' and <id>
1590 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001591 }
1592 if (Line.Type == LT_ObjCProperty &&
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001593 (Tok.is(tok::equal) || Tok.Previous->is(tok::equal)))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001594 return false;
1595
Daniel Jasper6cdec7c2013-07-09 14:36:48 +00001596 if (Tok.Type == TT_TrailingReturnArrow ||
1597 Tok.Previous->Type == TT_TrailingReturnArrow)
1598 return true;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001599 if (Tok.Previous->is(tok::comma))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001600 return true;
Daniel Jasperff6c3a92013-02-28 13:40:17 +00001601 if (Tok.is(tok::comma))
1602 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001603 if (Tok.Type == TT_CtorInitializerColon || Tok.Type == TT_ObjCBlockLParen)
1604 return true;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001605 if (Tok.Previous->Tok.is(tok::kw_operator))
Daniel Jasperedc5f092013-10-29 12:24:23 +00001606 return Tok.is(tok::coloncolon);
Daniel Jasper35d2dc72013-02-11 08:01:18 +00001607 if (Tok.Type == TT_OverloadedOperatorLParen)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001608 return false;
1609 if (Tok.is(tok::colon))
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001610 return !Line.First->isOneOf(tok::kw_case, tok::kw_default) &&
Daniel Jasperb05a81d2014-05-09 13:11:16 +00001611 Tok.getNextNonComment() && Tok.Type != TT_ObjCMethodExpr &&
1612 !Tok.Previous->is(tok::question) &&
Daniel Jasperb2e10a52014-01-15 15:09:08 +00001613 (Tok.Type != TT_DictLiteral || Style.SpacesInContainerLiterals);
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001614 if (Tok.Previous->Type == TT_UnaryOperator ||
1615 Tok.Previous->Type == TT_CastRParen)
Daniel Jasperff974ab2014-01-25 09:16:02 +00001616 return Tok.Type == TT_BinaryOperator;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001617 if (Tok.Previous->is(tok::greater) && Tok.is(tok::greater)) {
Daniel Jasper400adc62013-02-08 15:28:42 +00001618 return Tok.Type == TT_TemplateCloser &&
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001619 Tok.Previous->Type == TT_TemplateCloser &&
Daniel Jasperdd978ae2013-10-29 14:52:02 +00001620 (Style.Standard != FormatStyle::LS_Cpp11 || Style.SpacesInAngles);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001621 }
Alexander Kornienko674be0a2013-03-20 16:41:56 +00001622 if (Tok.isOneOf(tok::arrowstar, tok::periodstar) ||
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001623 Tok.Previous->isOneOf(tok::arrowstar, tok::periodstar))
Daniel Jasperff6c3a92013-02-28 13:40:17 +00001624 return false;
Daniel Jasperd94bff32013-09-25 15:15:02 +00001625 if (!Style.SpaceBeforeAssignmentOperators &&
1626 Tok.getPrecedence() == prec::Assignment)
1627 return false;
Daniel Jasper9613c812013-08-07 16:29:23 +00001628 if ((Tok.Type == TT_BinaryOperator && !Tok.Previous->is(tok::l_paren)) ||
Daniel Jasperc0d606a2014-04-14 11:08:45 +00001629 Tok.Previous->Type == TT_BinaryOperator ||
1630 Tok.Previous->Type == TT_ConditionalExpr)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001631 return true;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001632 if (Tok.Previous->Type == TT_TemplateCloser && Tok.is(tok::l_paren))
Chad Rosier0a84f172014-08-05 17:58:54 +00001633 return Style.SpaceBeforeParens == FormatStyle::SBPO_Always;
Daniel Jaspered8f1c62013-08-28 08:24:04 +00001634 if (Tok.is(tok::less) && Tok.Previous->isNot(tok::l_paren) &&
1635 Line.First->is(tok::hash))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001636 return true;
1637 if (Tok.Type == TT_TrailingUnaryOperator)
1638 return false;
Daniel Jasperf9ae3122014-05-08 07:01:45 +00001639 if (Tok.Previous->Type == TT_RegexLiteral)
1640 return false;
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001641 return spaceRequiredBetween(Line, *Tok.Previous, Tok);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001642}
1643
Daniel Jaspere18ff372014-06-02 10:17:32 +00001644// Returns 'true' if 'Tok' is a brace we'd want to break before in Allman style.
1645static bool isAllmanBrace(const FormatToken &Tok) {
1646 return Tok.is(tok::l_brace) && Tok.BlockKind == BK_Block &&
1647 Tok.Type != TT_ObjCBlockLBrace && Tok.Type != TT_DictLiteral;
1648}
1649
Daniel Jasperfb81b092013-09-17 09:52:48 +00001650bool TokenAnnotator::mustBreakBefore(const AnnotatedLine &Line,
1651 const FormatToken &Right) {
Daniel Jaspera125d532014-03-21 12:38:57 +00001652 const FormatToken &Left = *Right.Previous;
Daniel Jaspera69ca9b2014-06-04 12:40:57 +00001653 if (Right.NewlinesBefore > 1)
1654 return true;
Daniel Jasperfb81b092013-09-17 09:52:48 +00001655 if (Right.is(tok::comment)) {
Daniel Jasper5a611392013-12-19 21:41:37 +00001656 return Right.Previous->BlockKind != BK_BracedInit &&
Daniel Jasperf6c7c182014-01-13 14:10:04 +00001657 Right.Previous->Type != TT_CtorInitializerColon &&
Manuel Klimek1fcbe672014-04-11 12:27:47 +00001658 (Right.NewlinesBefore > 0 && Right.HasUnescapedNewline);
Daniel Jasperfb81b092013-09-17 09:52:48 +00001659 } else if (Right.Previous->isTrailingComment() ||
Daniel Jasper04b6a082013-12-20 06:22:01 +00001660 (Right.isStringLiteral() && Right.Previous->isStringLiteral())) {
Daniel Jasperfb81b092013-09-17 09:52:48 +00001661 return true;
1662 } else if (Right.Previous->IsUnterminatedLiteral) {
1663 return true;
1664 } else if (Right.is(tok::lessless) && Right.Next &&
1665 Right.Previous->is(tok::string_literal) &&
1666 Right.Next->is(tok::string_literal)) {
1667 return true;
1668 } else if (Right.Previous->ClosesTemplateDeclaration &&
1669 Right.Previous->MatchingParen &&
Daniel Jasper63af7c42013-12-09 14:40:19 +00001670 Right.Previous->MatchingParen->NestingLevel == 0 &&
Daniel Jasperfb81b092013-09-17 09:52:48 +00001671 Style.AlwaysBreakTemplateDeclarations) {
Daniel Jasperfb81b092013-09-17 09:52:48 +00001672 return true;
Alexander Kornienkoa594ba82013-12-16 14:35:51 +00001673 } else if ((Right.Type == TT_CtorInitializerComma ||
1674 Right.Type == TT_CtorInitializerColon) &&
Daniel Jasperec01cd62013-10-08 05:11:18 +00001675 Style.BreakConstructorInitializersBeforeComma &&
1676 !Style.ConstructorInitializerAllOnOneLineOrOnePerLine) {
Daniel Jasperfb81b092013-09-17 09:52:48 +00001677 return true;
Daniel Jasperc39b56f2013-12-16 07:23:08 +00001678 } else if (Right.is(tok::string_literal) &&
1679 Right.TokenText.startswith("R\"")) {
1680 // Raw string literals are special wrt. line breaks. The author has made a
1681 // deliberate choice and might have aligned the contents of the string
1682 // literal accordingly. Thus, we try keep existing line breaks.
1683 return Right.NewlinesBefore > 0;
Daniel Jasper6e58fee2014-01-29 18:43:40 +00001684 } else if (Right.Previous->is(tok::l_brace) && Right.NestingLevel == 1 &&
Daniel Jasper7052ce62014-01-19 09:04:08 +00001685 Style.Language == FormatStyle::LK_Proto) {
1686 // Don't enums onto single lines in protocol buffers.
1687 return true;
Daniel Jaspere18ff372014-06-02 10:17:32 +00001688 } else if (isAllmanBrace(Left) || isAllmanBrace(Right)) {
1689 return Style.BreakBeforeBraces == FormatStyle::BS_Allman ||
1690 Style.BreakBeforeBraces == FormatStyle::BS_GNU;
Daniel Jaspera382cbe2014-07-28 14:08:09 +00001691 } else if (Style.Language == FormatStyle::LK_Proto &&
1692 Left.isNot(tok::l_brace) && Right.Type == TT_SelectorName) {
1693 return true;
Daniel Jasperfb81b092013-09-17 09:52:48 +00001694 }
Daniel Jasperb175d572014-04-09 09:53:23 +00001695
Daniel Jasperf9fc2152014-04-09 13:18:49 +00001696 // If the last token before a '}' is a comma or a comment, the intention is to
1697 // insert a line break after it in order to make shuffling around entries
1698 // easier.
Daniel Jasperb175d572014-04-09 09:53:23 +00001699 const FormatToken *BeforeClosingBrace = nullptr;
1700 if (Left.is(tok::l_brace) && Left.MatchingParen)
Daniel Jasperf9fc2152014-04-09 13:18:49 +00001701 BeforeClosingBrace = Left.MatchingParen->Previous;
Daniel Jasperb175d572014-04-09 09:53:23 +00001702 else if (Right.is(tok::r_brace))
Daniel Jasperf9fc2152014-04-09 13:18:49 +00001703 BeforeClosingBrace = Right.Previous;
1704 if (BeforeClosingBrace &&
1705 BeforeClosingBrace->isOneOf(tok::comma, tok::comment))
Daniel Jasperb175d572014-04-09 09:53:23 +00001706 return true;
1707
Daniel Jasper49802ef2014-05-22 09:10:04 +00001708 if (Style.Language == FormatStyle::LK_JavaScript) {
1709 // FIXME: This might apply to other languages and token kinds.
1710 if (Right.is(tok::char_constant) && Left.is(tok::plus) && Left.Previous &&
1711 Left.Previous->is(tok::char_constant))
1712 return true;
1713 }
1714
Daniel Jasperfb81b092013-09-17 09:52:48 +00001715 return false;
1716}
1717
Daniel Jasper7fce3ab2013-02-06 14:22:40 +00001718bool TokenAnnotator::canBreakBefore(const AnnotatedLine &Line,
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001719 const FormatToken &Right) {
1720 const FormatToken &Left = *Right.Previous;
Daniel Jasper4bf0d802013-11-23 14:27:27 +00001721 if (Left.is(tok::at))
1722 return false;
Daniel Jasper437c3f52014-04-28 07:34:48 +00001723 if (Left.Tok.getObjCKeywordID() == tok::objc_interface)
1724 return false;
Daniel Jasper4355e7f2014-07-09 07:50:33 +00001725 if (Right.Type == TT_StartOfName ||
1726 Right.Type == TT_FunctionDeclarationName || Right.is(tok::kw_operator))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001727 return true;
Daniel Jasper165b29e2013-11-08 00:57:11 +00001728 if (Right.isTrailingComment())
1729 // We rely on MustBreakBefore being set correctly here as we should not
1730 // change the "binding" behavior of a comment.
Daniel Jasper5a611392013-12-19 21:41:37 +00001731 // The first comment in a braced lists is always interpreted as belonging to
1732 // the first list element. Otherwise, it should be placed outside of the
1733 // list.
1734 return Left.BlockKind == BK_BracedInit;
Daniel Jasper165b29e2013-11-08 00:57:11 +00001735 if (Left.is(tok::question) && Right.is(tok::colon))
1736 return false;
1737 if (Right.Type == TT_ConditionalExpr || Right.is(tok::question))
1738 return Style.BreakBeforeTernaryOperators;
1739 if (Left.Type == TT_ConditionalExpr || Left.is(tok::question))
1740 return !Style.BreakBeforeTernaryOperators;
Daniel Jasper3a122c02014-02-14 18:22:40 +00001741 if (Right.Type == TT_InheritanceColon)
1742 return true;
Daniel Jasperd39312ec2014-05-28 10:09:11 +00001743 if (Right.is(tok::colon) && (Right.Type != TT_CtorInitializerColon &&
1744 Right.Type != TT_InlineASMColon))
1745 return false;
Nico Weberced7d412013-05-26 05:39:26 +00001746 if (Left.is(tok::colon) &&
Daniel Jasperb596fb22013-10-24 10:31:50 +00001747 (Left.Type == TT_DictLiteral || Left.Type == TT_ObjCMethodExpr))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001748 return true;
Daniel Jasper17062ff2014-06-10 14:44:02 +00001749 if (Right.Type == TT_SelectorName)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001750 return true;
Daniel Jasper9688ff12013-08-01 13:46:58 +00001751 if (Left.is(tok::r_paren) && Line.Type == LT_ObjCProperty)
1752 return true;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001753 if (Left.ClosesTemplateDeclaration)
1754 return true;
Daniel Jaspereead02b2013-02-14 08:42:54 +00001755 if (Right.Type == TT_RangeBasedForLoopColon ||
Daniel Jasperd215b8b2013-08-28 07:27:35 +00001756 Right.Type == TT_OverloadedOperatorLParen ||
1757 Right.Type == TT_OverloadedOperator)
Daniel Jaspereead02b2013-02-14 08:42:54 +00001758 return false;
Daniel Jaspera61aefb2013-05-06 06:45:09 +00001759 if (Left.Type == TT_RangeBasedForLoopColon)
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001760 return true;
Daniel Jasper37905f72013-02-21 15:00:29 +00001761 if (Right.Type == TT_RangeBasedForLoopColon)
1762 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001763 if (Left.Type == TT_PointerOrReference || Left.Type == TT_TemplateCloser ||
Daniel Jasper165b29e2013-11-08 00:57:11 +00001764 Left.Type == TT_UnaryOperator || Left.is(tok::kw_operator))
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001765 return false;
1766 if (Left.is(tok::equal) && Line.Type == LT_VirtualFunctionDecl)
1767 return false;
Daniel Jasper559b63c2014-01-28 20:13:43 +00001768 if (Left.is(tok::l_paren) && Left.Type == TT_AttributeParen)
1769 return false;
1770 if (Left.is(tok::l_paren) && Left.Previous &&
1771 (Left.Previous->Type == TT_BinaryOperator ||
Daniel Jasper8acf8222014-05-07 09:23:05 +00001772 Left.Previous->Type == TT_CastRParen || Left.Previous->is(tok::kw_if)))
Daniel Jasper559b63c2014-01-28 20:13:43 +00001773 return false;
Daniel Jasper98857842013-10-30 13:54:53 +00001774 if (Right.Type == TT_ImplicitStringLiteral)
1775 return false;
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001776
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001777 if (Right.is(tok::r_paren) || Right.Type == TT_TemplateCloser)
1778 return false;
1779
Daniel Jasper13c37b32013-05-22 08:28:26 +00001780 // We only break before r_brace if there was a corresponding break before
1781 // the l_brace, which is tracked by BreakBeforeClosingBrace.
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001782 if (Right.is(tok::r_brace))
1783 return Right.MatchingParen && Right.MatchingParen->BlockKind == BK_Block;
Daniel Jasper13c37b32013-05-22 08:28:26 +00001784
Daniel Jasperf9a09062014-04-09 10:29:11 +00001785 // Allow breaking after a trailing annotation, e.g. after a method
1786 // declaration.
1787 if (Left.Type == TT_TrailingAnnotation)
1788 return !Right.isOneOf(tok::l_brace, tok::semi, tok::equal, tok::l_paren,
1789 tok::less, tok::coloncolon);
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001790
Daniel Jasperbf4755b2013-03-14 09:50:46 +00001791 if (Right.is(tok::kw___attribute))
1792 return true;
1793
Daniel Jasperaf5ba0e2013-02-23 07:46:38 +00001794 if (Left.is(tok::identifier) && Right.is(tok::string_literal))
1795 return true;
Daniel Jaspere33d4af2013-07-26 16:56:36 +00001796
Daniel Jasper783bac62014-04-15 09:54:30 +00001797 if (Right.is(tok::identifier) && Right.Next &&
1798 Right.Next->Type == TT_DictLiteral)
1799 return true;
1800
Daniel Jaspere33d4af2013-07-26 16:56:36 +00001801 if (Left.Type == TT_CtorInitializerComma &&
1802 Style.BreakConstructorInitializersBeforeComma)
1803 return false;
Daniel Jasperec01cd62013-10-08 05:11:18 +00001804 if (Right.Type == TT_CtorInitializerComma &&
1805 Style.BreakConstructorInitializersBeforeComma)
1806 return true;
Daniel Jasper0de8efa2013-09-17 08:15:46 +00001807 if (Left.is(tok::greater) && Right.is(tok::greater) &&
1808 Left.Type != TT_TemplateCloser)
1809 return false;
Daniel Jasper0a1e5ac2014-05-13 08:01:47 +00001810 if (Right.Type == TT_BinaryOperator && Style.BreakBeforeBinaryOperators)
1811 return true;
Daniel Jasper1db6c382013-10-22 15:30:28 +00001812 if (Left.Type == TT_ArrayInitializerLSquare)
1813 return true;
Daniel Jasper85bcadc2014-07-09 13:07:57 +00001814 return (Left.isBinaryOperator() &&
1815 !Left.isOneOf(tok::arrowstar, tok::lessless) &&
Daniel Jaspere33d4af2013-07-26 16:56:36 +00001816 !Style.BreakBeforeBinaryOperators) ||
Daniel Jasper83193602013-04-05 17:22:09 +00001817 Left.isOneOf(tok::comma, tok::coloncolon, tok::semi, tok::l_brace,
1818 tok::kw_class, tok::kw_struct) ||
Daniel Jasper85bcadc2014-07-09 13:07:57 +00001819 Right.isMemberAccess() ||
Daniel Jasper71646ec2014-07-30 12:14:10 +00001820 Right.isOneOf(tok::lessless, tok::colon, tok::l_square, tok::at,
1821 tok::kw_typename) ||
Daniel Jasper1bc1b502013-07-05 07:58:34 +00001822 (Left.is(tok::r_paren) &&
Daniel Jasper559b63c2014-01-28 20:13:43 +00001823 Right.isOneOf(tok::identifier, tok::kw_const)) ||
Daniel Jasper1db6c382013-10-22 15:30:28 +00001824 (Left.is(tok::l_paren) && !Right.is(tok::r_paren));
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001825}
1826
Daniel Jasper6bee6822013-04-08 20:33:42 +00001827void TokenAnnotator::printDebugInfo(const AnnotatedLine &Line) {
1828 llvm::errs() << "AnnotatedTokens:\n";
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001829 const FormatToken *Tok = Line.First;
Daniel Jasper6bee6822013-04-08 20:33:42 +00001830 while (Tok) {
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001831 llvm::errs() << " M=" << Tok->MustBreakBefore
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001832 << " C=" << Tok->CanBreakBefore << " T=" << Tok->Type
1833 << " S=" << Tok->SpacesRequiredBefore
Daniel Jasper17062ff2014-06-10 14:44:02 +00001834 << " B=" << Tok->BlockParameterCount
Daniel Jasperb10cbc42013-07-10 14:02:49 +00001835 << " P=" << Tok->SplitPenalty << " Name=" << Tok->Tok.getName()
Manuel Klimek71814b42013-10-11 21:25:45 +00001836 << " L=" << Tok->TotalLength << " PPK=" << Tok->PackingKind
1837 << " FakeLParens=";
Daniel Jasper6bee6822013-04-08 20:33:42 +00001838 for (unsigned i = 0, e = Tok->FakeLParens.size(); i != e; ++i)
1839 llvm::errs() << Tok->FakeLParens[i] << "/";
1840 llvm::errs() << " FakeRParens=" << Tok->FakeRParens << "\n";
Daniel Jasperb05a81d2014-05-09 13:11:16 +00001841 if (!Tok->Next)
Manuel Klimek71814b42013-10-11 21:25:45 +00001842 assert(Tok == Line.Last);
Manuel Klimek6e6310e2013-05-29 14:47:47 +00001843 Tok = Tok->Next;
Daniel Jasper6bee6822013-04-08 20:33:42 +00001844 }
1845 llvm::errs() << "----\n";
1846}
1847
Daniel Jasper7a6d09b2013-01-29 21:01:14 +00001848} // namespace format
1849} // namespace clang