blob: 15b67634edd6f9fae071b53c2cd039894f800ac7 [file] [log] [blame]
Daniel Jasperde0328a2013-08-16 11:20:30 +00001//===--- ContinuationIndenter.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 the continuation indenter.
12///
13//===----------------------------------------------------------------------===//
14
Daniel Jasperde0328a2013-08-16 11:20:30 +000015#include "BreakableToken.h"
16#include "ContinuationIndenter.h"
17#include "WhitespaceManager.h"
18#include "clang/Basic/OperatorPrecedence.h"
19#include "clang/Basic/SourceManager.h"
20#include "clang/Format/Format.h"
21#include "llvm/Support/Debug.h"
Daniel Jasperde0328a2013-08-16 11:20:30 +000022
Krasimir Georgiev91834222017-01-25 13:58:58 +000023#define DEBUG_TYPE "format-indenter"
Chandler Carruth10346662014-04-22 03:17:02 +000024
Daniel Jasperde0328a2013-08-16 11:20:30 +000025namespace clang {
26namespace format {
27
28// Returns the length of everything up to the first possible line break after
29// the ), ], } or > matching \c Tok.
30static unsigned getLengthToMatchingParen(const FormatToken &Tok) {
Craig Topper2145bc02014-05-09 08:15:10 +000031 if (!Tok.MatchingParen)
Daniel Jasperde0328a2013-08-16 11:20:30 +000032 return 0;
33 FormatToken *End = Tok.MatchingParen;
34 while (End->Next && !End->Next->CanBreakBefore) {
35 End = End->Next;
36 }
37 return End->TotalLength - Tok.TotalLength + 1;
38}
39
Daniel Jasper801cdb22016-01-05 13:03:59 +000040static unsigned getLengthToNextOperator(const FormatToken &Tok) {
41 if (!Tok.NextOperator)
42 return 0;
43 return Tok.NextOperator->TotalLength - Tok.TotalLength;
44}
45
Daniel Jasper4c6e0052013-08-27 14:24:43 +000046// Returns \c true if \c Tok is the "." or "->" of a call and starts the next
47// segment of a builder type call.
48static bool startsSegmentOfBuilderTypeCall(const FormatToken &Tok) {
49 return Tok.isMemberAccess() && Tok.Previous && Tok.Previous->closesScope();
50}
51
Daniel Jasperec01cd62013-10-08 05:11:18 +000052// Returns \c true if \c Current starts a new parameter.
53static bool startsNextParameter(const FormatToken &Current,
54 const FormatStyle &Style) {
55 const FormatToken &Previous = *Current.Previous;
Daniel Jaspera98b7b02014-11-25 10:05:17 +000056 if (Current.is(TT_CtorInitializerComma) &&
Francois Ferranda6b6d512017-05-24 11:36:58 +000057 Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma)
Daniel Jasperec01cd62013-10-08 05:11:18 +000058 return true;
Krasimir Georgievff747be2017-06-27 13:43:07 +000059 if (Style.Language == FormatStyle::LK_Proto && Current.is(TT_SelectorName))
60 return true;
Daniel Jasperec01cd62013-10-08 05:11:18 +000061 return Previous.is(tok::comma) && !Current.isTrailingComment() &&
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +000062 ((Previous.isNot(TT_CtorInitializerComma) ||
Francois Ferranda6b6d512017-05-24 11:36:58 +000063 Style.BreakConstructorInitializers !=
64 FormatStyle::BCIS_BeforeComma) &&
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +000065 (Previous.isNot(TT_InheritanceComma) ||
Francois Ferranda6b6d512017-05-24 11:36:58 +000066 !Style.BreakBeforeInheritanceComma));
Daniel Jasperec01cd62013-10-08 05:11:18 +000067}
68
Krasimir Georgiev26b144c2017-07-03 15:05:14 +000069static bool opensProtoMessageField(const FormatToken &LessTok,
70 const FormatStyle &Style) {
71 if (LessTok.isNot(tok::less))
72 return false;
73 return Style.Language == FormatStyle::LK_TextProto ||
74 (Style.Language == FormatStyle::LK_Proto &&
75 (LessTok.NestingLevel > 0 ||
76 (LessTok.Previous && LessTok.Previous->is(tok::equal))));
77}
78
Daniel Jasperde0328a2013-08-16 11:20:30 +000079ContinuationIndenter::ContinuationIndenter(const FormatStyle &Style,
Daniel Jasperd0ec0d62014-11-04 12:41:02 +000080 const AdditionalKeywords &Keywords,
Eric Liu635423e2016-04-28 07:52:03 +000081 const SourceManager &SourceMgr,
Daniel Jasperde0328a2013-08-16 11:20:30 +000082 WhitespaceManager &Whitespaces,
83 encoding::Encoding Encoding,
84 bool BinPackInconclusiveFunctions)
Daniel Jasperd0ec0d62014-11-04 12:41:02 +000085 : Style(Style), Keywords(Keywords), SourceMgr(SourceMgr),
86 Whitespaces(Whitespaces), Encoding(Encoding),
Alexander Kornienkoce9161a2014-01-02 15:13:14 +000087 BinPackInconclusiveFunctions(BinPackInconclusiveFunctions),
88 CommentPragmasRegex(Style.CommentPragmas) {}
Daniel Jasperde0328a2013-08-16 11:20:30 +000089
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +000090LineState ContinuationIndenter::getInitialState(unsigned FirstIndent,
Daniel Jasper1c5d9df2013-09-06 07:54:20 +000091 const AnnotatedLine *Line,
92 bool DryRun) {
Daniel Jasperde0328a2013-08-16 11:20:30 +000093 LineState State;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +000094 State.FirstIndent = FirstIndent;
Daniel Jasperde0328a2013-08-16 11:20:30 +000095 State.Column = FirstIndent;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +000096 State.Line = Line;
97 State.NextToken = Line->First;
Daniel Jasper7d42f3f2017-01-31 11:25:01 +000098 State.Stack.push_back(ParenState(FirstIndent, FirstIndent,
Daniel Jasperde0328a2013-08-16 11:20:30 +000099 /*AvoidBinPacking=*/false,
100 /*NoLineBreak=*/false));
101 State.LineContainsContinuedForLoopSection = false;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000102 State.StartOfStringLiteral = 0;
Daniel Jasper05cd5862014-05-08 12:21:30 +0000103 State.StartOfLineLevel = 0;
104 State.LowestLevelOnLine = 0;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000105 State.IgnoreStackForComparison = false;
106
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000107 if (Style.Language == FormatStyle::LK_TextProto) {
108 // We need this in order to deal with the bin packing of text fields at
109 // global scope.
110 State.Stack.back().AvoidBinPacking = true;
111 State.Stack.back().BreakBeforeParameter = true;
112 }
113
Daniel Jasperde0328a2013-08-16 11:20:30 +0000114 // The first token has already been indented and thus consumed.
Daniel Jasper1c5d9df2013-09-06 07:54:20 +0000115 moveStateToNextToken(State, DryRun, /*Newline=*/false);
Daniel Jasperde0328a2013-08-16 11:20:30 +0000116 return State;
117}
118
119bool ContinuationIndenter::canBreak(const LineState &State) {
120 const FormatToken &Current = *State.NextToken;
121 const FormatToken &Previous = *Current.Previous;
122 assert(&Previous == Current.Previous);
Nico Weberbeb03932015-01-09 23:25:06 +0000123 if (!Current.CanBreakBefore &&
124 !(State.Stack.back().BreakBeforeClosingBrace &&
Daniel Jasperbd73bcf2015-10-27 13:42:08 +0000125 Current.closesBlockOrBlockTypeList(Style)))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000126 return false;
127 // The opening "{" of a braced list has to be on the same line as the first
128 // element if it is nested in another braced init list or function call.
129 if (!Current.MustBreakBefore && Previous.is(tok::l_brace) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000130 Previous.isNot(TT_DictLiteral) && Previous.BlockKind == BK_BracedInit &&
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000131 Previous.Previous &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000132 Previous.Previous->isOneOf(tok::l_brace, tok::l_paren, tok::comma))
133 return false;
134 // This prevents breaks like:
135 // ...
136 // SomeParameter, OtherParameter).DoSomething(
137 // ...
138 // As they hide "DoSomething" and are generally bad for readability.
Daniel Jasper8f59ae52014-03-11 11:03:26 +0000139 if (Previous.opensScope() && Previous.isNot(tok::l_brace) &&
Daniel Jasperfcfac102014-07-15 09:00:34 +0000140 State.LowestLevelOnLine < State.StartOfLineLevel &&
141 State.LowestLevelOnLine < Current.NestingLevel)
Daniel Jasperde0328a2013-08-16 11:20:30 +0000142 return false;
Daniel Jasper4c6e0052013-08-27 14:24:43 +0000143 if (Current.isMemberAccess() && State.Stack.back().ContainsUnwrappedBuilder)
144 return false;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000145
146 // Don't create a 'hanging' indent if there are multiple blocks in a single
147 // statement.
Daniel Jasper4b444492014-11-21 13:38:53 +0000148 if (Previous.is(tok::l_brace) && State.Stack.size() > 1 &&
149 State.Stack[State.Stack.size() - 2].NestedBlockInlined &&
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000150 State.Stack[State.Stack.size() - 2].HasMultipleNestedBlocks)
151 return false;
152
Daniel Jaspere068ac72014-10-27 17:13:59 +0000153 // Don't break after very short return types (e.g. "void") as that is often
154 // unexpected.
Zachary Turner448592e2015-12-18 22:20:15 +0000155 if (Current.is(TT_FunctionDeclarationName) && State.Column < 6) {
156 if (Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None)
157 return false;
158 }
Daniel Jaspere068ac72014-10-27 17:13:59 +0000159
Daniel Jasper240527c2017-01-16 13:13:15 +0000160 // If binary operators are moved to the next line (including commas for some
161 // styles of constructor initializers), that's always ok.
162 if (!Current.isOneOf(TT_BinaryOperator, tok::comma) &&
163 State.Stack.back().NoLineBreakInOperand)
164 return false;
165
Daniel Jasperde0328a2013-08-16 11:20:30 +0000166 return !State.Stack.back().NoLineBreak;
167}
168
169bool ContinuationIndenter::mustBreak(const LineState &State) {
170 const FormatToken &Current = *State.NextToken;
171 const FormatToken &Previous = *Current.Previous;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000172 if (Current.MustBreakBefore || Current.is(TT_InlineASMColon))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000173 return true;
Daniel Jasper1db6c382013-10-22 15:30:28 +0000174 if (State.Stack.back().BreakBeforeClosingBrace &&
Daniel Jasperbd73bcf2015-10-27 13:42:08 +0000175 Current.closesBlockOrBlockTypeList(Style))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000176 return true;
177 if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection)
178 return true;
Daniel Jasperec01cd62013-10-08 05:11:18 +0000179 if ((startsNextParameter(Current, Style) || Previous.is(tok::semi) ||
Daniel Jasper00693b082016-01-09 15:56:47 +0000180 (Previous.is(TT_TemplateCloser) && Current.is(TT_StartOfName) &&
Daniel Jasper1dbc2102017-03-31 13:30:24 +0000181 Style.isCpp() &&
Daniel Jasper06ca0fc2016-01-11 11:01:05 +0000182 // FIXME: This is a temporary workaround for the case where clang-format
183 // sets BreakBeforeParameter to avoid bin packing and this creates a
184 // completely unnecessary line break after a template type that isn't
185 // line-wrapped.
186 (Previous.NestingLevel == 1 || Style.BinPackParameters)) ||
Daniel Jasper3e0dcc22015-05-27 05:37:40 +0000187 (Style.BreakBeforeTernaryOperators && Current.is(TT_ConditionalExpr) &&
188 Previous.isNot(tok::question)) ||
Daniel Jasper165b29e2013-11-08 00:57:11 +0000189 (!Style.BreakBeforeTernaryOperators &&
Daniel Jasper3e0dcc22015-05-27 05:37:40 +0000190 Previous.is(TT_ConditionalExpr))) &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000191 State.Stack.back().BreakBeforeParameter && !Current.isTrailingComment() &&
192 !Current.isOneOf(tok::r_paren, tok::r_brace))
193 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000194 if (((Previous.is(TT_DictLiteral) && Previous.is(tok::l_brace)) ||
Daniel Jasperccff4d12016-01-04 07:27:33 +0000195 (Previous.is(TT_ArrayInitializerLSquare) &&
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000196 Previous.ParameterCount > 1) ||
197 opensProtoMessageField(Previous, Style)) &&
Daniel Jasperdb8804b2014-04-14 12:11:07 +0000198 Style.ColumnLimit > 0 &&
Daniel Jasper199d0c92015-06-02 15:14:21 +0000199 getLengthToMatchingParen(Previous) + State.Column - 1 >
200 getColumnLimit(State))
Daniel Jasperd489dd32013-10-20 16:45:46 +0000201 return true;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000202
203 const FormatToken &BreakConstructorInitializersToken =
204 Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon
205 ? Previous
206 : Current;
207 if (BreakConstructorInitializersToken.is(TT_CtorInitializerColon) &&
208 (State.Column + State.Line->Last->TotalLength - Previous.TotalLength >
Daniel Jasper7b259cd2015-08-27 11:59:31 +0000209 getColumnLimit(State) ||
210 State.Stack.back().BreakBeforeParameter) &&
Francois Ferranda6b6d512017-05-24 11:36:58 +0000211 (Style.AllowShortFunctionsOnASingleLine != FormatStyle::SFS_All ||
212 Style.BreakConstructorInitializers != FormatStyle::BCIS_BeforeColon ||
213 Style.ColumnLimit != 0))
Daniel Jasper5d2587d2014-03-27 16:14:13 +0000214 return true;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000215
Daniel Jasperfd36f0b2016-11-12 07:38:22 +0000216 if (Current.is(TT_ObjCMethodExpr) && !Previous.is(TT_SelectorName) &&
217 State.Line->startsWith(TT_ObjCMethodSpecifier))
218 return true;
Daniel Jasper2746a302015-05-06 13:13:03 +0000219 if (Current.is(TT_SelectorName) && State.Stack.back().ObjCSelectorNameFound &&
220 State.Stack.back().BreakBeforeParameter)
221 return true;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000222
Daniel Jasper2aaedd32015-06-18 09:12:47 +0000223 unsigned NewLineColumn = getNewLineColumn(State);
Daniel Jaspera3cd21642016-01-14 13:36:46 +0000224 if (Current.isMemberAccess() && Style.ColumnLimit != 0 &&
Daniel Jasper28024562016-01-11 11:00:58 +0000225 State.Column + getLengthToNextOperator(Current) > Style.ColumnLimit &&
226 (State.Column > NewLineColumn ||
227 Current.NestingLevel < State.StartOfLineLevel))
228 return true;
229
Daniel Jaspere61f9f92017-01-13 23:18:16 +0000230 if (startsSegmentOfBuilderTypeCall(Current) &&
231 (State.Stack.back().CallContinuation != 0 ||
Daniel Jasper51c868e2017-01-30 07:08:40 +0000232 State.Stack.back().BreakBeforeParameter) &&
233 // JavaScript is treated different here as there is a frequent pattern:
234 // SomeFunction(function() {
235 // ...
236 // }.bind(...));
237 // FIXME: We should find a more generic solution to this problem.
Martin Probstb2f06ea2017-05-29 07:50:52 +0000238 !(State.Column <= NewLineColumn &&
Daniel Jasper51c868e2017-01-30 07:08:40 +0000239 Style.Language == FormatStyle::LK_JavaScript))
Daniel Jaspere61f9f92017-01-13 23:18:16 +0000240 return true;
241
Daniel Jasper411af722016-01-05 16:10:39 +0000242 if (State.Column <= NewLineColumn)
Daniel Jasper5d2587d2014-03-27 16:14:13 +0000243 return false;
Daniel Jasper173504e2015-05-10 21:15:07 +0000244
Daniel Jasper2aaedd32015-06-18 09:12:47 +0000245 if (Style.AlwaysBreakBeforeMultilineStrings &&
Daniel Jasper1bf729c2015-06-18 16:05:17 +0000246 (NewLineColumn == State.FirstIndent + Style.ContinuationIndentWidth ||
Daniel Jasper9fb676a2015-06-19 10:32:28 +0000247 Previous.is(tok::comma) || Current.NestingLevel < 2) &&
Daniel Jasper2aaedd32015-06-18 09:12:47 +0000248 !Previous.isOneOf(tok::kw_return, tok::lessless, tok::at) &&
249 !Previous.isOneOf(TT_InlineASMColon, TT_ConditionalExpr) &&
250 nextIsMultilineString(State))
251 return true;
252
Daniel Jasper173504e2015-05-10 21:15:07 +0000253 // Using CanBreakBefore here and below takes care of the decision whether the
254 // current style uses wrapping before or after operators for the given
255 // operator.
256 if (Previous.is(TT_BinaryOperator) && Current.CanBreakBefore) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000257 // If we need to break somewhere inside the LHS of a binary expression, we
258 // should also break after the operator. Otherwise, the formatting would
259 // hide the operator precedence, e.g. in:
260 // if (aaaaaaaaaaaaaa ==
261 // bbbbbbbbbbbbbb && c) {..
262 // For comparisons, we only apply this rule, if the LHS is a binary
263 // expression itself as otherwise, the line breaks seem superfluous.
264 // We need special cases for ">>" which we have split into two ">" while
265 // lexing in order to make template parsing easier.
Daniel Jasperde0328a2013-08-16 11:20:30 +0000266 bool IsComparison = (Previous.getPrecedence() == prec::Relational ||
267 Previous.getPrecedence() == prec::Equality) &&
268 Previous.Previous &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000269 Previous.Previous->isNot(TT_BinaryOperator); // For >>.
Daniel Jasperde0328a2013-08-16 11:20:30 +0000270 bool LHSIsBinaryExpr =
Daniel Jasper562ecd42013-09-06 08:08:14 +0000271 Previous.Previous && Previous.Previous->EndsBinaryExpression;
Daniel Jasper173504e2015-05-10 21:15:07 +0000272 if ((!IsComparison || LHSIsBinaryExpr) && !Current.isTrailingComment() &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000273 Previous.getPrecedence() != prec::Assignment &&
274 State.Stack.back().BreakBeforeParameter)
275 return true;
Daniel Jasper173504e2015-05-10 21:15:07 +0000276 } else if (Current.is(TT_BinaryOperator) && Current.CanBreakBefore &&
277 State.Stack.back().BreakBeforeParameter) {
278 return true;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000279 }
280
281 // Same as above, but for the first "<<" operator.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000282 if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator) &&
Alexander Kornienko86b2dfd2014-03-06 15:13:08 +0000283 State.Stack.back().BreakBeforeParameter &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000284 State.Stack.back().FirstLessLess == 0)
285 return true;
286
Daniel Jasper211e1322014-12-08 20:08:04 +0000287 if (Current.NestingLevel == 0 && !Current.isTrailingComment()) {
Daniel Jasperf090f032015-05-18 09:47:22 +0000288 // Always break after "template <...>" and leading annotations. This is only
289 // for cases where the entire line does not fit on a single line as a
290 // different LineFormatter would be used otherwise.
Daniel Jasper211e1322014-12-08 20:08:04 +0000291 if (Previous.ClosesTemplateDeclaration)
292 return true;
Daniel Jasper47bbda02015-05-18 13:47:23 +0000293 if (Previous.is(TT_FunctionAnnotationRParen))
Daniel Jasperf090f032015-05-18 09:47:22 +0000294 return true;
Nico Weberbeb03932015-01-09 23:25:06 +0000295 if (Previous.is(TT_LeadingJavaAnnotation) && Current.isNot(tok::l_paren) &&
296 Current.isNot(TT_LeadingJavaAnnotation))
Daniel Jasper211e1322014-12-08 20:08:04 +0000297 return true;
298 }
Daniel Jasperde0328a2013-08-16 11:20:30 +0000299
Daniel Jasper4355e7f2014-07-09 07:50:33 +0000300 // If the return type spans multiple lines, wrap before the function name.
Birunthan Mohanathas525579d2015-07-15 19:11:58 +0000301 if ((Current.is(TT_FunctionDeclarationName) ||
302 (Current.is(tok::kw_operator) && !Previous.is(tok::coloncolon))) &&
Daniel Jasper0c9772e2016-02-05 14:17:16 +0000303 !Previous.is(tok::kw_template) && State.Stack.back().BreakBeforeParameter)
Daniel Jasperde0328a2013-08-16 11:20:30 +0000304 return true;
Daniel Jasper4355e7f2014-07-09 07:50:33 +0000305
Daniel Jasper96972812014-01-05 12:38:10 +0000306 // The following could be precomputed as they do not depend on the state.
307 // However, as they should take effect only if the UnwrappedLine does not fit
308 // into the ColumnLimit, they are checked here in the ContinuationIndenter.
Daniel Jasper35995672014-04-29 14:05:20 +0000309 if (Style.ColumnLimit != 0 && Previous.BlockKind == BK_Block &&
310 Previous.is(tok::l_brace) && !Current.isOneOf(tok::r_brace, tok::comment))
Daniel Jasper96972812014-01-05 12:38:10 +0000311 return true;
Daniel Jasper96972812014-01-05 12:38:10 +0000312
Daniel Jasper0a589412016-01-05 13:06:27 +0000313 if (Current.is(tok::lessless) &&
314 ((Previous.is(tok::identifier) && Previous.TokenText == "endl") ||
315 (Previous.Tok.isLiteral() && (Previous.TokenText.endswith("\\n\"") ||
316 Previous.TokenText == "\'\\n\'"))))
Daniel Jasper69963122015-02-17 10:05:15 +0000317 return true;
318
Daniel Jasperde0328a2013-08-16 11:20:30 +0000319 return false;
320}
321
322unsigned ContinuationIndenter::addTokenToState(LineState &State, bool Newline,
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000323 bool DryRun,
324 unsigned ExtraSpaces) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000325 const FormatToken &Current = *State.NextToken;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000326
Manuel Klimek819788d2014-03-18 11:22:45 +0000327 assert(!State.Stack.empty());
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000328 if ((Current.is(TT_ImplicitStringLiteral) &&
Craig Topper2145bc02014-05-09 08:15:10 +0000329 (Current.Previous->Tok.getIdentifierInfo() == nullptr ||
Daniel Jasper98857842013-10-30 13:54:53 +0000330 Current.Previous->Tok.getIdentifierInfo()->getPPKeywordID() ==
331 tok::pp_not_keyword))) {
Daniel Jasper30526e72015-01-31 07:05:46 +0000332 unsigned EndColumn =
333 SourceMgr.getSpellingColumnNumber(Current.WhitespaceRange.getEnd());
334 if (Current.LastNewlineOffset != 0) {
335 // If there is a newline within this token, the final column will solely
336 // determined by the current end column.
337 State.Column = EndColumn;
338 } else {
339 unsigned StartColumn =
340 SourceMgr.getSpellingColumnNumber(Current.WhitespaceRange.getBegin());
341 assert(EndColumn >= StartColumn);
342 State.Column += EndColumn - StartColumn;
343 }
Daniel Jasper240dfda2014-03-31 14:23:49 +0000344 moveStateToNextToken(State, DryRun, /*Newline=*/false);
Daniel Jasperde0328a2013-08-16 11:20:30 +0000345 return 0;
346 }
347
Alexander Kornienko1f803962013-10-01 14:41:18 +0000348 unsigned Penalty = 0;
349 if (Newline)
350 Penalty = addTokenOnNewLine(State, DryRun);
351 else
Daniel Jasper48437ce2013-11-20 14:54:39 +0000352 addTokenOnCurrentLine(State, DryRun, ExtraSpaces);
Alexander Kornienko1f803962013-10-01 14:41:18 +0000353
354 return moveStateToNextToken(State, DryRun, Newline) + Penalty;
355}
356
Daniel Jasper48437ce2013-11-20 14:54:39 +0000357void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun,
358 unsigned ExtraSpaces) {
Manuel Klimek71814b42013-10-11 21:25:45 +0000359 FormatToken &Current = *State.NextToken;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000360 const FormatToken &Previous = *State.NextToken->Previous;
361 if (Current.is(tok::equal) &&
Daniel Jasper05cd5862014-05-08 12:21:30 +0000362 (State.Line->First->is(tok::kw_for) || Current.NestingLevel == 0) &&
Alexander Kornienko1f803962013-10-01 14:41:18 +0000363 State.Stack.back().VariablePos == 0) {
364 State.Stack.back().VariablePos = State.Column;
365 // Move over * and & if they are bound to the variable name.
366 const FormatToken *Tok = &Previous;
367 while (Tok && State.Stack.back().VariablePos >= Tok->ColumnWidth) {
368 State.Stack.back().VariablePos -= Tok->ColumnWidth;
369 if (Tok->SpacesRequiredBefore != 0)
370 break;
371 Tok = Tok->Previous;
372 }
373 if (Previous.PartOfMultiVariableDeclStmt)
374 State.Stack.back().LastSpace = State.Stack.back().VariablePos;
375 }
376
377 unsigned Spaces = Current.SpacesRequiredBefore + ExtraSpaces;
378
379 if (!DryRun)
Daniel Jasper7d42f3f2017-01-31 11:25:01 +0000380 Whitespaces.replaceWhitespace(Current, /*Newlines=*/0, Spaces,
381 State.Column + Spaces);
Alexander Kornienko1f803962013-10-01 14:41:18 +0000382
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +0000383 // If "BreakBeforeInheritanceComma" mode, don't break within the inheritance
384 // declaration unless there is multiple inheritance.
385 if (Style.BreakBeforeInheritanceComma && Current.is(TT_InheritanceColon))
386 State.Stack.back().NoLineBreak = true;
387
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000388 if (Current.is(TT_SelectorName) &&
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000389 !State.Stack.back().ObjCSelectorNameFound) {
Daniel Jasper06a26952016-01-04 07:29:07 +0000390 unsigned MinIndent =
391 std::max(State.FirstIndent + Style.ContinuationIndentWidth,
392 State.Stack.back().Indent);
393 unsigned FirstColonPos = State.Column + Spaces + Current.ColumnWidth;
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000394 if (Current.LongestObjCSelectorName == 0)
395 State.Stack.back().AlignColons = false;
Daniel Jasper06a26952016-01-04 07:29:07 +0000396 else if (MinIndent + Current.LongestObjCSelectorName > FirstColonPos)
397 State.Stack.back().ColonPos = MinIndent + Current.LongestObjCSelectorName;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000398 else
Daniel Jasper06a26952016-01-04 07:29:07 +0000399 State.Stack.back().ColonPos = FirstColonPos;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000400 }
401
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000402 // In "AlwaysBreak" mode, enforce wrapping directly after the parenthesis by
403 // disallowing any further line breaks if there is no line break after the
404 // opening parenthesis. Don't break if it doesn't conserve columns.
405 if (Style.AlignAfterOpenBracket == FormatStyle::BAS_AlwaysBreak &&
Daniel Jasperb618a982016-02-02 10:28:11 +0000406 Previous.isOneOf(tok::l_paren, TT_TemplateOpener, tok::l_square) &&
407 State.Column > getNewLineColumn(State) &&
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000408 (!Previous.Previous ||
Daniel Jasper710f8492016-03-17 12:00:22 +0000409 !Previous.Previous->isOneOf(tok::kw_for, tok::kw_while,
410 tok::kw_switch)) &&
411 // Don't do this for simple (no expressions) one-argument function calls
412 // as that feels like needlessly wasting whitespace, e.g.:
413 //
414 // caaaaaaaaaaaall(
415 // caaaaaaaaaaaall(
416 // caaaaaaaaaaaall(
417 // caaaaaaaaaaaaaaaaaaaaaaall(aaaaaaaaaaaaaa, aaaaaaaaa))));
418 Current.FakeLParens.size() > 0 &&
419 Current.FakeLParens.back() > prec::Unknown)
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000420 State.Stack.back().NoLineBreak = true;
Daniel Jasper98e0b122017-02-20 14:51:16 +0000421 if (Previous.is(TT_TemplateString) && Previous.opensScope())
422 State.Stack.back().NoLineBreak = true;
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000423
424 if (Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign &&
425 Previous.opensScope() && Previous.isNot(TT_ObjCMethodExpr) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000426 (Current.isNot(TT_LineComment) || Previous.BlockKind == BK_BracedInit))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000427 State.Stack.back().Indent = State.Column + Spaces;
Daniel Jasperec01cd62013-10-08 05:11:18 +0000428 if (State.Stack.back().AvoidBinPacking && startsNextParameter(Current, Style))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000429 State.Stack.back().NoLineBreak = true;
Daniel Jasper775954b2015-04-24 10:08:09 +0000430 if (startsSegmentOfBuilderTypeCall(Current) &&
431 State.Column > getNewLineColumn(State))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000432 State.Stack.back().ContainsUnwrappedBuilder = true;
433
Daniel Jasper6f2b88a2015-06-05 13:18:09 +0000434 if (Current.is(TT_LambdaArrow) && Style.Language == FormatStyle::LK_Java)
Daniel Jasper05cd9292015-03-26 18:46:28 +0000435 State.Stack.back().NoLineBreak = true;
Daniel Jasperd6f17d82014-09-12 16:35:28 +0000436 if (Current.isMemberAccess() && Previous.is(tok::r_paren) &&
437 (Previous.MatchingParen &&
Daniel Jasper98e0b122017-02-20 14:51:16 +0000438 (Previous.TotalLength - Previous.MatchingParen->TotalLength > 10)))
Daniel Jasperd6f17d82014-09-12 16:35:28 +0000439 // If there is a function call with long parameters, break before trailing
440 // calls. This prevents things like:
441 // EXPECT_CALL(SomeLongParameter).Times(
442 // 2);
443 // We don't want to do this for short parameters as they can just be
444 // indexes.
445 State.Stack.back().NoLineBreak = true;
Daniel Jasperd6f17d82014-09-12 16:35:28 +0000446
Daniel Jasper240527c2017-01-16 13:13:15 +0000447 // Don't allow the RHS of an operator to be split over multiple lines unless
448 // there is a line-break right after the operator.
449 // Exclude relational operators, as there, it is always more desirable to
450 // have the LHS 'left' of the RHS.
451 const FormatToken *P = Current.getPreviousNonComment();
452 if (!Current.is(tok::comment) && P &&
453 (P->isOneOf(TT_BinaryOperator, tok::comma) ||
454 (P->is(TT_ConditionalExpr) && P->is(tok::colon))) &&
455 !P->isOneOf(TT_OverloadedOperator, TT_CtorInitializerComma) &&
456 P->getPrecedence() != prec::Assignment &&
457 P->getPrecedence() != prec::Relational) {
458 bool BreakBeforeOperator =
Daniel Jasperb1270392017-02-01 23:27:37 +0000459 P->MustBreakBefore || P->is(tok::lessless) ||
Daniel Jasper240527c2017-01-16 13:13:15 +0000460 (P->is(TT_BinaryOperator) &&
461 Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None) ||
462 (P->is(TT_ConditionalExpr) && Style.BreakBeforeTernaryOperators);
Daniel Jasper21f7dea2017-02-01 09:23:39 +0000463 // Don't do this if there are only two operands. In these cases, there is
464 // always a nice vertical separation between them and the extra line break
465 // does not help.
466 bool HasTwoOperands =
467 P->OperatorIndex == 0 && !P->NextOperator && !P->is(TT_ConditionalExpr);
Daniel Jasperc3aa05c2017-02-02 08:30:21 +0000468 if ((!BreakBeforeOperator && !(HasTwoOperands && Style.AlignOperands)) ||
Daniel Jasper240527c2017-01-16 13:13:15 +0000469 (!State.Stack.back().LastOperatorWrapped && BreakBeforeOperator))
470 State.Stack.back().NoLineBreakInOperand = true;
471 }
472
Alexander Kornienko1f803962013-10-01 14:41:18 +0000473 State.Column += Spaces;
Daniel Jasper8acf8222014-05-07 09:23:05 +0000474 if (Current.isNot(tok::comment) && Previous.is(tok::l_paren) &&
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000475 Previous.Previous &&
Daniel Jasper6a7d5a72017-06-19 07:40:49 +0000476 (Previous.Previous->isOneOf(tok::kw_if, tok::kw_for) ||
477 Previous.Previous->endsSequence(tok::kw_constexpr, tok::kw_if))) {
Alexander Kornienko1f803962013-10-01 14:41:18 +0000478 // Treat the condition inside an if as if it was a second function
Daniel Jasper6633ab82013-10-18 10:38:14 +0000479 // parameter, i.e. let nested calls have a continuation indent.
Daniel Jasper8acf8222014-05-07 09:23:05 +0000480 State.Stack.back().LastSpace = State.Column;
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000481 State.Stack.back().NestedBlockIndent = State.Column;
482 } else if (!Current.isOneOf(tok::comment, tok::caret) &&
Daniel Jasper804a2762016-01-09 15:56:40 +0000483 ((Previous.is(tok::comma) &&
484 !Previous.is(TT_OverloadedOperator)) ||
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000485 (Previous.is(tok::colon) && Previous.is(TT_ObjCMethodExpr)))) {
Alexander Kornienko1f803962013-10-01 14:41:18 +0000486 State.Stack.back().LastSpace = State.Column;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000487 } else if (Previous.is(TT_CtorInitializerColon) &&
488 Style.BreakConstructorInitializers ==
489 FormatStyle::BCIS_AfterColon) {
490 State.Stack.back().Indent = State.Column;
491 State.Stack.back().LastSpace = State.Column;
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000492 } else if ((Previous.isOneOf(TT_BinaryOperator, TT_ConditionalExpr,
493 TT_CtorInitializerColon)) &&
494 ((Previous.getPrecedence() != prec::Assignment &&
495 (Previous.isNot(tok::lessless) || Previous.OperatorIndex != 0 ||
Daniel Jasper00492f92016-01-05 13:03:50 +0000496 Previous.NextOperator)) ||
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000497 Current.StartsBinaryExpression)) {
Daniel Jasper602a7272016-02-11 13:15:14 +0000498 // Indent relative to the RHS of the expression unless this is a simple
499 // assignment without binary expression on the RHS. Also indent relative to
500 // unary operators and the colons of constructor initializers.
Alexander Kornienko1f803962013-10-01 14:41:18 +0000501 State.Stack.back().LastSpace = State.Column;
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000502 } else if (Previous.is(TT_InheritanceColon)) {
Alexander Kornienko1f803962013-10-01 14:41:18 +0000503 State.Stack.back().Indent = State.Column;
Daniel Jasperf9a5e402013-10-08 16:24:07 +0000504 State.Stack.back().LastSpace = State.Column;
505 } else if (Previous.opensScope()) {
Alexander Kornienko1f803962013-10-01 14:41:18 +0000506 // If a function has a trailing call, indent all parameters from the
507 // opening parenthesis. This avoids confusing indents like:
508 // OuterFunction(InnerFunctionCall( // break
509 // ParameterToInnerFunction)) // break
510 // .SecondInnerFunctionCall();
511 bool HasTrailingCall = false;
512 if (Previous.MatchingParen) {
513 const FormatToken *Next = Previous.MatchingParen->getNextNonComment();
514 HasTrailingCall = Next && Next->isMemberAccess();
515 }
Daniel Jasperd97d5d52015-02-17 09:58:03 +0000516 if (HasTrailingCall && State.Stack.size() > 1 &&
Alexander Kornienko1f803962013-10-01 14:41:18 +0000517 State.Stack[State.Stack.size() - 2].CallContinuation == 0)
518 State.Stack.back().LastSpace = State.Column;
519 }
520}
521
522unsigned ContinuationIndenter::addTokenOnNewLine(LineState &State,
523 bool DryRun) {
Manuel Klimek71814b42013-10-11 21:25:45 +0000524 FormatToken &Current = *State.NextToken;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000525 const FormatToken &Previous = *State.NextToken->Previous;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000526
Alexander Kornienko1f803962013-10-01 14:41:18 +0000527 // Extra penalty that needs to be added because of the way certain line
528 // breaks are chosen.
529 unsigned Penalty = 0;
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000530
Daniel Jaspera0407742014-02-11 10:08:11 +0000531 const FormatToken *PreviousNonComment = Current.getPreviousNonComment();
532 const FormatToken *NextNonComment = Previous.getNextNonComment();
533 if (!NextNonComment)
534 NextNonComment = &Current;
Daniel Jasper05cd5862014-05-08 12:21:30 +0000535 // The first line break on any NestingLevel causes an extra penalty in order
Alexander Kornienko1f803962013-10-01 14:41:18 +0000536 // prefer similar line breaks.
537 if (!State.Stack.back().ContainsLineBreak)
538 Penalty += 15;
539 State.Stack.back().ContainsLineBreak = true;
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000540
Alexander Kornienko1f803962013-10-01 14:41:18 +0000541 Penalty += State.NextToken->SplitPenalty;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000542
Alexander Kornienko1f803962013-10-01 14:41:18 +0000543 // Breaking before the first "<<" is generally not desirable if the LHS is
Daniel Jasper7aacf462016-12-19 11:14:23 +0000544 // short. Also always add the penalty if the LHS is split over multiple lines
Daniel Jasper2b7556e2014-04-03 12:00:27 +0000545 // to avoid unnecessary line breaks that just work around this penalty.
Daniel Jaspera0407742014-02-11 10:08:11 +0000546 if (NextNonComment->is(tok::lessless) &&
547 State.Stack.back().FirstLessLess == 0 &&
Daniel Jasper004177e2013-12-19 16:06:40 +0000548 (State.Column <= Style.ColumnLimit / 3 ||
Daniel Jasper48437ce2013-11-20 14:54:39 +0000549 State.Stack.back().BreakBeforeParameter))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000550 Penalty += Style.PenaltyBreakFirstLessLess;
551
Daniel Jasper9f388d02014-03-27 14:33:30 +0000552 State.Column = getNewLineColumn(State);
Daniel Jaspered3f3952015-06-18 12:32:59 +0000553
554 // Indent nested blocks relative to this column, unless in a very specific
555 // JavaScript special case where:
556 //
557 // var loooooong_name =
558 // function() {
559 // // code
560 // }
561 //
Daniel Jasper87448c52016-06-13 07:48:45 +0000562 // is common and should be formatted like a free-standing function. The same
563 // goes for wrapping before the lambda return type arrow.
564 if (!Current.is(TT_LambdaArrow) &&
565 (Style.Language != FormatStyle::LK_JavaScript ||
566 Current.NestingLevel != 0 || !PreviousNonComment ||
567 !PreviousNonComment->is(tok::equal) ||
568 !Current.isOneOf(Keywords.kw_async, Keywords.kw_function)))
Daniel Jaspered3f3952015-06-18 12:32:59 +0000569 State.Stack.back().NestedBlockIndent = State.Column;
570
Daniel Jasper9f388d02014-03-27 14:33:30 +0000571 if (NextNonComment->isMemberAccess()) {
572 if (State.Stack.back().CallContinuation == 0)
Alexander Kornienko1f803962013-10-01 14:41:18 +0000573 State.Stack.back().CallContinuation = State.Column;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000574 } else if (NextNonComment->is(TT_SelectorName)) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000575 if (!State.Stack.back().ObjCSelectorNameFound) {
Daniel Jaspera0407742014-02-11 10:08:11 +0000576 if (NextNonComment->LongestObjCSelectorName == 0) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000577 State.Stack.back().AlignColons = false;
578 } else {
579 State.Stack.back().ColonPos =
Daniel Jaspera2a4d9c2015-05-13 09:38:25 +0000580 (Style.IndentWrappedFunctionNames
581 ? std::max(State.Stack.back().Indent,
582 State.FirstIndent + Style.ContinuationIndentWidth)
583 : State.Stack.back().Indent) +
584 NextNonComment->LongestObjCSelectorName;
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000585 }
Daniel Jasper9f388d02014-03-27 14:33:30 +0000586 } else if (State.Stack.back().AlignColons &&
587 State.Stack.back().ColonPos <= NextNonComment->ColumnWidth) {
Daniel Jaspera0407742014-02-11 10:08:11 +0000588 State.Stack.back().ColonPos = State.Column + NextNonComment->ColumnWidth;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000589 }
Daniel Jasper1fd6f1f2014-03-17 14:32:47 +0000590 } else if (PreviousNonComment && PreviousNonComment->is(tok::colon) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000591 PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral)) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000592 // FIXME: This is hacky, find a better way. The problem is that in an ObjC
593 // method expression, the block should be aligned to the line starting it,
594 // e.g.:
595 // [aaaaaaaaaaaaaaa aaaaaaaaa: \\ break for some reason
596 // ^(int *i) {
597 // // ...
598 // }];
Daniel Jasper05cd5862014-05-08 12:21:30 +0000599 // Thus, we set LastSpace of the next higher NestingLevel, to which we move
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000600 // when we consume all of the "}"'s FakeRParens at the "{".
Daniel Jasper9a26e772013-12-23 11:25:40 +0000601 if (State.Stack.size() > 1)
Daniel Jasper9f388d02014-03-27 14:33:30 +0000602 State.Stack[State.Stack.size() - 2].LastSpace =
603 std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) +
604 Style.ContinuationIndentWidth;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000605 }
606
Daniel Jasper35e41222016-11-29 09:40:01 +0000607 if ((PreviousNonComment &&
608 PreviousNonComment->isOneOf(tok::comma, tok::semi) &&
Alexander Kornienko1f803962013-10-01 14:41:18 +0000609 !State.Stack.back().AvoidBinPacking) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000610 Previous.is(TT_BinaryOperator))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000611 State.Stack.back().BreakBeforeParameter = false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000612 if (Previous.isOneOf(TT_TemplateCloser, TT_JavaAnnotation) &&
Daniel Jasper39af6cd2014-11-03 02:27:28 +0000613 Current.NestingLevel == 0)
Alexander Kornienko1f803962013-10-01 14:41:18 +0000614 State.Stack.back().BreakBeforeParameter = false;
Daniel Jaspera0407742014-02-11 10:08:11 +0000615 if (NextNonComment->is(tok::question) ||
Daniel Jasper165b29e2013-11-08 00:57:11 +0000616 (PreviousNonComment && PreviousNonComment->is(tok::question)))
617 State.Stack.back().BreakBeforeParameter = true;
Daniel Jasper5962fa82015-06-03 09:26:03 +0000618 if (Current.is(TT_BinaryOperator) && Current.CanBreakBefore)
619 State.Stack.back().BreakBeforeParameter = false;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000620
621 if (!DryRun) {
Daniel Jaspera69ca9b2014-06-04 12:40:57 +0000622 unsigned Newlines = std::max(
623 1u, std::min(Current.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1));
Krasimir Georgieva1c30932017-05-19 10:34:57 +0000624 bool ContinuePPDirective =
625 State.Line->InPPDirective && State.Line->Type != LT_ImportStatement;
Daniel Jasper7d42f3f2017-01-31 11:25:01 +0000626 Whitespaces.replaceWhitespace(Current, Newlines, State.Column, State.Column,
Krasimir Georgieva1c30932017-05-19 10:34:57 +0000627 ContinuePPDirective);
Alexander Kornienko1f803962013-10-01 14:41:18 +0000628 }
629
630 if (!Current.isTrailingComment())
631 State.Stack.back().LastSpace = State.Column;
Daniel Jasper602a7272016-02-11 13:15:14 +0000632 if (Current.is(tok::lessless))
633 // If we are breaking before a "<<", we always want to indent relative to
634 // RHS. This is necessary only for "<<", as we special-case it and don't
635 // always indent relative to the RHS.
636 State.Stack.back().LastSpace += 3; // 3 -> width of "<< ".
637
Daniel Jasper05cd5862014-05-08 12:21:30 +0000638 State.StartOfLineLevel = Current.NestingLevel;
639 State.LowestLevelOnLine = Current.NestingLevel;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000640
641 // Any break on this level means that the parent level has been broken
642 // and we need to avoid bin packing there.
Daniel Jasper4b444492014-11-21 13:38:53 +0000643 bool NestedBlockSpecialCase =
Daniel Jasper1dbc2102017-03-31 13:30:24 +0000644 !Style.isCpp() && Current.is(tok::r_brace) && State.Stack.size() > 1 &&
Daniel Jasper4b444492014-11-21 13:38:53 +0000645 State.Stack[State.Stack.size() - 2].NestedBlockInlined;
Daniel Jasper1699eca2015-06-01 09:56:32 +0000646 if (!NestedBlockSpecialCase)
647 for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i)
Daniel Jasperb16b9692014-05-21 12:51:23 +0000648 State.Stack[i].BreakBeforeParameter = true;
Daniel Jasperb16b9692014-05-21 12:51:23 +0000649
Daniel Jasper9e5ede02013-11-08 19:56:28 +0000650 if (PreviousNonComment &&
Francois Ferranda6b6d512017-05-24 11:36:58 +0000651 !PreviousNonComment->isOneOf(tok::comma, tok::colon, tok::semi) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000652 (PreviousNonComment->isNot(TT_TemplateCloser) ||
Daniel Jasper6c0ee172014-11-14 13:14:45 +0000653 Current.NestingLevel != 0) &&
Daniel Jasper47bbda02015-05-18 13:47:23 +0000654 !PreviousNonComment->isOneOf(
655 TT_BinaryOperator, TT_FunctionAnnotationRParen, TT_JavaAnnotation,
656 TT_LeadingJavaAnnotation) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000657 Current.isNot(TT_BinaryOperator) && !PreviousNonComment->opensScope())
Alexander Kornienko1f803962013-10-01 14:41:18 +0000658 State.Stack.back().BreakBeforeParameter = true;
659
Daniel Jasper1db6c382013-10-22 15:30:28 +0000660 // If we break after { or the [ of an array initializer, we should also break
661 // before the corresponding } or ].
Daniel Jasper90818052014-06-10 10:42:26 +0000662 if (PreviousNonComment &&
Daniel Jasper98e0b122017-02-20 14:51:16 +0000663 (PreviousNonComment->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) ||
Martin Probstc10d97f2017-08-29 08:30:07 +0000664 opensProtoMessageField(*PreviousNonComment, Style)))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000665 State.Stack.back().BreakBeforeClosingBrace = true;
666
667 if (State.Stack.back().AvoidBinPacking) {
668 // If we are breaking after '(', '{', '<', this is not bin packing
Daniel Jasper2a958322014-05-21 13:26:58 +0000669 // unless AllowAllParametersOfDeclarationOnNextLine is false or this is a
670 // dict/object literal.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000671 if (!Previous.isOneOf(tok::l_paren, tok::l_brace, TT_BinaryOperator) ||
Alexander Kornienko1f803962013-10-01 14:41:18 +0000672 (!Style.AllowAllParametersOfDeclarationOnNextLine &&
Daniel Jasper2a958322014-05-21 13:26:58 +0000673 State.Line->MustBeDeclaration) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000674 Previous.is(TT_DictLiteral))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000675 State.Stack.back().BreakBeforeParameter = true;
676 }
677
678 return Penalty;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000679}
680
Daniel Jasper9f388d02014-03-27 14:33:30 +0000681unsigned ContinuationIndenter::getNewLineColumn(const LineState &State) {
Daniel Jasper5d2587d2014-03-27 16:14:13 +0000682 if (!State.NextToken || !State.NextToken->Previous)
683 return 0;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000684 FormatToken &Current = *State.NextToken;
Daniel Jasper4281c5a2014-10-07 14:45:34 +0000685 const FormatToken &Previous = *Current.Previous;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000686 // If we are continuing an expression, we want to use the continuation indent.
687 unsigned ContinuationIndent =
688 std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) +
689 Style.ContinuationIndentWidth;
690 const FormatToken *PreviousNonComment = Current.getPreviousNonComment();
691 const FormatToken *NextNonComment = Previous.getNextNonComment();
692 if (!NextNonComment)
693 NextNonComment = &Current;
Daniel Jasper50b4bd72014-11-02 19:16:41 +0000694
695 // Java specific bits.
Daniel Jasperd0ec0d62014-11-04 12:41:02 +0000696 if (Style.Language == FormatStyle::LK_Java &&
697 Current.isOneOf(Keywords.kw_implements, Keywords.kw_extends))
Daniel Jasper50b4bd72014-11-02 19:16:41 +0000698 return std::max(State.Stack.back().LastSpace,
699 State.Stack.back().Indent + Style.ContinuationIndentWidth);
700
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000701 if (NextNonComment->is(tok::l_brace) && NextNonComment->BlockKind == BK_Block)
Daniel Jasper05cd5862014-05-08 12:21:30 +0000702 return Current.NestingLevel == 0 ? State.FirstIndent
703 : State.Stack.back().Indent;
Krasimir Georgievff747be2017-06-27 13:43:07 +0000704 if ((Current.isOneOf(tok::r_brace, tok::r_square) ||
Krasimir Georgiev26b144c2017-07-03 15:05:14 +0000705 (Current.is(tok::greater) &&
706 (Style.Language == FormatStyle::LK_Proto ||
707 Style.Language == FormatStyle::LK_TextProto))) &&
Krasimir Georgievff747be2017-06-27 13:43:07 +0000708 State.Stack.size() > 1) {
Daniel Jasperbd73bcf2015-10-27 13:42:08 +0000709 if (Current.closesBlockOrBlockTypeList(Style))
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000710 return State.Stack[State.Stack.size() - 2].NestedBlockIndent;
711 if (Current.MatchingParen &&
712 Current.MatchingParen->BlockKind == BK_BracedInit)
Daniel Jasper9f388d02014-03-27 14:33:30 +0000713 return State.Stack[State.Stack.size() - 2].LastSpace;
Daniel Jasper24a14772014-12-10 17:24:34 +0000714 return State.FirstIndent;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000715 }
Martin Probstb2f06ea2017-05-29 07:50:52 +0000716 // Indent a closing parenthesis at the previous level if followed by a semi or
717 // opening brace. This allows indentations such as:
718 // foo(
719 // a,
720 // );
721 // function foo(
722 // a,
723 // ) {
724 // code(); //
725 // }
726 if (Current.is(tok::r_paren) && State.Stack.size() > 1 &&
727 (!Current.Next || Current.Next->isOneOf(tok::semi, tok::l_brace)))
Martin Probst2c1cdae2017-05-15 11:15:29 +0000728 return State.Stack[State.Stack.size() - 2].LastSpace;
Daniel Jasper98e0b122017-02-20 14:51:16 +0000729 if (NextNonComment->is(TT_TemplateString) && NextNonComment->closesScope())
730 return State.Stack[State.Stack.size() - 2].LastSpace;
Daniel Jasper783bac62014-04-15 09:54:30 +0000731 if (Current.is(tok::identifier) && Current.Next &&
Krasimir Georgievddb19242017-08-03 14:17:29 +0000732 (Current.Next->is(TT_DictLiteral) ||
733 ((Style.Language == FormatStyle::LK_Proto ||
734 Style.Language == FormatStyle::LK_TextProto) &&
735 Current.Next->isOneOf(TT_TemplateOpener, tok::l_brace))))
Daniel Jasper783bac62014-04-15 09:54:30 +0000736 return State.Stack.back().Indent;
Daniel Jasper09285532015-05-17 08:13:23 +0000737 if (NextNonComment->is(TT_ObjCStringLiteral) &&
738 State.StartOfStringLiteral != 0)
739 return State.StartOfStringLiteral - 1;
Alexander Kornienkod4fa2e62017-04-11 09:55:00 +0000740 if (NextNonComment->isStringLiteral() && State.StartOfStringLiteral != 0)
741 return State.StartOfStringLiteral;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000742 if (NextNonComment->is(tok::lessless) &&
743 State.Stack.back().FirstLessLess != 0)
744 return State.Stack.back().FirstLessLess;
745 if (NextNonComment->isMemberAccess()) {
Daniel Jasper24a14772014-12-10 17:24:34 +0000746 if (State.Stack.back().CallContinuation == 0)
Daniel Jasper9f388d02014-03-27 14:33:30 +0000747 return ContinuationIndent;
Daniel Jasper24a14772014-12-10 17:24:34 +0000748 return State.Stack.back().CallContinuation;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000749 }
750 if (State.Stack.back().QuestionColumn != 0 &&
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000751 ((NextNonComment->is(tok::colon) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000752 NextNonComment->is(TT_ConditionalExpr)) ||
753 Previous.is(TT_ConditionalExpr)))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000754 return State.Stack.back().QuestionColumn;
755 if (Previous.is(tok::comma) && State.Stack.back().VariablePos != 0)
756 return State.Stack.back().VariablePos;
Daniel Jaspere9ab42d2014-10-31 18:23:49 +0000757 if ((PreviousNonComment &&
758 (PreviousNonComment->ClosesTemplateDeclaration ||
Daniel Jasper47bbda02015-05-18 13:47:23 +0000759 PreviousNonComment->isOneOf(
760 TT_AttributeParen, TT_FunctionAnnotationRParen, TT_JavaAnnotation,
761 TT_LeadingJavaAnnotation))) ||
Daniel Jasperc75e1ef2014-07-09 08:42:42 +0000762 (!Style.IndentWrappedFunctionNames &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000763 NextNonComment->isOneOf(tok::kw_operator, TT_FunctionDeclarationName)))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000764 return std::max(State.Stack.back().LastSpace, State.Stack.back().Indent);
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000765 if (NextNonComment->is(TT_SelectorName)) {
Daniel Jasper9f388d02014-03-27 14:33:30 +0000766 if (!State.Stack.back().ObjCSelectorNameFound) {
Daniel Jasper24a14772014-12-10 17:24:34 +0000767 if (NextNonComment->LongestObjCSelectorName == 0)
Daniel Jasper9f388d02014-03-27 14:33:30 +0000768 return State.Stack.back().Indent;
Daniel Jaspera2a4d9c2015-05-13 09:38:25 +0000769 return (Style.IndentWrappedFunctionNames
770 ? std::max(State.Stack.back().Indent,
771 State.FirstIndent + Style.ContinuationIndentWidth)
772 : State.Stack.back().Indent) +
Daniel Jasper24a14772014-12-10 17:24:34 +0000773 NextNonComment->LongestObjCSelectorName -
774 NextNonComment->ColumnWidth;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000775 }
Daniel Jasper24a14772014-12-10 17:24:34 +0000776 if (!State.Stack.back().AlignColons)
777 return State.Stack.back().Indent;
778 if (State.Stack.back().ColonPos > NextNonComment->ColumnWidth)
779 return State.Stack.back().ColonPos - NextNonComment->ColumnWidth;
780 return State.Stack.back().Indent;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000781 }
Daniel Jasperfd36f0b2016-11-12 07:38:22 +0000782 if (NextNonComment->is(tok::colon) && NextNonComment->is(TT_ObjCMethodExpr))
783 return State.Stack.back().ColonPos;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000784 if (NextNonComment->is(TT_ArraySubscriptLSquare)) {
Daniel Jasper9f388d02014-03-27 14:33:30 +0000785 if (State.Stack.back().StartOfArraySubscripts != 0)
786 return State.Stack.back().StartOfArraySubscripts;
Daniel Jasper24a14772014-12-10 17:24:34 +0000787 return ContinuationIndent;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000788 }
Daniel Jasper9c950132015-05-07 14:19:59 +0000789
790 // This ensure that we correctly format ObjC methods calls without inputs,
791 // i.e. where the last element isn't selector like: [callee method];
792 if (NextNonComment->is(tok::identifier) && NextNonComment->FakeRParens == 0 &&
793 NextNonComment->Next && NextNonComment->Next->is(TT_ObjCMethodExpr))
Daniel Jaspereb536682015-05-06 12:48:06 +0000794 return State.Stack.back().Indent;
Daniel Jasper9c950132015-05-07 14:19:59 +0000795
Daniel Jasperb754a742015-03-12 15:04:53 +0000796 if (NextNonComment->isOneOf(TT_StartOfName, TT_PointerOrReference) ||
Daniel Jasperb2328b12015-07-06 14:07:51 +0000797 Previous.isOneOf(tok::coloncolon, tok::equal, TT_JsTypeColon))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000798 return ContinuationIndent;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000799 if (PreviousNonComment && PreviousNonComment->is(tok::colon) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000800 PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000801 return ContinuationIndent;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000802 if (NextNonComment->is(TT_CtorInitializerComma))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000803 return State.Stack.back().Indent;
Francois Ferranda6b6d512017-05-24 11:36:58 +0000804 if (PreviousNonComment && PreviousNonComment->is(TT_CtorInitializerColon) &&
805 Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon)
806 return State.Stack.back().Indent;
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +0000807 if (NextNonComment->isOneOf(TT_CtorInitializerColon, TT_InheritanceColon,
808 TT_InheritanceComma))
809 return State.FirstIndent + Style.ConstructorInitializerIndentWidth;
Daniel Jasper316ab382014-08-06 13:14:58 +0000810 if (Previous.is(tok::r_paren) && !Current.isBinaryOperator() &&
Daniel Jasper119ff532014-11-14 12:31:14 +0000811 !Current.isOneOf(tok::colon, tok::comment))
Daniel Jasper316ab382014-08-06 13:14:58 +0000812 return ContinuationIndent;
Daniel Jasper5d2587d2014-03-27 16:14:13 +0000813 if (State.Stack.back().Indent == State.FirstIndent && PreviousNonComment &&
Daniel Jasper9f388d02014-03-27 14:33:30 +0000814 PreviousNonComment->isNot(tok::r_brace))
815 // Ensure that we fall back to the continuation indent width instead of
816 // just flushing continuations left.
817 return State.Stack.back().Indent + Style.ContinuationIndentWidth;
818 return State.Stack.back().Indent;
819}
820
Daniel Jasperde0328a2013-08-16 11:20:30 +0000821unsigned ContinuationIndenter::moveStateToNextToken(LineState &State,
822 bool DryRun, bool Newline) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000823 assert(State.Stack.size());
Daniel Jasper60553be2014-05-26 13:10:39 +0000824 const FormatToken &Current = *State.NextToken;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000825
Daniel Jasper240527c2017-01-16 13:13:15 +0000826 if (Current.isOneOf(tok::comma, TT_BinaryOperator))
827 State.Stack.back().NoLineBreakInOperand = false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000828 if (Current.is(TT_InheritanceColon))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000829 State.Stack.back().AvoidBinPacking = true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000830 if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator)) {
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000831 if (State.Stack.back().FirstLessLess == 0)
832 State.Stack.back().FirstLessLess = State.Column;
833 else
834 State.Stack.back().LastOperatorWrapped = Newline;
835 }
Daniel Jasper240527c2017-01-16 13:13:15 +0000836 if (Current.is(TT_BinaryOperator) && Current.isNot(tok::lessless))
837 State.Stack.back().LastOperatorWrapped = Newline;
838 if (Current.is(TT_ConditionalExpr) && Current.Previous &&
839 !Current.Previous->is(TT_ConditionalExpr))
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000840 State.Stack.back().LastOperatorWrapped = Newline;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000841 if (Current.is(TT_ArraySubscriptLSquare) &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000842 State.Stack.back().StartOfArraySubscripts == 0)
843 State.Stack.back().StartOfArraySubscripts = State.Column;
Daniel Jasper45860fa2016-02-03 17:27:10 +0000844 if (Style.BreakBeforeTernaryOperators && Current.is(tok::question))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000845 State.Stack.back().QuestionColumn = State.Column;
Daniel Jasper45860fa2016-02-03 17:27:10 +0000846 if (!Style.BreakBeforeTernaryOperators && Current.isNot(tok::colon)) {
847 const FormatToken *Previous = Current.Previous;
848 while (Previous && Previous->isTrailingComment())
849 Previous = Previous->Previous;
850 if (Previous && Previous->is(tok::question))
851 State.Stack.back().QuestionColumn = State.Column;
852 }
Daniel Jaspercab46172017-04-24 14:28:49 +0000853 if (!Current.opensScope() && !Current.closesScope() &&
854 !Current.is(TT_PointerOrReference))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000855 State.LowestLevelOnLine =
Daniel Jasper05cd5862014-05-08 12:21:30 +0000856 std::min(State.LowestLevelOnLine, Current.NestingLevel);
Daniel Jasper4c6e0052013-08-27 14:24:43 +0000857 if (Current.isMemberAccess())
Daniel Jasperde0328a2013-08-16 11:20:30 +0000858 State.Stack.back().StartOfFunctionCall =
Daniel Jasper00492f92016-01-05 13:03:50 +0000859 !Current.NextOperator ? 0 : State.Column;
Daniel Jasper3c44c222015-07-16 22:58:24 +0000860 if (Current.is(TT_SelectorName)) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000861 State.Stack.back().ObjCSelectorNameFound = true;
Daniel Jasper3c44c222015-07-16 22:58:24 +0000862 if (Style.IndentWrappedFunctionNames) {
863 State.Stack.back().Indent =
864 State.FirstIndent + Style.ContinuationIndentWidth;
865 }
866 }
Francois Ferranda6b6d512017-05-24 11:36:58 +0000867 if (Current.is(TT_CtorInitializerColon) &&
868 Style.BreakConstructorInitializers != FormatStyle::BCIS_AfterColon) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000869 // Indent 2 from the column, so:
870 // SomeClass::SomeClass()
871 // : First(...), ...
872 // Next(...)
873 // ^ line up here.
874 State.Stack.back().Indent =
Francois Ferranda6b6d512017-05-24 11:36:58 +0000875 State.Column + (Style.BreakConstructorInitializers ==
876 FormatStyle::BCIS_BeforeComma ? 0 : 2);
Daniel Jasperd6a1cab2015-01-12 10:23:24 +0000877 State.Stack.back().NestedBlockIndent = State.Stack.back().Indent;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000878 if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
879 State.Stack.back().AvoidBinPacking = true;
880 State.Stack.back().BreakBeforeParameter = false;
881 }
Francois Ferranda6b6d512017-05-24 11:36:58 +0000882 if (Current.is(TT_CtorInitializerColon) &&
883 Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon) {
884 State.Stack.back().Indent =
885 State.FirstIndent + Style.ConstructorInitializerIndentWidth;
886 State.Stack.back().NestedBlockIndent = State.Stack.back().Indent;
887 if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
888 State.Stack.back().AvoidBinPacking = true;
889 }
Andi-Bogdan Postelnicu0ef8ee12017-03-10 15:10:37 +0000890 if (Current.is(TT_InheritanceColon))
891 State.Stack.back().Indent =
892 State.FirstIndent + Style.ContinuationIndentWidth;
Daniel Jasperc4144ea2015-05-13 16:09:21 +0000893 if (Current.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) && Newline)
894 State.Stack.back().NestedBlockIndent =
895 State.Column + Current.ColumnWidth + 1;
Daniel Jasperd9b319e2017-02-20 12:43:48 +0000896 if (Current.isOneOf(TT_LambdaLSquare, TT_LambdaArrow))
897 State.Stack.back().LastSpace = State.Column;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000898
Daniel Jasperde0328a2013-08-16 11:20:30 +0000899 // Insert scopes created by fake parenthesis.
900 const FormatToken *Previous = Current.getPreviousNonComment();
Daniel Jasperb16b9692014-05-21 12:51:23 +0000901
902 // Add special behavior to support a format commonly used for JavaScript
903 // closures:
904 // SomeFunction(function() {
905 // foo();
906 // bar();
907 // }, a, b, c);
Daniel Jasperb2ad4d42015-06-15 09:23:17 +0000908 if (Current.isNot(tok::comment) && Previous &&
909 Previous->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) &&
Daniel Jasperccff4d12016-01-04 07:27:33 +0000910 !Previous->is(TT_DictLiteral) && State.Stack.size() > 1) {
Daniel Jasper1699eca2015-06-01 09:56:32 +0000911 if (State.Stack[State.Stack.size() - 2].NestedBlockInlined && Newline)
912 for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i)
Daniel Jasper4b444492014-11-21 13:38:53 +0000913 State.Stack[i].NoLineBreak = true;
Daniel Jasper4b444492014-11-21 13:38:53 +0000914 State.Stack[State.Stack.size() - 2].NestedBlockInlined = false;
915 }
916 if (Previous && (Previous->isOneOf(tok::l_paren, tok::comma, tok::colon) ||
917 Previous->isOneOf(TT_BinaryOperator, TT_ConditionalExpr)) &&
918 !Previous->isOneOf(TT_DictLiteral, TT_ObjCMethodExpr)) {
919 State.Stack.back().NestedBlockInlined =
920 !Newline &&
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000921 (Previous->isNot(tok::l_paren) || Previous->ParameterCount > 1);
Daniel Jasperb16b9692014-05-21 12:51:23 +0000922 }
923
Daniel Jasper60553be2014-05-26 13:10:39 +0000924 moveStatePastFakeLParens(State, Newline);
Daniel Jasper60553be2014-05-26 13:10:39 +0000925 moveStatePastScopeCloser(State);
Krasimir Georgievbc05eba2017-03-08 12:54:50 +0000926 bool CanBreakProtrudingToken = !State.Stack.back().NoLineBreak &&
927 !State.Stack.back().NoLineBreakInOperand;
Daniel Jasperc06f6da2017-02-03 14:32:38 +0000928 moveStatePastScopeOpener(State, Newline);
Daniel Jasper60553be2014-05-26 13:10:39 +0000929 moveStatePastFakeRParens(State);
930
Daniel Jasper09285532015-05-17 08:13:23 +0000931 if (Current.is(TT_ObjCStringLiteral) && State.StartOfStringLiteral == 0)
932 State.StartOfStringLiteral = State.Column + 1;
Alexander Kornienkod4fa2e62017-04-11 09:55:00 +0000933 else if (Current.isStringLiteral() && State.StartOfStringLiteral == 0)
934 State.StartOfStringLiteral = State.Column;
Daniel Jasper09285532015-05-17 08:13:23 +0000935 else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash) &&
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +0000936 !Current.isStringLiteral())
Daniel Jasper60553be2014-05-26 13:10:39 +0000937 State.StartOfStringLiteral = 0;
Daniel Jasper60553be2014-05-26 13:10:39 +0000938
939 State.Column += Current.ColumnWidth;
940 State.NextToken = State.NextToken->Next;
Krasimir Georgievbc05eba2017-03-08 12:54:50 +0000941 unsigned Penalty = 0;
942 if (CanBreakProtrudingToken)
943 Penalty = breakProtrudingToken(Current, State, DryRun);
Daniel Jasper60553be2014-05-26 13:10:39 +0000944 if (State.Column > getColumnLimit(State)) {
945 unsigned ExcessCharacters = State.Column - getColumnLimit(State);
946 Penalty += Style.PenaltyExcessCharacter * ExcessCharacters;
947 }
948
949 if (Current.Role)
950 Current.Role->formatFromToken(State, this, DryRun);
951 // If the previous has a special role, let it consume tokens as appropriate.
952 // It is necessary to start at the previous token for the only implemented
953 // role (comma separated list). That way, the decision whether or not to break
954 // after the "{" is already done and both options are tried and evaluated.
955 // FIXME: This is ugly, find a better way.
956 if (Previous && Previous->Role)
957 Penalty += Previous->Role->formatAfterToken(State, this, DryRun);
958
959 return Penalty;
960}
961
962void ContinuationIndenter::moveStatePastFakeLParens(LineState &State,
963 bool Newline) {
964 const FormatToken &Current = *State.NextToken;
965 const FormatToken *Previous = Current.getPreviousNonComment();
966
Daniel Jasperde0328a2013-08-16 11:20:30 +0000967 // Don't add extra indentation for the first fake parenthesis after
Dinesh Dwivedi0db806b2014-05-01 17:19:34 +0000968 // 'return', assignments or opening <({[. The indentation for these cases
Daniel Jasperde0328a2013-08-16 11:20:30 +0000969 // is special cased.
970 bool SkipFirstExtraIndent =
Daniel Jasper98f8ae32015-03-06 10:57:12 +0000971 (Previous && (Previous->opensScope() ||
972 Previous->isOneOf(tok::semi, tok::kw_return) ||
Daniel Jasper3219e432014-12-02 13:24:51 +0000973 (Previous->getPrecedence() == prec::Assignment &&
974 Style.AlignOperands) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000975 Previous->is(TT_ObjCMethodExpr)));
Daniel Jasperde0328a2013-08-16 11:20:30 +0000976 for (SmallVectorImpl<prec::Level>::const_reverse_iterator
977 I = Current.FakeLParens.rbegin(),
978 E = Current.FakeLParens.rend();
979 I != E; ++I) {
980 ParenState NewParenState = State.Stack.back();
981 NewParenState.ContainsLineBreak = false;
Daniel Jasper04bbda92017-03-16 07:54:11 +0000982 NewParenState.LastOperatorWrapped = true;
Daniel Jasper240527c2017-01-16 13:13:15 +0000983 NewParenState.NoLineBreak =
984 NewParenState.NoLineBreak || State.Stack.back().NoLineBreakInOperand;
Daniel Jaspereabede62013-09-30 08:29:03 +0000985
Daniel Jasper988e7e42017-05-08 15:07:52 +0000986 // Don't propagate AvoidBinPacking into subexpressions of arg/param lists.
987 if (*I > prec::Comma)
988 NewParenState.AvoidBinPacking = false;
989
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000990 // Indent from 'LastSpace' unless these are fake parentheses encapsulating
991 // a builder type call after 'return' or, if the alignment after opening
992 // brackets is disabled.
Daniel Jasper4281c5a2014-10-07 14:45:34 +0000993 if (!Current.isTrailingComment() &&
Daniel Jasper3219e432014-12-02 13:24:51 +0000994 (Style.AlignOperands || *I < prec::Assignment) &&
Daniel Jasper6cab6782014-11-20 09:54:49 +0000995 (!Previous || Previous->isNot(tok::kw_return) ||
996 (Style.Language != FormatStyle::LK_Java && *I > 0)) &&
Daniel Jasper6501f7e2015-10-27 12:38:37 +0000997 (Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign ||
998 *I != prec::Comma || Current.NestingLevel == 0))
Daniel Jaspereabede62013-09-30 08:29:03 +0000999 NewParenState.Indent =
1000 std::max(std::max(State.Column, NewParenState.Indent),
1001 State.Stack.back().LastSpace);
1002
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001003 // Do not indent relative to the fake parentheses inserted for "." or "->".
1004 // This is a special case to make the following to statements consistent:
1005 // OuterFunction(InnerFunctionCall( // break
1006 // ParameterToInnerFunction));
1007 // OuterFunction(SomeObject.InnerFunctionCall( // break
1008 // ParameterToInnerFunction));
1009 if (*I > prec::Unknown)
1010 NewParenState.LastSpace = std::max(NewParenState.LastSpace, State.Column);
Daniel Jasper2a9f7202016-02-08 09:52:54 +00001011 if (*I != prec::Conditional && !Current.is(TT_UnaryOperator) &&
1012 Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign)
Daniel Jaspera536df42014-12-08 21:28:31 +00001013 NewParenState.StartOfFunctionCall = State.Column;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001014
1015 // Always indent conditional expressions. Never indent expression where
1016 // the 'operator' is ',', ';' or an assignment (i.e. *I <=
1017 // prec::Assignment) as those have different indentation rules. Indent
1018 // other expression, unless the indentation needs to be skipped.
1019 if (*I == prec::Conditional ||
1020 (!SkipFirstExtraIndent && *I > prec::Assignment &&
Daniel Jasper8c6e9ef2014-12-02 09:46:56 +00001021 !Current.isTrailingComment()))
Daniel Jasper6633ab82013-10-18 10:38:14 +00001022 NewParenState.Indent += Style.ContinuationIndentWidth;
Daniel Jasper7bec87c2016-01-07 18:11:54 +00001023 if ((Previous && !Previous->opensScope()) || *I != prec::Comma)
Daniel Jasperde0328a2013-08-16 11:20:30 +00001024 NewParenState.BreakBeforeParameter = false;
1025 State.Stack.push_back(NewParenState);
1026 SkipFirstExtraIndent = false;
1027 }
Daniel Jasper60553be2014-05-26 13:10:39 +00001028}
Daniel Jasperde0328a2013-08-16 11:20:30 +00001029
Daniel Jasper11a0ac62014-12-12 09:40:58 +00001030void ContinuationIndenter::moveStatePastFakeRParens(LineState &State) {
1031 for (unsigned i = 0, e = State.NextToken->FakeRParens; i != e; ++i) {
Daniel Jasper335ff262014-05-28 09:11:53 +00001032 unsigned VariablePos = State.Stack.back().VariablePos;
Daniel Jasper335ff262014-05-28 09:11:53 +00001033 if (State.Stack.size() == 1) {
1034 // Do not pop the last element.
1035 break;
1036 }
1037 State.Stack.pop_back();
1038 State.Stack.back().VariablePos = VariablePos;
1039 }
1040}
1041
Daniel Jasper60553be2014-05-26 13:10:39 +00001042void ContinuationIndenter::moveStatePastScopeOpener(LineState &State,
1043 bool Newline) {
1044 const FormatToken &Current = *State.NextToken;
1045 if (!Current.opensScope())
1046 return;
1047
1048 if (Current.MatchingParen && Current.BlockKind == BK_Block) {
1049 moveStateToNewBlock(State);
1050 return;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001051 }
1052
Daniel Jasper60553be2014-05-26 13:10:39 +00001053 unsigned NewIndent;
Daniel Jasperde7ca752015-05-04 07:39:00 +00001054 unsigned LastSpace = State.Stack.back().LastSpace;
Daniel Jasper60553be2014-05-26 13:10:39 +00001055 bool AvoidBinPacking;
1056 bool BreakBeforeParameter = false;
Daniel Jasperea40cee2015-07-14 11:26:14 +00001057 unsigned NestedBlockIndent = std::max(State.Stack.back().StartOfFunctionCall,
1058 State.Stack.back().NestedBlockIndent);
Krasimir Georgievff747be2017-06-27 13:43:07 +00001059 if (Current.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) ||
Krasimir Georgiev26b144c2017-07-03 15:05:14 +00001060 opensProtoMessageField(Current, Style)) {
Daniel Jasperbd73bcf2015-10-27 13:42:08 +00001061 if (Current.opensBlockOrBlockTypeList(Style)) {
Martin Probst38423272017-06-06 12:38:29 +00001062 NewIndent = Style.IndentWidth +
1063 std::min(State.Column, State.Stack.back().NestedBlockIndent);
Daniel Jasper60553be2014-05-26 13:10:39 +00001064 } else {
Daniel Jasper11a0ac62014-12-12 09:40:58 +00001065 NewIndent = State.Stack.back().LastSpace + Style.ContinuationIndentWidth;
Daniel Jasper60553be2014-05-26 13:10:39 +00001066 }
1067 const FormatToken *NextNoComment = Current.getNextNonComment();
Daniel Jasper50780ce2016-01-13 16:41:34 +00001068 bool EndsInComma = Current.MatchingParen &&
1069 Current.MatchingParen->Previous &&
1070 Current.MatchingParen->Previous->is(tok::comma);
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001071 AvoidBinPacking =
Francois Ferrandd2130f52017-06-30 20:00:02 +00001072 EndsInComma || Current.is(TT_DictLiteral) ||
Krasimir Georgiev26b144c2017-07-03 15:05:14 +00001073 Style.Language == FormatStyle::LK_Proto ||
1074 Style.Language == FormatStyle::LK_TextProto ||
1075 !Style.BinPackArguments ||
Francois Ferrand5f07f442017-06-19 14:41:21 +00001076 (NextNoComment &&
1077 NextNoComment->isOneOf(TT_DesignatedInitializerPeriod,
1078 TT_DesignatedInitializerLSquare));
Francois Ferrandd2130f52017-06-30 20:00:02 +00001079 BreakBeforeParameter = EndsInComma;
Daniel Jasperea40cee2015-07-14 11:26:14 +00001080 if (Current.ParameterCount > 1)
1081 NestedBlockIndent = std::max(NestedBlockIndent, State.Column + 1);
Daniel Jasper60553be2014-05-26 13:10:39 +00001082 } else {
1083 NewIndent = Style.ContinuationIndentWidth +
1084 std::max(State.Stack.back().LastSpace,
1085 State.Stack.back().StartOfFunctionCall);
Daniel Jasperde7ca752015-05-04 07:39:00 +00001086
1087 // Ensure that different different brackets force relative alignment, e.g.:
1088 // void SomeFunction(vector< // break
1089 // int> v);
1090 // FIXME: We likely want to do this for more combinations of brackets.
1091 // Verify that it is wanted for ObjC, too.
Daniel Jasper3f119412017-01-31 14:39:33 +00001092 if (Current.is(tok::less) && Current.ParentBracket == tok::l_paren) {
Daniel Jasperde7ca752015-05-04 07:39:00 +00001093 NewIndent = std::max(NewIndent, State.Stack.back().Indent);
1094 LastSpace = std::max(LastSpace, State.Stack.back().Indent);
1095 }
1096
Martin Probst2c1cdae2017-05-15 11:15:29 +00001097 bool EndsInComma =
1098 Current.MatchingParen &&
1099 Current.MatchingParen->getPreviousNonComment() &&
1100 Current.MatchingParen->getPreviousNonComment()->is(tok::comma);
1101
Daniel Jasper18210d72014-10-09 09:52:05 +00001102 AvoidBinPacking =
Martin Probst2c1cdae2017-05-15 11:15:29 +00001103 (Style.Language == FormatStyle::LK_JavaScript && EndsInComma) ||
Daniel Jasper18210d72014-10-09 09:52:05 +00001104 (State.Line->MustBeDeclaration && !Style.BinPackParameters) ||
1105 (!State.Line->MustBeDeclaration && !Style.BinPackArguments) ||
1106 (Style.ExperimentalAutoDetectBinPacking &&
1107 (Current.PackingKind == PPK_OnePerLine ||
1108 (!BinPackInconclusiveFunctions &&
1109 Current.PackingKind == PPK_Inconclusive)));
Martin Probst2c1cdae2017-05-15 11:15:29 +00001110
Daniel Jasper289afc02015-04-23 09:23:17 +00001111 if (Current.is(TT_ObjCMethodExpr) && Current.MatchingParen) {
1112 if (Style.ColumnLimit) {
1113 // If this '[' opens an ObjC call, determine whether all parameters fit
1114 // into one line and put one per line if they don't.
1115 if (getLengthToMatchingParen(Current) + State.Column >
Daniel Jasper60553be2014-05-26 13:10:39 +00001116 getColumnLimit(State))
Daniel Jasper289afc02015-04-23 09:23:17 +00001117 BreakBeforeParameter = true;
1118 } else {
1119 // For ColumnLimit = 0, we have to figure out whether there is or has to
1120 // be a line break within this call.
1121 for (const FormatToken *Tok = &Current;
1122 Tok && Tok != Current.MatchingParen; Tok = Tok->Next) {
Daniel Jaspere6fcf7d2015-06-17 13:08:06 +00001123 if (Tok->MustBreakBefore ||
Daniel Jasper289afc02015-04-23 09:23:17 +00001124 (Tok->CanBreakBefore && Tok->NewlinesBefore > 0)) {
1125 BreakBeforeParameter = true;
1126 break;
1127 }
1128 }
1129 }
1130 }
Martin Probst2c1cdae2017-05-15 11:15:29 +00001131
1132 if (Style.Language == FormatStyle::LK_JavaScript && EndsInComma)
1133 BreakBeforeParameter = true;
Daniel Jasper60553be2014-05-26 13:10:39 +00001134 }
Daniel Jasperbd73bcf2015-10-27 13:42:08 +00001135 // Generally inherit NoLineBreak from the current scope to nested scope.
1136 // However, don't do this for non-empty nested blocks, dict literals and
1137 // array literals as these follow different indentation rules.
1138 bool NoLineBreak =
1139 Current.Children.empty() &&
1140 !Current.isOneOf(TT_DictLiteral, TT_ArrayInitializerLSquare) &&
1141 (State.Stack.back().NoLineBreak ||
Daniel Jasper240527c2017-01-16 13:13:15 +00001142 State.Stack.back().NoLineBreakInOperand ||
Daniel Jasperbd73bcf2015-10-27 13:42:08 +00001143 (Current.is(TT_TemplateOpener) &&
Daniel Jasper240527c2017-01-16 13:13:15 +00001144 State.Stack.back().ContainsUnwrappedBuilder));
Daniel Jasper7d42f3f2017-01-31 11:25:01 +00001145 State.Stack.push_back(
1146 ParenState(NewIndent, LastSpace, AvoidBinPacking, NoLineBreak));
Daniel Jasper11a0ac62014-12-12 09:40:58 +00001147 State.Stack.back().NestedBlockIndent = NestedBlockIndent;
Daniel Jasper60553be2014-05-26 13:10:39 +00001148 State.Stack.back().BreakBeforeParameter = BreakBeforeParameter;
Daniel Jasper114a2bc2014-06-03 12:02:45 +00001149 State.Stack.back().HasMultipleNestedBlocks = Current.BlockParameterCount > 1;
Daniel Jasper60553be2014-05-26 13:10:39 +00001150}
1151
1152void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) {
1153 const FormatToken &Current = *State.NextToken;
1154 if (!Current.closesScope())
1155 return;
1156
1157 // If we encounter a closing ), ], } or >, we can remove a level from our
1158 // stacks.
1159 if (State.Stack.size() > 1 &&
Daniel Jasperc06f6da2017-02-03 14:32:38 +00001160 (Current.isOneOf(tok::r_paren, tok::r_square, TT_TemplateString) ||
Daniel Jasper60553be2014-05-26 13:10:39 +00001161 (Current.is(tok::r_brace) && State.NextToken != State.Line->First) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001162 State.NextToken->is(TT_TemplateCloser)))
Daniel Jasper60553be2014-05-26 13:10:39 +00001163 State.Stack.pop_back();
Daniel Jasper335ff262014-05-28 09:11:53 +00001164
Daniel Jasper60553be2014-05-26 13:10:39 +00001165 if (Current.is(tok::r_square)) {
1166 // If this ends the array subscript expr, reset the corresponding value.
1167 const FormatToken *NextNonComment = Current.getNextNonComment();
1168 if (NextNonComment && NextNonComment->isNot(tok::l_square))
1169 State.Stack.back().StartOfArraySubscripts = 0;
1170 }
1171}
1172
1173void ContinuationIndenter::moveStateToNewBlock(LineState &State) {
Daniel Jasper11a0ac62014-12-12 09:40:58 +00001174 unsigned NestedBlockIndent = State.Stack.back().NestedBlockIndent;
Daniel Jasper50d634b2014-10-28 16:53:38 +00001175 // ObjC block sometimes follow special indentation rules.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001176 unsigned NewIndent =
Daniel Jasper11a0ac62014-12-12 09:40:58 +00001177 NestedBlockIndent + (State.NextToken->is(TT_ObjCBlockLBrace)
1178 ? Style.ObjCBlockIndentWidth
1179 : Style.IndentWidth);
Daniel Jasper7d42f3f2017-01-31 11:25:01 +00001180 State.Stack.push_back(ParenState(NewIndent, State.Stack.back().LastSpace,
1181 /*AvoidBinPacking=*/true,
1182 /*NoLineBreak=*/false));
Daniel Jasper11a0ac62014-12-12 09:40:58 +00001183 State.Stack.back().NestedBlockIndent = NestedBlockIndent;
Daniel Jasper60553be2014-05-26 13:10:39 +00001184 State.Stack.back().BreakBeforeParameter = true;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001185}
1186
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001187unsigned ContinuationIndenter::addMultilineToken(const FormatToken &Current,
1188 LineState &State) {
Daniel Jasperacadc8e2016-06-08 09:45:08 +00001189 if (!Current.IsMultiline)
1190 return 0;
1191
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001192 // Break before further function parameters on all levels.
1193 for (unsigned i = 0, e = State.Stack.size(); i != e; ++i)
1194 State.Stack[i].BreakBeforeParameter = true;
1195
Alexander Kornienko39856b72013-09-10 09:38:25 +00001196 unsigned ColumnsUsed = State.Column;
Alexander Kornienko632abb92013-09-02 13:58:14 +00001197 // We can only affect layout of the first and the last line, so the penalty
1198 // for all other lines is constant, and we ignore it.
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +00001199 State.Column = Current.LastLineColumnWidth;
Alexander Kornienko632abb92013-09-02 13:58:14 +00001200
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001201 if (ColumnsUsed > getColumnLimit(State))
1202 return Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit(State));
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001203 return 0;
1204}
1205
Daniel Jasperde0328a2013-08-16 11:20:30 +00001206unsigned ContinuationIndenter::breakProtrudingToken(const FormatToken &Current,
1207 LineState &State,
1208 bool DryRun) {
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001209 // Don't break multi-line tokens other than block comments. Instead, just
1210 // update the state.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001211 if (Current.isNot(TT_BlockComment) && Current.IsMultiline)
Alexander Kornienko917f9e02013-09-10 12:29:48 +00001212 return addMultilineToken(Current, State);
1213
Daniel Jasper616de8642014-11-23 16:46:28 +00001214 // Don't break implicit string literals or import statements.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001215 if (Current.is(TT_ImplicitStringLiteral) ||
Daniel Jasper616de8642014-11-23 16:46:28 +00001216 State.Line->Type == LT_ImportStatement)
Daniel Jasper98857842013-10-30 13:54:53 +00001217 return 0;
1218
Daniel Jasper04b6a082013-12-20 06:22:01 +00001219 if (!Current.isStringLiteral() && !Current.is(tok::comment))
Daniel Jasperf93551c2013-08-23 10:05:49 +00001220 return 0;
1221
Ahmed Charlesb8984322014-03-07 20:03:18 +00001222 std::unique_ptr<BreakableToken> Token;
Alexander Kornienko39856b72013-09-10 09:38:25 +00001223 unsigned StartColumn = State.Column - Current.ColumnWidth;
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +00001224 unsigned ColumnLimit = getColumnLimit(State);
Daniel Jasperde0328a2013-08-16 11:20:30 +00001225
Daniel Jasper04b6a082013-12-20 06:22:01 +00001226 if (Current.isStringLiteral()) {
Daniel Jasper428f0b12015-01-04 09:11:17 +00001227 // FIXME: String literal breaking is currently disabled for Java and JS, as
1228 // it requires strings to be merged using "+" which we don't support.
1229 if (Style.Language == FormatStyle::LK_Java ||
Daniel Jaspere1a7b762016-02-01 11:21:02 +00001230 Style.Language == FormatStyle::LK_JavaScript ||
1231 !Style.BreakStringLiterals)
Daniel Jasper428f0b12015-01-04 09:11:17 +00001232 return 0;
1233
Alexander Kornienko384b40b2013-10-11 21:43:05 +00001234 // Don't break string literals inside preprocessor directives (except for
1235 // #define directives, as their contents are stored in separate lines and
1236 // are not affected by this check).
1237 // This way we avoid breaking code with line directives and unknown
1238 // preprocessor directives that contain long string literals.
1239 if (State.Line->Type == LT_PreprocessorDirective)
1240 return 0;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001241 // Exempts unterminated string literals from line breaking. The user will
1242 // likely want to terminate the string before any line breaking is done.
1243 if (Current.IsUnterminatedLiteral)
1244 return 0;
1245
Alexander Kornienko81e32942013-09-16 20:20:49 +00001246 StringRef Text = Current.TokenText;
1247 StringRef Prefix;
1248 StringRef Postfix;
1249 // FIXME: Handle whitespace between '_T', '(', '"..."', and ')'.
1250 // FIXME: Store Prefix and Suffix (or PrefixLength and SuffixLength to
1251 // reduce the overhead) for each FormatToken, which is a string, so that we
1252 // don't run multiple checks here on the hot path.
1253 if ((Text.endswith(Postfix = "\"") &&
Alexander Kornienkod4fa2e62017-04-11 09:55:00 +00001254 (Text.startswith(Prefix = "@\"") || Text.startswith(Prefix = "\"") ||
Daniel Jasper174b0122014-01-09 14:18:12 +00001255 Text.startswith(Prefix = "u\"") || Text.startswith(Prefix = "U\"") ||
1256 Text.startswith(Prefix = "u8\"") ||
Alexander Kornienko81e32942013-09-16 20:20:49 +00001257 Text.startswith(Prefix = "L\""))) ||
Alexander Kornienko732b6bd2014-12-14 20:47:11 +00001258 (Text.startswith(Prefix = "_T(\"") && Text.endswith(Postfix = "\")"))) {
Daniel Jasper7d42f3f2017-01-31 11:25:01 +00001259 Token.reset(new BreakableStringLiteral(Current, StartColumn, Prefix,
1260 Postfix, State.Line->InPPDirective,
1261 Encoding, Style));
Alexander Kornienko81e32942013-09-16 20:20:49 +00001262 } else {
1263 return 0;
1264 }
Daniel Jasperacadc8e2016-06-08 09:45:08 +00001265 } else if (Current.is(TT_BlockComment)) {
Krasimir Georgievc602af92017-08-24 08:55:07 +00001266 if (!Current.isTrailingComment() || !Style.ReflowComments ||
Krasimir Georgiev91834222017-01-25 13:58:58 +00001267 // If a comment token switches formatting, like
1268 // /* clang-format on */, we don't want to break it further,
1269 // but we may still want to adjust its indentation.
1270 switchesFormatting(Current))
Daniel Jasperacadc8e2016-06-08 09:45:08 +00001271 return addMultilineToken(Current, State);
Daniel Jasperde0328a2013-08-16 11:20:30 +00001272 Token.reset(new BreakableBlockComment(
Daniel Jasper7d42f3f2017-01-31 11:25:01 +00001273 Current, StartColumn, Current.OriginalColumn, !Current.Previous,
1274 State.Line->InPPDirective, Encoding, Style));
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001275 } else if (Current.is(TT_LineComment) &&
Craig Topper2145bc02014-05-09 08:15:10 +00001276 (Current.Previous == nullptr ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001277 Current.Previous->isNot(TT_ImplicitStringLiteral))) {
Daniel Jaspera0a50392015-12-01 13:28:53 +00001278 if (!Style.ReflowComments ||
Krasimir Georgiev91834222017-01-25 13:58:58 +00001279 CommentPragmasRegex.match(Current.TokenText.substr(2)) ||
1280 switchesFormatting(Current))
Alexander Kornienkoce9161a2014-01-02 15:13:14 +00001281 return 0;
Krasimir Georgiev91834222017-01-25 13:58:58 +00001282 Token.reset(new BreakableLineCommentSection(
Daniel Jasper7d42f3f2017-01-31 11:25:01 +00001283 Current, StartColumn, Current.OriginalColumn, !Current.Previous,
Krasimir Georgiev91834222017-01-25 13:58:58 +00001284 /*InPPDirective=*/false, Encoding, Style));
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +00001285 // We don't insert backslashes when breaking line comments.
1286 ColumnLimit = Style.ColumnLimit;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001287 } else {
1288 return 0;
1289 }
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +00001290 if (Current.UnbreakableTailLength >= ColumnLimit)
Daniel Jasperde0328a2013-08-16 11:20:30 +00001291 return 0;
1292
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +00001293 unsigned RemainingSpace = ColumnLimit - Current.UnbreakableTailLength;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001294 bool BreakInserted = false;
Krasimir Georgiev91834222017-01-25 13:58:58 +00001295 // We use a conservative reflowing strategy. Reflow starts after a line is
1296 // broken or the corresponding whitespace compressed. Reflow ends as soon as a
1297 // line that doesn't get reflown with the previous line is reached.
1298 bool ReflowInProgress = false;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001299 unsigned Penalty = 0;
1300 unsigned RemainingTokenColumns = 0;
Krasimir Georgiev22d7e6b2017-07-20 22:29:39 +00001301 unsigned TailOffset = 0;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001302 for (unsigned LineIndex = 0, EndIndex = Token->getLineCount();
1303 LineIndex != EndIndex; ++LineIndex) {
Krasimir Georgiev91834222017-01-25 13:58:58 +00001304 BreakableToken::Split SplitBefore(StringRef::npos, 0);
1305 if (ReflowInProgress) {
1306 SplitBefore = Token->getSplitBefore(LineIndex, RemainingTokenColumns,
Krasimir Georgiev00c5c722017-02-02 15:32:19 +00001307 RemainingSpace, CommentPragmasRegex);
Krasimir Georgiev91834222017-01-25 13:58:58 +00001308 }
1309 ReflowInProgress = SplitBefore.first != StringRef::npos;
Krasimir Georgiev22d7e6b2017-07-20 22:29:39 +00001310 TailOffset =
Krasimir Georgiev91834222017-01-25 13:58:58 +00001311 ReflowInProgress ? (SplitBefore.first + SplitBefore.second) : 0;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001312 if (!DryRun)
Krasimir Georgiev91834222017-01-25 13:58:58 +00001313 Token->replaceWhitespaceBefore(LineIndex, RemainingTokenColumns,
1314 RemainingSpace, SplitBefore, Whitespaces);
1315 RemainingTokenColumns = Token->getLineLengthAfterSplitBefore(
1316 LineIndex, TailOffset, RemainingTokenColumns, ColumnLimit, SplitBefore);
Daniel Jasperde0328a2013-08-16 11:20:30 +00001317 while (RemainingTokenColumns > RemainingSpace) {
Krasimir Georgiev17725d82017-03-08 08:55:12 +00001318 BreakableToken::Split Split = Token->getSplit(
1319 LineIndex, TailOffset, ColumnLimit, CommentPragmasRegex);
Daniel Jasperde0328a2013-08-16 11:20:30 +00001320 if (Split.first == StringRef::npos) {
1321 // The last line's penalty is handled in addNextStateToQueue().
1322 if (LineIndex < EndIndex - 1)
1323 Penalty += Style.PenaltyExcessCharacter *
1324 (RemainingTokenColumns - RemainingSpace);
1325 break;
1326 }
1327 assert(Split.first != 0);
Alexander Kornienko875395f2013-11-12 17:50:13 +00001328
Krasimir Georgiev91834222017-01-25 13:58:58 +00001329 // Check if compressing the whitespace range will bring the line length
1330 // under the limit. If that is the case, we perform whitespace compression
1331 // instead of inserting a line break.
1332 unsigned RemainingTokenColumnsAfterCompression =
1333 Token->getLineLengthAfterCompression(RemainingTokenColumns, Split);
1334 if (RemainingTokenColumnsAfterCompression <= RemainingSpace) {
1335 RemainingTokenColumns = RemainingTokenColumnsAfterCompression;
1336 ReflowInProgress = true;
Alexander Kornienko875395f2013-11-12 17:50:13 +00001337 if (!DryRun)
Krasimir Georgiev91834222017-01-25 13:58:58 +00001338 Token->compressWhitespace(LineIndex, TailOffset, Split, Whitespaces);
Alexander Kornienko875395f2013-11-12 17:50:13 +00001339 break;
1340 }
1341
Krasimir Georgiev91834222017-01-25 13:58:58 +00001342 unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit(
1343 LineIndex, TailOffset + Split.first + Split.second, StringRef::npos);
1344
Alexander Kornienko64a42b82014-04-15 14:52:43 +00001345 // When breaking before a tab character, it may be moved by a few columns,
1346 // but will still be expanded to the next tab stop, so we don't save any
1347 // columns.
1348 if (NewRemainingTokenColumns == RemainingTokenColumns)
1349 break;
1350
Daniel Jasperde0328a2013-08-16 11:20:30 +00001351 assert(NewRemainingTokenColumns < RemainingTokenColumns);
1352 if (!DryRun)
1353 Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces);
Daniel Jasper2739af32013-08-28 10:03:58 +00001354 Penalty += Current.SplitPenalty;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001355 unsigned ColumnsUsed =
1356 Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first);
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +00001357 if (ColumnsUsed > ColumnLimit) {
1358 Penalty += Style.PenaltyExcessCharacter * (ColumnsUsed - ColumnLimit);
Daniel Jasperde0328a2013-08-16 11:20:30 +00001359 }
1360 TailOffset += Split.first + Split.second;
1361 RemainingTokenColumns = NewRemainingTokenColumns;
Krasimir Georgiev91834222017-01-25 13:58:58 +00001362 ReflowInProgress = true;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001363 BreakInserted = true;
1364 }
1365 }
1366
Krasimir Georgiev3b865342017-08-09 09:42:32 +00001367 BreakableToken::Split SplitAfterLastLine =
1368 Token->getSplitAfterLastLine(TailOffset, ColumnLimit);
Krasimir Georgiev22d7e6b2017-07-20 22:29:39 +00001369 if (SplitAfterLastLine.first != StringRef::npos) {
1370 if (!DryRun)
1371 Token->replaceWhitespaceAfterLastLine(TailOffset, SplitAfterLastLine,
1372 Whitespaces);
1373 RemainingTokenColumns = Token->getLineLengthAfterSplitAfterLastLine(
1374 TailOffset, SplitAfterLastLine);
1375 }
1376
Daniel Jasperde0328a2013-08-16 11:20:30 +00001377 State.Column = RemainingTokenColumns;
1378
1379 if (BreakInserted) {
1380 // If we break the token inside a parameter list, we need to break before
1381 // the next parameter on all levels, so that the next parameter is clearly
1382 // visible. Line comments already introduce a break.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001383 if (Current.isNot(TT_LineComment)) {
Daniel Jasperde0328a2013-08-16 11:20:30 +00001384 for (unsigned i = 0, e = State.Stack.size(); i != e; ++i)
1385 State.Stack[i].BreakBeforeParameter = true;
1386 }
1387
Daniel Jasper04b6a082013-12-20 06:22:01 +00001388 Penalty += Current.isStringLiteral() ? Style.PenaltyBreakString
1389 : Style.PenaltyBreakComment;
Daniel Jasper2739af32013-08-28 10:03:58 +00001390
Daniel Jasperde0328a2013-08-16 11:20:30 +00001391 State.Stack.back().LastSpace = StartColumn;
1392 }
Krasimir Georgiev91834222017-01-25 13:58:58 +00001393
1394 Token->updateNextToken(State);
1395
Daniel Jasperde0328a2013-08-16 11:20:30 +00001396 return Penalty;
1397}
1398
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001399unsigned ContinuationIndenter::getColumnLimit(const LineState &State) const {
Daniel Jasperde0328a2013-08-16 11:20:30 +00001400 // In preprocessor directives reserve two chars for trailing " \"
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001401 return Style.ColumnLimit - (State.Line->InPPDirective ? 2 : 0);
Daniel Jasperde0328a2013-08-16 11:20:30 +00001402}
1403
Daniel Jasperc39b56f2013-12-16 07:23:08 +00001404bool ContinuationIndenter::nextIsMultilineString(const LineState &State) {
Daniel Jasperf438cb72013-08-23 11:57:34 +00001405 const FormatToken &Current = *State.NextToken;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001406 if (!Current.isStringLiteral() || Current.is(TT_ImplicitStringLiteral))
Daniel Jasperf438cb72013-08-23 11:57:34 +00001407 return false;
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001408 // We never consider raw string literals "multiline" for the purpose of
Daniel Jasperc39b56f2013-12-16 07:23:08 +00001409 // AlwaysBreakBeforeMultilineStrings implementation as they are special-cased
1410 // (see TokenAnnotator::mustBreakBefore().
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001411 if (Current.TokenText.startswith("R\""))
1412 return false;
Alexander Kornienko39856b72013-09-10 09:38:25 +00001413 if (Current.IsMultiline)
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001414 return true;
Daniel Jasperf438cb72013-08-23 11:57:34 +00001415 if (Current.getNextNonComment() &&
Daniel Jasper04b6a082013-12-20 06:22:01 +00001416 Current.getNextNonComment()->isStringLiteral())
Daniel Jasperf438cb72013-08-23 11:57:34 +00001417 return true; // Implicit concatenation.
Daniel Jasper6fd5d642015-01-20 12:59:20 +00001418 if (Style.ColumnLimit != 0 &&
1419 State.Column + Current.ColumnWidth + Current.UnbreakableTailLength >
1420 Style.ColumnLimit)
Daniel Jasperf438cb72013-08-23 11:57:34 +00001421 return true; // String will be split.
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001422 return false;
Daniel Jasperf438cb72013-08-23 11:57:34 +00001423}
1424
Daniel Jasperde0328a2013-08-16 11:20:30 +00001425} // namespace format
1426} // namespace clang