blob: f05471e712dd6adb5dbfe1b053641a0d41899149 [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"
22#include <string>
23
Chandler Carruth10346662014-04-22 03:17:02 +000024#define DEBUG_TYPE "format-formatter"
25
Daniel Jasperde0328a2013-08-16 11:20:30 +000026namespace clang {
27namespace format {
28
29// Returns the length of everything up to the first possible line break after
30// the ), ], } or > matching \c Tok.
31static unsigned getLengthToMatchingParen(const FormatToken &Tok) {
Craig Topper2145bc02014-05-09 08:15:10 +000032 if (!Tok.MatchingParen)
Daniel Jasperde0328a2013-08-16 11:20:30 +000033 return 0;
34 FormatToken *End = Tok.MatchingParen;
35 while (End->Next && !End->Next->CanBreakBefore) {
36 End = End->Next;
37 }
38 return End->TotalLength - Tok.TotalLength + 1;
39}
40
Daniel Jasper4c6e0052013-08-27 14:24:43 +000041// Returns \c true if \c Tok is the "." or "->" of a call and starts the next
42// segment of a builder type call.
43static bool startsSegmentOfBuilderTypeCall(const FormatToken &Tok) {
44 return Tok.isMemberAccess() && Tok.Previous && Tok.Previous->closesScope();
45}
46
Daniel Jasperec01cd62013-10-08 05:11:18 +000047// Returns \c true if \c Current starts a new parameter.
48static bool startsNextParameter(const FormatToken &Current,
49 const FormatStyle &Style) {
50 const FormatToken &Previous = *Current.Previous;
Daniel Jaspera98b7b02014-11-25 10:05:17 +000051 if (Current.is(TT_CtorInitializerComma) &&
Daniel Jasperec01cd62013-10-08 05:11:18 +000052 Style.BreakConstructorInitializersBeforeComma)
53 return true;
54 return Previous.is(tok::comma) && !Current.isTrailingComment() &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +000055 (Previous.isNot(TT_CtorInitializerComma) ||
Daniel Jasperec01cd62013-10-08 05:11:18 +000056 !Style.BreakConstructorInitializersBeforeComma);
57}
58
Daniel Jasperde0328a2013-08-16 11:20:30 +000059ContinuationIndenter::ContinuationIndenter(const FormatStyle &Style,
Daniel Jasperd0ec0d62014-11-04 12:41:02 +000060 const AdditionalKeywords &Keywords,
Daniel Jasperde0328a2013-08-16 11:20:30 +000061 SourceManager &SourceMgr,
Daniel Jasperde0328a2013-08-16 11:20:30 +000062 WhitespaceManager &Whitespaces,
63 encoding::Encoding Encoding,
64 bool BinPackInconclusiveFunctions)
Daniel Jasperd0ec0d62014-11-04 12:41:02 +000065 : Style(Style), Keywords(Keywords), SourceMgr(SourceMgr),
66 Whitespaces(Whitespaces), Encoding(Encoding),
Alexander Kornienkoce9161a2014-01-02 15:13:14 +000067 BinPackInconclusiveFunctions(BinPackInconclusiveFunctions),
68 CommentPragmasRegex(Style.CommentPragmas) {}
Daniel Jasperde0328a2013-08-16 11:20:30 +000069
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +000070LineState ContinuationIndenter::getInitialState(unsigned FirstIndent,
Daniel Jasper1c5d9df2013-09-06 07:54:20 +000071 const AnnotatedLine *Line,
72 bool DryRun) {
Daniel Jasperde0328a2013-08-16 11:20:30 +000073 LineState State;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +000074 State.FirstIndent = FirstIndent;
Daniel Jasperde0328a2013-08-16 11:20:30 +000075 State.Column = FirstIndent;
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +000076 State.Line = Line;
77 State.NextToken = Line->First;
Alexander Kornienkoe2e03872013-10-14 00:46:35 +000078 State.Stack.push_back(ParenState(FirstIndent, Line->Level, FirstIndent,
Daniel Jasperde0328a2013-08-16 11:20:30 +000079 /*AvoidBinPacking=*/false,
80 /*NoLineBreak=*/false));
81 State.LineContainsContinuedForLoopSection = false;
Daniel Jasperde0328a2013-08-16 11:20:30 +000082 State.StartOfStringLiteral = 0;
Daniel Jasper05cd5862014-05-08 12:21:30 +000083 State.StartOfLineLevel = 0;
84 State.LowestLevelOnLine = 0;
Daniel Jasperde0328a2013-08-16 11:20:30 +000085 State.IgnoreStackForComparison = false;
86
87 // The first token has already been indented and thus consumed.
Daniel Jasper1c5d9df2013-09-06 07:54:20 +000088 moveStateToNextToken(State, DryRun, /*Newline=*/false);
Daniel Jasperde0328a2013-08-16 11:20:30 +000089 return State;
90}
91
92bool ContinuationIndenter::canBreak(const LineState &State) {
93 const FormatToken &Current = *State.NextToken;
94 const FormatToken &Previous = *Current.Previous;
95 assert(&Previous == Current.Previous);
Nico Weberbeb03932015-01-09 23:25:06 +000096 if (!Current.CanBreakBefore &&
97 !(State.Stack.back().BreakBeforeClosingBrace &&
98 Current.closesBlockTypeList(Style)))
Daniel Jasperde0328a2013-08-16 11:20:30 +000099 return false;
100 // The opening "{" of a braced list has to be on the same line as the first
101 // element if it is nested in another braced init list or function call.
102 if (!Current.MustBreakBefore && Previous.is(tok::l_brace) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000103 Previous.isNot(TT_DictLiteral) && Previous.BlockKind == BK_BracedInit &&
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000104 Previous.Previous &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000105 Previous.Previous->isOneOf(tok::l_brace, tok::l_paren, tok::comma))
106 return false;
107 // This prevents breaks like:
108 // ...
109 // SomeParameter, OtherParameter).DoSomething(
110 // ...
111 // As they hide "DoSomething" and are generally bad for readability.
Daniel Jasper8f59ae52014-03-11 11:03:26 +0000112 if (Previous.opensScope() && Previous.isNot(tok::l_brace) &&
Daniel Jasperfcfac102014-07-15 09:00:34 +0000113 State.LowestLevelOnLine < State.StartOfLineLevel &&
114 State.LowestLevelOnLine < Current.NestingLevel)
Daniel Jasperde0328a2013-08-16 11:20:30 +0000115 return false;
Daniel Jasper4c6e0052013-08-27 14:24:43 +0000116 if (Current.isMemberAccess() && State.Stack.back().ContainsUnwrappedBuilder)
117 return false;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000118
119 // Don't create a 'hanging' indent if there are multiple blocks in a single
120 // statement.
Daniel Jasper4b444492014-11-21 13:38:53 +0000121 if (Previous.is(tok::l_brace) && State.Stack.size() > 1 &&
122 State.Stack[State.Stack.size() - 2].NestedBlockInlined &&
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000123 State.Stack[State.Stack.size() - 2].HasMultipleNestedBlocks)
124 return false;
125
Daniel Jaspere068ac72014-10-27 17:13:59 +0000126 // Don't break after very short return types (e.g. "void") as that is often
127 // unexpected.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000128 if (Current.is(TT_FunctionDeclarationName) &&
Daniel Jaspere068ac72014-10-27 17:13:59 +0000129 !Style.AlwaysBreakAfterDefinitionReturnType && State.Column < 6)
130 return false;
131
Daniel Jasperde0328a2013-08-16 11:20:30 +0000132 return !State.Stack.back().NoLineBreak;
133}
134
135bool ContinuationIndenter::mustBreak(const LineState &State) {
136 const FormatToken &Current = *State.NextToken;
137 const FormatToken &Previous = *Current.Previous;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000138 if (Current.MustBreakBefore || Current.is(TT_InlineASMColon))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000139 return true;
Daniel Jasper1db6c382013-10-22 15:30:28 +0000140 if (State.Stack.back().BreakBeforeClosingBrace &&
141 Current.closesBlockTypeList(Style))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000142 return true;
143 if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection)
144 return true;
Daniel Jasperec01cd62013-10-08 05:11:18 +0000145 if ((startsNextParameter(Current, Style) || Previous.is(tok::semi) ||
Daniel Jasper165b29e2013-11-08 00:57:11 +0000146 (Style.BreakBeforeTernaryOperators &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000147 (Current.is(tok::question) ||
148 (Current.is(TT_ConditionalExpr) && Previous.isNot(tok::question)))) ||
Daniel Jasper165b29e2013-11-08 00:57:11 +0000149 (!Style.BreakBeforeTernaryOperators &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000150 (Previous.is(tok::question) || Previous.is(TT_ConditionalExpr)))) &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000151 State.Stack.back().BreakBeforeParameter && !Current.isTrailingComment() &&
152 !Current.isOneOf(tok::r_paren, tok::r_brace))
153 return true;
154 if (Style.AlwaysBreakBeforeMultilineStrings &&
Daniel Jasperf438cb72013-08-23 11:57:34 +0000155 State.Column > State.Stack.back().Indent && // Breaking saves columns.
Daniel Jasper27943052013-11-09 03:08:25 +0000156 !Previous.isOneOf(tok::kw_return, tok::lessless, tok::at) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000157 !Previous.isOneOf(TT_InlineASMColon, TT_ConditionalExpr) &&
158 nextIsMultilineString(State))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000159 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000160 if (((Previous.is(TT_DictLiteral) && Previous.is(tok::l_brace)) ||
161 Previous.is(TT_ArrayInitializerLSquare)) &&
Daniel Jasperdb8804b2014-04-14 12:11:07 +0000162 Style.ColumnLimit > 0 &&
Daniel Jasperd489dd32013-10-20 16:45:46 +0000163 getLengthToMatchingParen(Previous) + State.Column > getColumnLimit(State))
164 return true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000165 if (Current.is(TT_CtorInitializerColon) &&
Daniel Jasperd74cf402014-04-08 12:46:38 +0000166 ((Style.AllowShortFunctionsOnASingleLine != FormatStyle::SFS_All) ||
Daniel Jasper5d2587d2014-03-27 16:14:13 +0000167 Style.BreakConstructorInitializersBeforeComma || Style.ColumnLimit != 0))
168 return true;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000169
Daniel Jasper5d2587d2014-03-27 16:14:13 +0000170 if (State.Column < getNewLineColumn(State))
171 return false;
Daniel Jasper8c6e9ef2014-12-02 09:46:56 +0000172 if (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000173 // If we need to break somewhere inside the LHS of a binary expression, we
174 // should also break after the operator. Otherwise, the formatting would
175 // hide the operator precedence, e.g. in:
176 // if (aaaaaaaaaaaaaa ==
177 // bbbbbbbbbbbbbb && c) {..
178 // For comparisons, we only apply this rule, if the LHS is a binary
179 // expression itself as otherwise, the line breaks seem superfluous.
180 // We need special cases for ">>" which we have split into two ">" while
181 // lexing in order to make template parsing easier.
Daniel Jasperde0328a2013-08-16 11:20:30 +0000182 bool IsComparison = (Previous.getPrecedence() == prec::Relational ||
183 Previous.getPrecedence() == prec::Equality) &&
184 Previous.Previous &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000185 Previous.Previous->isNot(TT_BinaryOperator); // For >>.
Daniel Jasperde0328a2013-08-16 11:20:30 +0000186 bool LHSIsBinaryExpr =
Daniel Jasper562ecd42013-09-06 08:08:14 +0000187 Previous.Previous && Previous.Previous->EndsBinaryExpression;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000188 if (Previous.is(TT_BinaryOperator) && (!IsComparison || LHSIsBinaryExpr) &&
189 Current.isNot(TT_BinaryOperator) && // For >>.
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000190 !Current.isTrailingComment() && !Previous.is(tok::lessless) &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000191 Previous.getPrecedence() != prec::Assignment &&
192 State.Stack.back().BreakBeforeParameter)
193 return true;
Daniel Jasper3219e432014-12-02 13:24:51 +0000194 } else {
195 if (Current.is(TT_BinaryOperator) && Previous.EndsBinaryExpression &&
196 State.Stack.back().BreakBeforeParameter)
197 return true;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000198 }
199
200 // Same as above, but for the first "<<" operator.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000201 if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator) &&
Alexander Kornienko86b2dfd2014-03-06 15:13:08 +0000202 State.Stack.back().BreakBeforeParameter &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000203 State.Stack.back().FirstLessLess == 0)
204 return true;
205
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000206 if (Current.is(TT_SelectorName) && State.Stack.back().ObjCSelectorNameFound &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000207 State.Stack.back().BreakBeforeParameter)
208 return true;
Daniel Jasper211e1322014-12-08 20:08:04 +0000209 if (Current.NestingLevel == 0 && !Current.isTrailingComment()) {
210 if (Previous.ClosesTemplateDeclaration)
211 return true;
Nico Weberbeb03932015-01-09 23:25:06 +0000212 if (Previous.is(TT_LeadingJavaAnnotation) && Current.isNot(tok::l_paren) &&
213 Current.isNot(TT_LeadingJavaAnnotation))
Daniel Jasper211e1322014-12-08 20:08:04 +0000214 return true;
215 }
Daniel Jasperde0328a2013-08-16 11:20:30 +0000216
Daniel Jasper4355e7f2014-07-09 07:50:33 +0000217 // If the return type spans multiple lines, wrap before the function name.
Nico Weberbeb03932015-01-09 23:25:06 +0000218 if (Current.isOneOf(TT_FunctionDeclarationName, tok::kw_operator) &&
Daniel Jasper4355e7f2014-07-09 07:50:33 +0000219 State.Stack.back().BreakBeforeParameter)
Daniel Jasperde0328a2013-08-16 11:20:30 +0000220 return true;
Daniel Jasper4355e7f2014-07-09 07:50:33 +0000221
Daniel Jasper4c6e0052013-08-27 14:24:43 +0000222 if (startsSegmentOfBuilderTypeCall(Current) &&
Daniel Jasperf8151e92013-08-30 07:12:40 +0000223 (State.Stack.back().CallContinuation != 0 ||
224 (State.Stack.back().BreakBeforeParameter &&
225 State.Stack.back().ContainsUnwrappedBuilder)))
Daniel Jasper4c6e0052013-08-27 14:24:43 +0000226 return true;
Daniel Jasper96972812014-01-05 12:38:10 +0000227
228 // The following could be precomputed as they do not depend on the state.
229 // However, as they should take effect only if the UnwrappedLine does not fit
230 // into the ColumnLimit, they are checked here in the ContinuationIndenter.
Daniel Jasper35995672014-04-29 14:05:20 +0000231 if (Style.ColumnLimit != 0 && Previous.BlockKind == BK_Block &&
232 Previous.is(tok::l_brace) && !Current.isOneOf(tok::r_brace, tok::comment))
Daniel Jasper96972812014-01-05 12:38:10 +0000233 return true;
Daniel Jasper96972812014-01-05 12:38:10 +0000234
Daniel Jasperde0328a2013-08-16 11:20:30 +0000235 return false;
236}
237
238unsigned ContinuationIndenter::addTokenToState(LineState &State, bool Newline,
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000239 bool DryRun,
240 unsigned ExtraSpaces) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000241 const FormatToken &Current = *State.NextToken;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000242
Manuel Klimek819788d2014-03-18 11:22:45 +0000243 assert(!State.Stack.empty());
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000244 if ((Current.is(TT_ImplicitStringLiteral) &&
Craig Topper2145bc02014-05-09 08:15:10 +0000245 (Current.Previous->Tok.getIdentifierInfo() == nullptr ||
Daniel Jasper98857842013-10-30 13:54:53 +0000246 Current.Previous->Tok.getIdentifierInfo()->getPPKeywordID() ==
247 tok::pp_not_keyword))) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000248 // FIXME: Is this correct?
249 int WhitespaceLength = SourceMgr.getSpellingColumnNumber(
250 State.NextToken->WhitespaceRange.getEnd()) -
251 SourceMgr.getSpellingColumnNumber(
252 State.NextToken->WhitespaceRange.getBegin());
Daniel Jasperda353cd2014-03-12 08:24:47 +0000253 State.Column += WhitespaceLength;
Daniel Jasper240dfda2014-03-31 14:23:49 +0000254 moveStateToNextToken(State, DryRun, /*Newline=*/false);
Daniel Jasperde0328a2013-08-16 11:20:30 +0000255 return 0;
256 }
257
Alexander Kornienko1f803962013-10-01 14:41:18 +0000258 unsigned Penalty = 0;
259 if (Newline)
260 Penalty = addTokenOnNewLine(State, DryRun);
261 else
Daniel Jasper48437ce2013-11-20 14:54:39 +0000262 addTokenOnCurrentLine(State, DryRun, ExtraSpaces);
Alexander Kornienko1f803962013-10-01 14:41:18 +0000263
264 return moveStateToNextToken(State, DryRun, Newline) + Penalty;
265}
266
Daniel Jasper48437ce2013-11-20 14:54:39 +0000267void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun,
268 unsigned ExtraSpaces) {
Manuel Klimek71814b42013-10-11 21:25:45 +0000269 FormatToken &Current = *State.NextToken;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000270 const FormatToken &Previous = *State.NextToken->Previous;
271 if (Current.is(tok::equal) &&
Daniel Jasper05cd5862014-05-08 12:21:30 +0000272 (State.Line->First->is(tok::kw_for) || Current.NestingLevel == 0) &&
Alexander Kornienko1f803962013-10-01 14:41:18 +0000273 State.Stack.back().VariablePos == 0) {
274 State.Stack.back().VariablePos = State.Column;
275 // Move over * and & if they are bound to the variable name.
276 const FormatToken *Tok = &Previous;
277 while (Tok && State.Stack.back().VariablePos >= Tok->ColumnWidth) {
278 State.Stack.back().VariablePos -= Tok->ColumnWidth;
279 if (Tok->SpacesRequiredBefore != 0)
280 break;
281 Tok = Tok->Previous;
282 }
283 if (Previous.PartOfMultiVariableDeclStmt)
284 State.Stack.back().LastSpace = State.Stack.back().VariablePos;
285 }
286
287 unsigned Spaces = Current.SpacesRequiredBefore + ExtraSpaces;
288
289 if (!DryRun)
290 Whitespaces.replaceWhitespace(Current, /*Newlines=*/0, /*IndentLevel=*/0,
291 Spaces, State.Column + Spaces);
292
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000293 if (Current.is(TT_SelectorName) &&
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000294 !State.Stack.back().ObjCSelectorNameFound) {
295 if (Current.LongestObjCSelectorName == 0)
296 State.Stack.back().AlignColons = false;
297 else if (State.Stack.back().Indent + Current.LongestObjCSelectorName >
298 State.Column + Spaces + Current.ColumnWidth)
Alexander Kornienko1f803962013-10-01 14:41:18 +0000299 State.Stack.back().ColonPos =
300 State.Stack.back().Indent + Current.LongestObjCSelectorName;
301 else
302 State.Stack.back().ColonPos = State.Column + Spaces + Current.ColumnWidth;
303 }
304
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000305 if (Style.AlignAfterOpenBracket && Previous.opensScope() &&
306 Previous.isNot(TT_ObjCMethodExpr) &&
307 (Current.isNot(TT_LineComment) || Previous.BlockKind == BK_BracedInit))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000308 State.Stack.back().Indent = State.Column + Spaces;
Daniel Jasperec01cd62013-10-08 05:11:18 +0000309 if (State.Stack.back().AvoidBinPacking && startsNextParameter(Current, Style))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000310 State.Stack.back().NoLineBreak = true;
311 if (startsSegmentOfBuilderTypeCall(Current))
312 State.Stack.back().ContainsUnwrappedBuilder = true;
313
Daniel Jasperd6f17d82014-09-12 16:35:28 +0000314 if (Current.isMemberAccess() && Previous.is(tok::r_paren) &&
315 (Previous.MatchingParen &&
316 (Previous.TotalLength - Previous.MatchingParen->TotalLength > 10))) {
317 // If there is a function call with long parameters, break before trailing
318 // calls. This prevents things like:
319 // EXPECT_CALL(SomeLongParameter).Times(
320 // 2);
321 // We don't want to do this for short parameters as they can just be
322 // indexes.
323 State.Stack.back().NoLineBreak = true;
324 }
325
Alexander Kornienko1f803962013-10-01 14:41:18 +0000326 State.Column += Spaces;
Daniel Jasper8acf8222014-05-07 09:23:05 +0000327 if (Current.isNot(tok::comment) && Previous.is(tok::l_paren) &&
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000328 Previous.Previous &&
329 Previous.Previous->isOneOf(tok::kw_if, tok::kw_for)) {
Alexander Kornienko1f803962013-10-01 14:41:18 +0000330 // Treat the condition inside an if as if it was a second function
Daniel Jasper6633ab82013-10-18 10:38:14 +0000331 // parameter, i.e. let nested calls have a continuation indent.
Daniel Jasper8acf8222014-05-07 09:23:05 +0000332 State.Stack.back().LastSpace = State.Column;
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000333 State.Stack.back().NestedBlockIndent = State.Column;
334 } else if (!Current.isOneOf(tok::comment, tok::caret) &&
335 (Previous.is(tok::comma) ||
336 (Previous.is(tok::colon) && Previous.is(TT_ObjCMethodExpr)))) {
Alexander Kornienko1f803962013-10-01 14:41:18 +0000337 State.Stack.back().LastSpace = State.Column;
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000338 } else if ((Previous.isOneOf(TT_BinaryOperator, TT_ConditionalExpr,
339 TT_CtorInitializerColon)) &&
340 ((Previous.getPrecedence() != prec::Assignment &&
341 (Previous.isNot(tok::lessless) || Previous.OperatorIndex != 0 ||
342 !Previous.LastOperator)) ||
343 Current.StartsBinaryExpression)) {
Alexander Kornienko1f803962013-10-01 14:41:18 +0000344 // Always indent relative to the RHS of the expression unless this is a
345 // simple assignment without binary expression on the RHS. Also indent
346 // relative to unary operators and the colons of constructor initializers.
347 State.Stack.back().LastSpace = State.Column;
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000348 } else if (Previous.is(TT_InheritanceColon)) {
Alexander Kornienko1f803962013-10-01 14:41:18 +0000349 State.Stack.back().Indent = State.Column;
Daniel Jasperf9a5e402013-10-08 16:24:07 +0000350 State.Stack.back().LastSpace = State.Column;
351 } else if (Previous.opensScope()) {
Alexander Kornienko1f803962013-10-01 14:41:18 +0000352 // If a function has a trailing call, indent all parameters from the
353 // opening parenthesis. This avoids confusing indents like:
354 // OuterFunction(InnerFunctionCall( // break
355 // ParameterToInnerFunction)) // break
356 // .SecondInnerFunctionCall();
357 bool HasTrailingCall = false;
358 if (Previous.MatchingParen) {
359 const FormatToken *Next = Previous.MatchingParen->getNextNonComment();
360 HasTrailingCall = Next && Next->isMemberAccess();
361 }
362 if (HasTrailingCall &&
363 State.Stack[State.Stack.size() - 2].CallContinuation == 0)
364 State.Stack.back().LastSpace = State.Column;
365 }
366}
367
368unsigned ContinuationIndenter::addTokenOnNewLine(LineState &State,
369 bool DryRun) {
Manuel Klimek71814b42013-10-11 21:25:45 +0000370 FormatToken &Current = *State.NextToken;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000371 const FormatToken &Previous = *State.NextToken->Previous;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000372
Alexander Kornienko1f803962013-10-01 14:41:18 +0000373 // Extra penalty that needs to be added because of the way certain line
374 // breaks are chosen.
375 unsigned Penalty = 0;
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000376
Daniel Jaspera0407742014-02-11 10:08:11 +0000377 const FormatToken *PreviousNonComment = Current.getPreviousNonComment();
378 const FormatToken *NextNonComment = Previous.getNextNonComment();
379 if (!NextNonComment)
380 NextNonComment = &Current;
Daniel Jasper05cd5862014-05-08 12:21:30 +0000381 // The first line break on any NestingLevel causes an extra penalty in order
Alexander Kornienko1f803962013-10-01 14:41:18 +0000382 // prefer similar line breaks.
383 if (!State.Stack.back().ContainsLineBreak)
384 Penalty += 15;
385 State.Stack.back().ContainsLineBreak = true;
Daniel Jasper8de9ed02013-08-22 15:00:41 +0000386
Alexander Kornienko1f803962013-10-01 14:41:18 +0000387 Penalty += State.NextToken->SplitPenalty;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000388
Alexander Kornienko1f803962013-10-01 14:41:18 +0000389 // Breaking before the first "<<" is generally not desirable if the LHS is
Daniel Jasper48437ce2013-11-20 14:54:39 +0000390 // short. Also always add the penalty if the LHS is split over mutliple lines
Daniel Jasper2b7556e2014-04-03 12:00:27 +0000391 // to avoid unnecessary line breaks that just work around this penalty.
Daniel Jaspera0407742014-02-11 10:08:11 +0000392 if (NextNonComment->is(tok::lessless) &&
393 State.Stack.back().FirstLessLess == 0 &&
Daniel Jasper004177e2013-12-19 16:06:40 +0000394 (State.Column <= Style.ColumnLimit / 3 ||
Daniel Jasper48437ce2013-11-20 14:54:39 +0000395 State.Stack.back().BreakBeforeParameter))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000396 Penalty += Style.PenaltyBreakFirstLessLess;
397
Daniel Jasper9f388d02014-03-27 14:33:30 +0000398 State.Column = getNewLineColumn(State);
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000399 State.Stack.back().NestedBlockIndent = State.Column;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000400 if (NextNonComment->isMemberAccess()) {
401 if (State.Stack.back().CallContinuation == 0)
Alexander Kornienko1f803962013-10-01 14:41:18 +0000402 State.Stack.back().CallContinuation = State.Column;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000403 } else if (NextNonComment->is(TT_SelectorName)) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000404 if (!State.Stack.back().ObjCSelectorNameFound) {
Daniel Jaspera0407742014-02-11 10:08:11 +0000405 if (NextNonComment->LongestObjCSelectorName == 0) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000406 State.Stack.back().AlignColons = false;
407 } else {
408 State.Stack.back().ColonPos =
Daniel Jaspera0407742014-02-11 10:08:11 +0000409 State.Stack.back().Indent + NextNonComment->LongestObjCSelectorName;
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000410 }
Daniel Jasper9f388d02014-03-27 14:33:30 +0000411 } else if (State.Stack.back().AlignColons &&
412 State.Stack.back().ColonPos <= NextNonComment->ColumnWidth) {
Daniel Jaspera0407742014-02-11 10:08:11 +0000413 State.Stack.back().ColonPos = State.Column + NextNonComment->ColumnWidth;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000414 }
Daniel Jasper1fd6f1f2014-03-17 14:32:47 +0000415 } else if (PreviousNonComment && PreviousNonComment->is(tok::colon) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000416 PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral)) {
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000417 // FIXME: This is hacky, find a better way. The problem is that in an ObjC
418 // method expression, the block should be aligned to the line starting it,
419 // e.g.:
420 // [aaaaaaaaaaaaaaa aaaaaaaaa: \\ break for some reason
421 // ^(int *i) {
422 // // ...
423 // }];
Daniel Jasper05cd5862014-05-08 12:21:30 +0000424 // Thus, we set LastSpace of the next higher NestingLevel, to which we move
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000425 // when we consume all of the "}"'s FakeRParens at the "{".
Daniel Jasper9a26e772013-12-23 11:25:40 +0000426 if (State.Stack.size() > 1)
Daniel Jasper9f388d02014-03-27 14:33:30 +0000427 State.Stack[State.Stack.size() - 2].LastSpace =
428 std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) +
429 Style.ContinuationIndentWidth;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000430 }
431
Alexander Kornienko1f803962013-10-01 14:41:18 +0000432 if ((Previous.isOneOf(tok::comma, tok::semi) &&
433 !State.Stack.back().AvoidBinPacking) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000434 Previous.is(TT_BinaryOperator))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000435 State.Stack.back().BreakBeforeParameter = false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000436 if (Previous.isOneOf(TT_TemplateCloser, TT_JavaAnnotation) &&
Daniel Jasper39af6cd2014-11-03 02:27:28 +0000437 Current.NestingLevel == 0)
Alexander Kornienko1f803962013-10-01 14:41:18 +0000438 State.Stack.back().BreakBeforeParameter = false;
Daniel Jaspera0407742014-02-11 10:08:11 +0000439 if (NextNonComment->is(tok::question) ||
Daniel Jasper165b29e2013-11-08 00:57:11 +0000440 (PreviousNonComment && PreviousNonComment->is(tok::question)))
441 State.Stack.back().BreakBeforeParameter = true;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000442
443 if (!DryRun) {
Daniel Jaspera69ca9b2014-06-04 12:40:57 +0000444 unsigned Newlines = std::max(
445 1u, std::min(Current.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1));
Alexander Kornienkoe2e03872013-10-14 00:46:35 +0000446 Whitespaces.replaceWhitespace(Current, Newlines,
447 State.Stack.back().IndentLevel, State.Column,
448 State.Column, State.Line->InPPDirective);
Alexander Kornienko1f803962013-10-01 14:41:18 +0000449 }
450
451 if (!Current.isTrailingComment())
452 State.Stack.back().LastSpace = State.Column;
Daniel Jasper05cd5862014-05-08 12:21:30 +0000453 State.StartOfLineLevel = Current.NestingLevel;
454 State.LowestLevelOnLine = Current.NestingLevel;
Alexander Kornienko1f803962013-10-01 14:41:18 +0000455
456 // Any break on this level means that the parent level has been broken
457 // and we need to avoid bin packing there.
Daniel Jasper4b444492014-11-21 13:38:53 +0000458 bool NestedBlockSpecialCase =
459 Current.is(tok::r_brace) && State.Stack.size() > 1 &&
460 State.Stack[State.Stack.size() - 2].NestedBlockInlined;
461 if (!NestedBlockSpecialCase) {
Daniel Jasperb16b9692014-05-21 12:51:23 +0000462 for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) {
463 State.Stack[i].BreakBeforeParameter = true;
464 }
Alexander Kornienko1f803962013-10-01 14:41:18 +0000465 }
Daniel Jasperb16b9692014-05-21 12:51:23 +0000466
Daniel Jasper9e5ede02013-11-08 19:56:28 +0000467 if (PreviousNonComment &&
468 !PreviousNonComment->isOneOf(tok::comma, tok::semi) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000469 (PreviousNonComment->isNot(TT_TemplateCloser) ||
Daniel Jasper6c0ee172014-11-14 13:14:45 +0000470 Current.NestingLevel != 0) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000471 !PreviousNonComment->isOneOf(TT_BinaryOperator, TT_JavaAnnotation,
472 TT_LeadingJavaAnnotation) &&
473 Current.isNot(TT_BinaryOperator) && !PreviousNonComment->opensScope())
Alexander Kornienko1f803962013-10-01 14:41:18 +0000474 State.Stack.back().BreakBeforeParameter = true;
475
Daniel Jasper1db6c382013-10-22 15:30:28 +0000476 // If we break after { or the [ of an array initializer, we should also break
477 // before the corresponding } or ].
Daniel Jasper90818052014-06-10 10:42:26 +0000478 if (PreviousNonComment &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000479 (PreviousNonComment->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare)))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000480 State.Stack.back().BreakBeforeClosingBrace = true;
481
482 if (State.Stack.back().AvoidBinPacking) {
483 // If we are breaking after '(', '{', '<', this is not bin packing
Daniel Jasper2a958322014-05-21 13:26:58 +0000484 // unless AllowAllParametersOfDeclarationOnNextLine is false or this is a
485 // dict/object literal.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000486 if (!Previous.isOneOf(tok::l_paren, tok::l_brace, TT_BinaryOperator) ||
Alexander Kornienko1f803962013-10-01 14:41:18 +0000487 (!Style.AllowAllParametersOfDeclarationOnNextLine &&
Daniel Jasper2a958322014-05-21 13:26:58 +0000488 State.Line->MustBeDeclaration) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000489 Previous.is(TT_DictLiteral))
Alexander Kornienko1f803962013-10-01 14:41:18 +0000490 State.Stack.back().BreakBeforeParameter = true;
491 }
492
493 return Penalty;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000494}
495
Daniel Jasper9f388d02014-03-27 14:33:30 +0000496unsigned ContinuationIndenter::getNewLineColumn(const LineState &State) {
Daniel Jasper5d2587d2014-03-27 16:14:13 +0000497 if (!State.NextToken || !State.NextToken->Previous)
498 return 0;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000499 FormatToken &Current = *State.NextToken;
Daniel Jasper4281c5a2014-10-07 14:45:34 +0000500 const FormatToken &Previous = *Current.Previous;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000501 // If we are continuing an expression, we want to use the continuation indent.
502 unsigned ContinuationIndent =
503 std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) +
504 Style.ContinuationIndentWidth;
505 const FormatToken *PreviousNonComment = Current.getPreviousNonComment();
506 const FormatToken *NextNonComment = Previous.getNextNonComment();
507 if (!NextNonComment)
508 NextNonComment = &Current;
Daniel Jasper50b4bd72014-11-02 19:16:41 +0000509
510 // Java specific bits.
Daniel Jasperd0ec0d62014-11-04 12:41:02 +0000511 if (Style.Language == FormatStyle::LK_Java &&
512 Current.isOneOf(Keywords.kw_implements, Keywords.kw_extends))
Daniel Jasper50b4bd72014-11-02 19:16:41 +0000513 return std::max(State.Stack.back().LastSpace,
514 State.Stack.back().Indent + Style.ContinuationIndentWidth);
515
Daniel Jasperb05a81d2014-05-09 13:11:16 +0000516 if (NextNonComment->is(tok::l_brace) && NextNonComment->BlockKind == BK_Block)
Daniel Jasper05cd5862014-05-08 12:21:30 +0000517 return Current.NestingLevel == 0 ? State.FirstIndent
518 : State.Stack.back().Indent;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000519 if (Current.isOneOf(tok::r_brace, tok::r_square)) {
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000520 if (Current.closesBlockTypeList(Style))
521 return State.Stack[State.Stack.size() - 2].NestedBlockIndent;
522 if (Current.MatchingParen &&
523 Current.MatchingParen->BlockKind == BK_BracedInit)
Daniel Jasper9f388d02014-03-27 14:33:30 +0000524 return State.Stack[State.Stack.size() - 2].LastSpace;
Daniel Jasper24a14772014-12-10 17:24:34 +0000525 return State.FirstIndent;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000526 }
Daniel Jasper783bac62014-04-15 09:54:30 +0000527 if (Current.is(tok::identifier) && Current.Next &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000528 Current.Next->is(TT_DictLiteral))
Daniel Jasper783bac62014-04-15 09:54:30 +0000529 return State.Stack.back().Indent;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000530 if (NextNonComment->isStringLiteral() && State.StartOfStringLiteral != 0)
531 return State.StartOfStringLiteral;
532 if (NextNonComment->is(tok::lessless) &&
533 State.Stack.back().FirstLessLess != 0)
534 return State.Stack.back().FirstLessLess;
535 if (NextNonComment->isMemberAccess()) {
Daniel Jasper24a14772014-12-10 17:24:34 +0000536 if (State.Stack.back().CallContinuation == 0)
Daniel Jasper9f388d02014-03-27 14:33:30 +0000537 return ContinuationIndent;
Daniel Jasper24a14772014-12-10 17:24:34 +0000538 return State.Stack.back().CallContinuation;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000539 }
540 if (State.Stack.back().QuestionColumn != 0 &&
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000541 ((NextNonComment->is(tok::colon) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000542 NextNonComment->is(TT_ConditionalExpr)) ||
543 Previous.is(TT_ConditionalExpr)))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000544 return State.Stack.back().QuestionColumn;
545 if (Previous.is(tok::comma) && State.Stack.back().VariablePos != 0)
546 return State.Stack.back().VariablePos;
Daniel Jaspere9ab42d2014-10-31 18:23:49 +0000547 if ((PreviousNonComment &&
548 (PreviousNonComment->ClosesTemplateDeclaration ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000549 PreviousNonComment->isOneOf(TT_AttributeParen, TT_JavaAnnotation,
550 TT_LeadingJavaAnnotation))) ||
Daniel Jasperc75e1ef2014-07-09 08:42:42 +0000551 (!Style.IndentWrappedFunctionNames &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000552 NextNonComment->isOneOf(tok::kw_operator, TT_FunctionDeclarationName)))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000553 return std::max(State.Stack.back().LastSpace, State.Stack.back().Indent);
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000554 if (NextNonComment->is(TT_SelectorName)) {
Daniel Jasper9f388d02014-03-27 14:33:30 +0000555 if (!State.Stack.back().ObjCSelectorNameFound) {
Daniel Jasper24a14772014-12-10 17:24:34 +0000556 if (NextNonComment->LongestObjCSelectorName == 0)
Daniel Jasper9f388d02014-03-27 14:33:30 +0000557 return State.Stack.back().Indent;
Daniel Jasper24a14772014-12-10 17:24:34 +0000558 return State.Stack.back().Indent +
559 NextNonComment->LongestObjCSelectorName -
560 NextNonComment->ColumnWidth;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000561 }
Daniel Jasper24a14772014-12-10 17:24:34 +0000562 if (!State.Stack.back().AlignColons)
563 return State.Stack.back().Indent;
564 if (State.Stack.back().ColonPos > NextNonComment->ColumnWidth)
565 return State.Stack.back().ColonPos - NextNonComment->ColumnWidth;
566 return State.Stack.back().Indent;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000567 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000568 if (NextNonComment->is(TT_ArraySubscriptLSquare)) {
Daniel Jasper9f388d02014-03-27 14:33:30 +0000569 if (State.Stack.back().StartOfArraySubscripts != 0)
570 return State.Stack.back().StartOfArraySubscripts;
Daniel Jasper24a14772014-12-10 17:24:34 +0000571 return ContinuationIndent;
Daniel Jasper9f388d02014-03-27 14:33:30 +0000572 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000573 if (NextNonComment->is(TT_StartOfName) ||
Daniel Jasper9f388d02014-03-27 14:33:30 +0000574 Previous.isOneOf(tok::coloncolon, tok::equal)) {
575 return ContinuationIndent;
576 }
577 if (PreviousNonComment && PreviousNonComment->is(tok::colon) &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000578 PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000579 return ContinuationIndent;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000580 if (NextNonComment->is(TT_CtorInitializerColon))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000581 return State.FirstIndent + Style.ConstructorInitializerIndentWidth;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000582 if (NextNonComment->is(TT_CtorInitializerComma))
Daniel Jasper9f388d02014-03-27 14:33:30 +0000583 return State.Stack.back().Indent;
Daniel Jasper316ab382014-08-06 13:14:58 +0000584 if (Previous.is(tok::r_paren) && !Current.isBinaryOperator() &&
Daniel Jasper119ff532014-11-14 12:31:14 +0000585 !Current.isOneOf(tok::colon, tok::comment))
Daniel Jasper316ab382014-08-06 13:14:58 +0000586 return ContinuationIndent;
Daniel Jasper5d2587d2014-03-27 16:14:13 +0000587 if (State.Stack.back().Indent == State.FirstIndent && PreviousNonComment &&
Daniel Jasper9f388d02014-03-27 14:33:30 +0000588 PreviousNonComment->isNot(tok::r_brace))
589 // Ensure that we fall back to the continuation indent width instead of
590 // just flushing continuations left.
591 return State.Stack.back().Indent + Style.ContinuationIndentWidth;
592 return State.Stack.back().Indent;
593}
594
Daniel Jasperde0328a2013-08-16 11:20:30 +0000595unsigned ContinuationIndenter::moveStateToNextToken(LineState &State,
596 bool DryRun, bool Newline) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000597 assert(State.Stack.size());
Daniel Jasper60553be2014-05-26 13:10:39 +0000598 const FormatToken &Current = *State.NextToken;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000599
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000600 if (Current.is(TT_InheritanceColon))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000601 State.Stack.back().AvoidBinPacking = true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000602 if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator)) {
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000603 if (State.Stack.back().FirstLessLess == 0)
604 State.Stack.back().FirstLessLess = State.Column;
605 else
606 State.Stack.back().LastOperatorWrapped = Newline;
607 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000608 if ((Current.is(TT_BinaryOperator) && Current.isNot(tok::lessless)) ||
609 Current.is(TT_ConditionalExpr))
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000610 State.Stack.back().LastOperatorWrapped = Newline;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000611 if (Current.is(TT_ArraySubscriptLSquare) &&
Daniel Jasperde0328a2013-08-16 11:20:30 +0000612 State.Stack.back().StartOfArraySubscripts == 0)
613 State.Stack.back().StartOfArraySubscripts = State.Column;
Daniel Jasper165b29e2013-11-08 00:57:11 +0000614 if ((Current.is(tok::question) && Style.BreakBeforeTernaryOperators) ||
615 (Current.getPreviousNonComment() && Current.isNot(tok::colon) &&
616 Current.getPreviousNonComment()->is(tok::question) &&
617 !Style.BreakBeforeTernaryOperators))
Daniel Jasperde0328a2013-08-16 11:20:30 +0000618 State.Stack.back().QuestionColumn = State.Column;
619 if (!Current.opensScope() && !Current.closesScope())
620 State.LowestLevelOnLine =
Daniel Jasper05cd5862014-05-08 12:21:30 +0000621 std::min(State.LowestLevelOnLine, Current.NestingLevel);
Daniel Jasper4c6e0052013-08-27 14:24:43 +0000622 if (Current.isMemberAccess())
Daniel Jasperde0328a2013-08-16 11:20:30 +0000623 State.Stack.back().StartOfFunctionCall =
Daniel Jasper0e617842014-04-16 12:26:54 +0000624 Current.LastOperator ? 0 : State.Column + Current.ColumnWidth;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000625 if (Current.is(TT_SelectorName))
Daniel Jasperb88b25f2013-12-23 07:29:06 +0000626 State.Stack.back().ObjCSelectorNameFound = true;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000627 if (Current.is(TT_CtorInitializerColon)) {
Daniel Jasperde0328a2013-08-16 11:20:30 +0000628 // Indent 2 from the column, so:
629 // SomeClass::SomeClass()
630 // : First(...), ...
631 // Next(...)
632 // ^ line up here.
633 State.Stack.back().Indent =
634 State.Column + (Style.BreakConstructorInitializersBeforeComma ? 0 : 2);
635 if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
636 State.Stack.back().AvoidBinPacking = true;
637 State.Stack.back().BreakBeforeParameter = false;
638 }
639
Daniel Jasperde0328a2013-08-16 11:20:30 +0000640 // In ObjC method declaration we align on the ":" of parameters, but we need
Daniel Jasper6633ab82013-10-18 10:38:14 +0000641 // to ensure that we indent parameters on subsequent lines by at least our
642 // continuation indent width.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000643 if (Current.is(TT_ObjCMethodSpecifier))
Daniel Jasper6633ab82013-10-18 10:38:14 +0000644 State.Stack.back().Indent += Style.ContinuationIndentWidth;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000645
646 // Insert scopes created by fake parenthesis.
647 const FormatToken *Previous = Current.getPreviousNonComment();
Daniel Jasperb16b9692014-05-21 12:51:23 +0000648
649 // Add special behavior to support a format commonly used for JavaScript
650 // closures:
651 // SomeFunction(function() {
652 // foo();
653 // bar();
654 // }, a, b, c);
Daniel Jasper4b444492014-11-21 13:38:53 +0000655 if (Current.isNot(tok::comment) && Previous && Previous->is(tok::l_brace) &&
656 State.Stack.size() > 1) {
657 if (State.Stack[State.Stack.size() - 2].NestedBlockInlined && Newline) {
658 for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) {
659 State.Stack[i].NoLineBreak = true;
Daniel Jasperb16b9692014-05-21 12:51:23 +0000660 }
Daniel Jasperb16b9692014-05-21 12:51:23 +0000661 }
Daniel Jasper4b444492014-11-21 13:38:53 +0000662 State.Stack[State.Stack.size() - 2].NestedBlockInlined = false;
663 }
664 if (Previous && (Previous->isOneOf(tok::l_paren, tok::comma, tok::colon) ||
665 Previous->isOneOf(TT_BinaryOperator, TT_ConditionalExpr)) &&
666 !Previous->isOneOf(TT_DictLiteral, TT_ObjCMethodExpr)) {
667 State.Stack.back().NestedBlockInlined =
668 !Newline &&
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000669 (Previous->isNot(tok::l_paren) || Previous->ParameterCount > 1);
Daniel Jasperb16b9692014-05-21 12:51:23 +0000670 }
671
Daniel Jasper60553be2014-05-26 13:10:39 +0000672 moveStatePastFakeLParens(State, Newline);
673 moveStatePastScopeOpener(State, Newline);
674 moveStatePastScopeCloser(State);
675 moveStatePastFakeRParens(State);
676
677 if (Current.isStringLiteral() && State.StartOfStringLiteral == 0) {
678 State.StartOfStringLiteral = State.Column;
679 } else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash) &&
680 !Current.isStringLiteral()) {
681 State.StartOfStringLiteral = 0;
682 }
683
684 State.Column += Current.ColumnWidth;
685 State.NextToken = State.NextToken->Next;
686 unsigned Penalty = breakProtrudingToken(Current, State, DryRun);
687 if (State.Column > getColumnLimit(State)) {
688 unsigned ExcessCharacters = State.Column - getColumnLimit(State);
689 Penalty += Style.PenaltyExcessCharacter * ExcessCharacters;
690 }
691
692 if (Current.Role)
693 Current.Role->formatFromToken(State, this, DryRun);
694 // If the previous has a special role, let it consume tokens as appropriate.
695 // It is necessary to start at the previous token for the only implemented
696 // role (comma separated list). That way, the decision whether or not to break
697 // after the "{" is already done and both options are tried and evaluated.
698 // FIXME: This is ugly, find a better way.
699 if (Previous && Previous->Role)
700 Penalty += Previous->Role->formatAfterToken(State, this, DryRun);
701
702 return Penalty;
703}
704
705void ContinuationIndenter::moveStatePastFakeLParens(LineState &State,
706 bool Newline) {
707 const FormatToken &Current = *State.NextToken;
708 const FormatToken *Previous = Current.getPreviousNonComment();
709
Daniel Jasperde0328a2013-08-16 11:20:30 +0000710 // Don't add extra indentation for the first fake parenthesis after
Dinesh Dwivedi0db806b2014-05-01 17:19:34 +0000711 // 'return', assignments or opening <({[. The indentation for these cases
Daniel Jasperde0328a2013-08-16 11:20:30 +0000712 // is special cased.
713 bool SkipFirstExtraIndent =
Daniel Jaspereabede62013-09-30 08:29:03 +0000714 (Previous && (Previous->opensScope() || Previous->is(tok::kw_return) ||
Daniel Jasper3219e432014-12-02 13:24:51 +0000715 (Previous->getPrecedence() == prec::Assignment &&
716 Style.AlignOperands) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000717 Previous->is(TT_ObjCMethodExpr)));
Daniel Jasperde0328a2013-08-16 11:20:30 +0000718 for (SmallVectorImpl<prec::Level>::const_reverse_iterator
719 I = Current.FakeLParens.rbegin(),
720 E = Current.FakeLParens.rend();
721 I != E; ++I) {
722 ParenState NewParenState = State.Stack.back();
723 NewParenState.ContainsLineBreak = false;
Daniel Jaspereabede62013-09-30 08:29:03 +0000724
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000725 // Indent from 'LastSpace' unless these are fake parentheses encapsulating
726 // a builder type call after 'return' or, if the alignment after opening
727 // brackets is disabled.
Daniel Jasper4281c5a2014-10-07 14:45:34 +0000728 if (!Current.isTrailingComment() &&
Daniel Jasper3219e432014-12-02 13:24:51 +0000729 (Style.AlignOperands || *I < prec::Assignment) &&
Daniel Jasper6cab6782014-11-20 09:54:49 +0000730 (!Previous || Previous->isNot(tok::kw_return) ||
731 (Style.Language != FormatStyle::LK_Java && *I > 0)) &&
Daniel Jasper3aa9a6a2014-11-18 23:55:27 +0000732 (Style.AlignAfterOpenBracket || *I != prec::Comma ||
733 Current.NestingLevel == 0))
Daniel Jaspereabede62013-09-30 08:29:03 +0000734 NewParenState.Indent =
735 std::max(std::max(State.Column, NewParenState.Indent),
736 State.Stack.back().LastSpace);
737
Daniel Jasper5c332652014-04-03 12:00:33 +0000738 // Don't allow the RHS of an operator to be split over multiple lines unless
739 // there is a line-break right after the operator.
740 // Exclude relational operators, as there, it is always more desirable to
741 // have the LHS 'left' of the RHS.
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000742 if (Previous && Previous->getPrecedence() > prec::Assignment &&
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000743 Previous->isOneOf(TT_BinaryOperator, TT_ConditionalExpr) &&
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000744 Previous->getPrecedence() != prec::Relational) {
Daniel Jasper8c6e9ef2014-12-02 09:46:56 +0000745 bool BreakBeforeOperator =
746 Previous->is(tok::lessless) ||
747 (Previous->is(TT_BinaryOperator) &&
748 Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None) ||
749 (Previous->is(TT_ConditionalExpr) &&
750 Style.BreakBeforeTernaryOperators);
Daniel Jasperc0d606a2014-04-14 11:08:45 +0000751 if ((!Newline && !BreakBeforeOperator) ||
752 (!State.Stack.back().LastOperatorWrapped && BreakBeforeOperator))
753 NewParenState.NoLineBreak = true;
754 }
Daniel Jasper5c332652014-04-03 12:00:33 +0000755
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000756 // Do not indent relative to the fake parentheses inserted for "." or "->".
757 // This is a special case to make the following to statements consistent:
758 // OuterFunction(InnerFunctionCall( // break
759 // ParameterToInnerFunction));
760 // OuterFunction(SomeObject.InnerFunctionCall( // break
761 // ParameterToInnerFunction));
762 if (*I > prec::Unknown)
763 NewParenState.LastSpace = std::max(NewParenState.LastSpace, State.Column);
Daniel Jaspera536df42014-12-08 21:28:31 +0000764 if (*I != prec::Conditional)
765 NewParenState.StartOfFunctionCall = State.Column;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000766
767 // Always indent conditional expressions. Never indent expression where
768 // the 'operator' is ',', ';' or an assignment (i.e. *I <=
769 // prec::Assignment) as those have different indentation rules. Indent
770 // other expression, unless the indentation needs to be skipped.
771 if (*I == prec::Conditional ||
772 (!SkipFirstExtraIndent && *I > prec::Assignment &&
Daniel Jasper8c6e9ef2014-12-02 09:46:56 +0000773 !Current.isTrailingComment()))
Daniel Jasper6633ab82013-10-18 10:38:14 +0000774 NewParenState.Indent += Style.ContinuationIndentWidth;
Daniel Jasper1db6c382013-10-22 15:30:28 +0000775 if ((Previous && !Previous->opensScope()) || *I > prec::Comma)
Daniel Jasperde0328a2013-08-16 11:20:30 +0000776 NewParenState.BreakBeforeParameter = false;
777 State.Stack.push_back(NewParenState);
778 SkipFirstExtraIndent = false;
779 }
Daniel Jasper60553be2014-05-26 13:10:39 +0000780}
Daniel Jasperde0328a2013-08-16 11:20:30 +0000781
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000782void ContinuationIndenter::moveStatePastFakeRParens(LineState &State) {
783 for (unsigned i = 0, e = State.NextToken->FakeRParens; i != e; ++i) {
Daniel Jasper335ff262014-05-28 09:11:53 +0000784 unsigned VariablePos = State.Stack.back().VariablePos;
785 assert(State.Stack.size() > 1);
786 if (State.Stack.size() == 1) {
787 // Do not pop the last element.
788 break;
789 }
790 State.Stack.pop_back();
791 State.Stack.back().VariablePos = VariablePos;
792 }
793}
794
Daniel Jasper60553be2014-05-26 13:10:39 +0000795void ContinuationIndenter::moveStatePastScopeOpener(LineState &State,
796 bool Newline) {
797 const FormatToken &Current = *State.NextToken;
798 if (!Current.opensScope())
799 return;
800
801 if (Current.MatchingParen && Current.BlockKind == BK_Block) {
802 moveStateToNewBlock(State);
803 return;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000804 }
805
Daniel Jasper60553be2014-05-26 13:10:39 +0000806 unsigned NewIndent;
807 unsigned NewIndentLevel = State.Stack.back().IndentLevel;
808 bool AvoidBinPacking;
809 bool BreakBeforeParameter = false;
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000810 if (Current.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare)) {
Daniel Jasper60553be2014-05-26 13:10:39 +0000811 if (Current.opensBlockTypeList(Style)) {
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000812 NewIndent = State.Stack.back().NestedBlockIndent + Style.IndentWidth;
Daniel Jasper60553be2014-05-26 13:10:39 +0000813 NewIndent = std::min(State.Column + 2, NewIndent);
814 ++NewIndentLevel;
815 } else {
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000816 NewIndent = State.Stack.back().LastSpace + Style.ContinuationIndentWidth;
Daniel Jasper60553be2014-05-26 13:10:39 +0000817 NewIndent = std::min(State.Column + 1, NewIndent);
818 }
819 const FormatToken *NextNoComment = Current.getNextNonComment();
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000820 AvoidBinPacking =
821 Current.isOneOf(TT_ArrayInitializerLSquare, TT_DictLiteral) ||
822 Style.Language == FormatStyle::LK_Proto || !Style.BinPackParameters ||
823 (NextNoComment && NextNoComment->is(TT_DesignatedInitializerPeriod));
Daniel Jasper60553be2014-05-26 13:10:39 +0000824 } else {
825 NewIndent = Style.ContinuationIndentWidth +
826 std::max(State.Stack.back().LastSpace,
827 State.Stack.back().StartOfFunctionCall);
Daniel Jasper18210d72014-10-09 09:52:05 +0000828 AvoidBinPacking =
829 (State.Line->MustBeDeclaration && !Style.BinPackParameters) ||
830 (!State.Line->MustBeDeclaration && !Style.BinPackArguments) ||
831 (Style.ExperimentalAutoDetectBinPacking &&
832 (Current.PackingKind == PPK_OnePerLine ||
833 (!BinPackInconclusiveFunctions &&
834 Current.PackingKind == PPK_Inconclusive)));
Daniel Jasper60553be2014-05-26 13:10:39 +0000835 // If this '[' opens an ObjC call, determine whether all parameters fit
836 // into one line and put one per line if they don't.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000837 if (Current.is(TT_ObjCMethodExpr) && Style.ColumnLimit != 0 &&
Daniel Jasper60553be2014-05-26 13:10:39 +0000838 getLengthToMatchingParen(Current) + State.Column >
839 getColumnLimit(State))
840 BreakBeforeParameter = true;
841 }
Daniel Jaspera41aa532014-09-19 08:01:25 +0000842 bool NoLineBreak = State.Stack.back().NoLineBreak ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000843 (Current.is(TT_TemplateOpener) &&
Daniel Jaspera41aa532014-09-19 08:01:25 +0000844 State.Stack.back().ContainsUnwrappedBuilder);
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000845 unsigned NestedBlockIndent = State.Stack.back().NestedBlockIndent;
Daniel Jasper60553be2014-05-26 13:10:39 +0000846 State.Stack.push_back(ParenState(NewIndent, NewIndentLevel,
847 State.Stack.back().LastSpace,
848 AvoidBinPacking, NoLineBreak));
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000849 State.Stack.back().NestedBlockIndent = NestedBlockIndent;
Daniel Jasper60553be2014-05-26 13:10:39 +0000850 State.Stack.back().BreakBeforeParameter = BreakBeforeParameter;
Daniel Jasper114a2bc2014-06-03 12:02:45 +0000851 State.Stack.back().HasMultipleNestedBlocks = Current.BlockParameterCount > 1;
Daniel Jasper60553be2014-05-26 13:10:39 +0000852}
853
854void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) {
855 const FormatToken &Current = *State.NextToken;
856 if (!Current.closesScope())
857 return;
858
859 // If we encounter a closing ), ], } or >, we can remove a level from our
860 // stacks.
861 if (State.Stack.size() > 1 &&
862 (Current.isOneOf(tok::r_paren, tok::r_square) ||
863 (Current.is(tok::r_brace) && State.NextToken != State.Line->First) ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000864 State.NextToken->is(TT_TemplateCloser)))
Daniel Jasper60553be2014-05-26 13:10:39 +0000865 State.Stack.pop_back();
Daniel Jasper335ff262014-05-28 09:11:53 +0000866
Daniel Jasper60553be2014-05-26 13:10:39 +0000867 if (Current.is(tok::r_square)) {
868 // If this ends the array subscript expr, reset the corresponding value.
869 const FormatToken *NextNonComment = Current.getNextNonComment();
870 if (NextNonComment && NextNonComment->isNot(tok::l_square))
871 State.Stack.back().StartOfArraySubscripts = 0;
872 }
873}
874
875void ContinuationIndenter::moveStateToNewBlock(LineState &State) {
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000876 unsigned NestedBlockIndent = State.Stack.back().NestedBlockIndent;
Daniel Jasper50d634b2014-10-28 16:53:38 +0000877 // ObjC block sometimes follow special indentation rules.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000878 unsigned NewIndent =
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000879 NestedBlockIndent + (State.NextToken->is(TT_ObjCBlockLBrace)
880 ? Style.ObjCBlockIndentWidth
881 : Style.IndentWidth);
Daniel Jasper60553be2014-05-26 13:10:39 +0000882 State.Stack.push_back(ParenState(
883 NewIndent, /*NewIndentLevel=*/State.Stack.back().IndentLevel + 1,
884 State.Stack.back().LastSpace, /*AvoidBinPacking=*/true,
885 State.Stack.back().NoLineBreak));
Daniel Jasper11a0ac62014-12-12 09:40:58 +0000886 State.Stack.back().NestedBlockIndent = NestedBlockIndent;
Daniel Jasper60553be2014-05-26 13:10:39 +0000887 State.Stack.back().BreakBeforeParameter = true;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000888}
889
Alexander Kornienko917f9e02013-09-10 12:29:48 +0000890unsigned ContinuationIndenter::addMultilineToken(const FormatToken &Current,
891 LineState &State) {
Alexander Kornienkod7b837e2013-08-29 17:32:57 +0000892 // Break before further function parameters on all levels.
893 for (unsigned i = 0, e = State.Stack.size(); i != e; ++i)
894 State.Stack[i].BreakBeforeParameter = true;
895
Alexander Kornienko39856b72013-09-10 09:38:25 +0000896 unsigned ColumnsUsed = State.Column;
Alexander Kornienko632abb92013-09-02 13:58:14 +0000897 // We can only affect layout of the first and the last line, so the penalty
898 // for all other lines is constant, and we ignore it.
Alexander Kornienkoebb43ca2013-09-05 14:08:34 +0000899 State.Column = Current.LastLineColumnWidth;
Alexander Kornienko632abb92013-09-02 13:58:14 +0000900
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +0000901 if (ColumnsUsed > getColumnLimit(State))
902 return Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit(State));
Alexander Kornienkod7b837e2013-08-29 17:32:57 +0000903 return 0;
904}
905
Daniel Jasperde0328a2013-08-16 11:20:30 +0000906unsigned ContinuationIndenter::breakProtrudingToken(const FormatToken &Current,
907 LineState &State,
908 bool DryRun) {
Alexander Kornienko917f9e02013-09-10 12:29:48 +0000909 // Don't break multi-line tokens other than block comments. Instead, just
910 // update the state.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000911 if (Current.isNot(TT_BlockComment) && Current.IsMultiline)
Alexander Kornienko917f9e02013-09-10 12:29:48 +0000912 return addMultilineToken(Current, State);
913
Daniel Jasper616de8642014-11-23 16:46:28 +0000914 // Don't break implicit string literals or import statements.
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000915 if (Current.is(TT_ImplicitStringLiteral) ||
Daniel Jasper616de8642014-11-23 16:46:28 +0000916 State.Line->Type == LT_ImportStatement)
Daniel Jasper98857842013-10-30 13:54:53 +0000917 return 0;
918
Daniel Jasper04b6a082013-12-20 06:22:01 +0000919 if (!Current.isStringLiteral() && !Current.is(tok::comment))
Daniel Jasperf93551c2013-08-23 10:05:49 +0000920 return 0;
921
Ahmed Charlesb8984322014-03-07 20:03:18 +0000922 std::unique_ptr<BreakableToken> Token;
Alexander Kornienko39856b72013-09-10 09:38:25 +0000923 unsigned StartColumn = State.Column - Current.ColumnWidth;
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +0000924 unsigned ColumnLimit = getColumnLimit(State);
Daniel Jasperde0328a2013-08-16 11:20:30 +0000925
Daniel Jasper04b6a082013-12-20 06:22:01 +0000926 if (Current.isStringLiteral()) {
Daniel Jasper428f0b12015-01-04 09:11:17 +0000927 // FIXME: String literal breaking is currently disabled for Java and JS, as
928 // it requires strings to be merged using "+" which we don't support.
929 if (Style.Language == FormatStyle::LK_Java ||
930 Style.Language == FormatStyle::LK_JavaScript)
931 return 0;
932
Alexander Kornienko384b40b2013-10-11 21:43:05 +0000933 // Don't break string literals inside preprocessor directives (except for
934 // #define directives, as their contents are stored in separate lines and
935 // are not affected by this check).
936 // This way we avoid breaking code with line directives and unknown
937 // preprocessor directives that contain long string literals.
938 if (State.Line->Type == LT_PreprocessorDirective)
939 return 0;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000940 // Exempts unterminated string literals from line breaking. The user will
941 // likely want to terminate the string before any line breaking is done.
942 if (Current.IsUnterminatedLiteral)
943 return 0;
944
Alexander Kornienko81e32942013-09-16 20:20:49 +0000945 StringRef Text = Current.TokenText;
946 StringRef Prefix;
947 StringRef Postfix;
Daniel Jasper174b0122014-01-09 14:18:12 +0000948 bool IsNSStringLiteral = false;
Alexander Kornienko81e32942013-09-16 20:20:49 +0000949 // FIXME: Handle whitespace between '_T', '(', '"..."', and ')'.
950 // FIXME: Store Prefix and Suffix (or PrefixLength and SuffixLength to
951 // reduce the overhead) for each FormatToken, which is a string, so that we
952 // don't run multiple checks here on the hot path.
Daniel Jasper174b0122014-01-09 14:18:12 +0000953 if (Text.startswith("\"") && Current.Previous &&
954 Current.Previous->is(tok::at)) {
955 IsNSStringLiteral = true;
956 Prefix = "@\"";
Daniel Jasper174b0122014-01-09 14:18:12 +0000957 }
Alexander Kornienko81e32942013-09-16 20:20:49 +0000958 if ((Text.endswith(Postfix = "\"") &&
Daniel Jasper174b0122014-01-09 14:18:12 +0000959 (IsNSStringLiteral || Text.startswith(Prefix = "\"") ||
960 Text.startswith(Prefix = "u\"") || Text.startswith(Prefix = "U\"") ||
961 Text.startswith(Prefix = "u8\"") ||
Alexander Kornienko81e32942013-09-16 20:20:49 +0000962 Text.startswith(Prefix = "L\""))) ||
Alexander Kornienko732b6bd2014-12-14 20:47:11 +0000963 (Text.startswith(Prefix = "_T(\"") && Text.endswith(Postfix = "\")"))) {
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000964 Token.reset(new BreakableStringLiteral(
965 Current, State.Line->Level, StartColumn, Prefix, Postfix,
966 State.Line->InPPDirective, Encoding, Style));
Alexander Kornienko81e32942013-09-16 20:20:49 +0000967 } else {
968 return 0;
969 }
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000970 } else if (Current.is(TT_BlockComment) && Current.isTrailingComment()) {
Alexander Kornienkoce9161a2014-01-02 15:13:14 +0000971 if (CommentPragmasRegex.match(Current.TokenText.substr(2)))
972 return 0;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000973 Token.reset(new BreakableBlockComment(
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000974 Current, State.Line->Level, StartColumn, Current.OriginalColumn,
975 !Current.Previous, State.Line->InPPDirective, Encoding, Style));
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000976 } else if (Current.is(TT_LineComment) &&
Craig Topper2145bc02014-05-09 08:15:10 +0000977 (Current.Previous == nullptr ||
Daniel Jaspera98b7b02014-11-25 10:05:17 +0000978 Current.Previous->isNot(TT_ImplicitStringLiteral))) {
Alexander Kornienkoce9161a2014-01-02 15:13:14 +0000979 if (CommentPragmasRegex.match(Current.TokenText.substr(2)))
980 return 0;
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000981 Token.reset(new BreakableLineComment(Current, State.Line->Level,
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +0000982 StartColumn, /*InPPDirective=*/false,
Alexander Kornienko3c3d09c2013-09-27 16:14:22 +0000983 Encoding, Style));
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +0000984 // We don't insert backslashes when breaking line comments.
985 ColumnLimit = Style.ColumnLimit;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000986 } else {
987 return 0;
988 }
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +0000989 if (Current.UnbreakableTailLength >= ColumnLimit)
Daniel Jasperde0328a2013-08-16 11:20:30 +0000990 return 0;
991
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +0000992 unsigned RemainingSpace = ColumnLimit - Current.UnbreakableTailLength;
Daniel Jasperde0328a2013-08-16 11:20:30 +0000993 bool BreakInserted = false;
994 unsigned Penalty = 0;
995 unsigned RemainingTokenColumns = 0;
996 for (unsigned LineIndex = 0, EndIndex = Token->getLineCount();
997 LineIndex != EndIndex; ++LineIndex) {
998 if (!DryRun)
999 Token->replaceWhitespaceBefore(LineIndex, Whitespaces);
1000 unsigned TailOffset = 0;
1001 RemainingTokenColumns =
1002 Token->getLineLengthAfterSplit(LineIndex, TailOffset, StringRef::npos);
1003 while (RemainingTokenColumns > RemainingSpace) {
1004 BreakableToken::Split Split =
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +00001005 Token->getSplit(LineIndex, TailOffset, ColumnLimit);
Daniel Jasperde0328a2013-08-16 11:20:30 +00001006 if (Split.first == StringRef::npos) {
1007 // The last line's penalty is handled in addNextStateToQueue().
1008 if (LineIndex < EndIndex - 1)
1009 Penalty += Style.PenaltyExcessCharacter *
1010 (RemainingTokenColumns - RemainingSpace);
1011 break;
1012 }
1013 assert(Split.first != 0);
1014 unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit(
1015 LineIndex, TailOffset + Split.first + Split.second, StringRef::npos);
Alexander Kornienko875395f2013-11-12 17:50:13 +00001016
1017 // We can remove extra whitespace instead of breaking the line.
1018 if (RemainingTokenColumns + 1 - Split.second <= RemainingSpace) {
1019 RemainingTokenColumns = 0;
1020 if (!DryRun)
1021 Token->replaceWhitespace(LineIndex, TailOffset, Split, Whitespaces);
1022 break;
1023 }
1024
Alexander Kornienko64a42b82014-04-15 14:52:43 +00001025 // When breaking before a tab character, it may be moved by a few columns,
1026 // but will still be expanded to the next tab stop, so we don't save any
1027 // columns.
1028 if (NewRemainingTokenColumns == RemainingTokenColumns)
1029 break;
1030
Daniel Jasperde0328a2013-08-16 11:20:30 +00001031 assert(NewRemainingTokenColumns < RemainingTokenColumns);
1032 if (!DryRun)
1033 Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces);
Daniel Jasper2739af32013-08-28 10:03:58 +00001034 Penalty += Current.SplitPenalty;
Daniel Jasperde0328a2013-08-16 11:20:30 +00001035 unsigned ColumnsUsed =
1036 Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first);
Alexander Kornienko3abbb8a2013-11-12 17:30:49 +00001037 if (ColumnsUsed > ColumnLimit) {
1038 Penalty += Style.PenaltyExcessCharacter * (ColumnsUsed - ColumnLimit);
Daniel Jasperde0328a2013-08-16 11:20:30 +00001039 }
1040 TailOffset += Split.first + Split.second;
1041 RemainingTokenColumns = NewRemainingTokenColumns;
1042 BreakInserted = true;
1043 }
1044 }
1045
1046 State.Column = RemainingTokenColumns;
1047
1048 if (BreakInserted) {
1049 // If we break the token inside a parameter list, we need to break before
1050 // the next parameter on all levels, so that the next parameter is clearly
1051 // visible. Line comments already introduce a break.
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001052 if (Current.isNot(TT_LineComment)) {
Daniel Jasperde0328a2013-08-16 11:20:30 +00001053 for (unsigned i = 0, e = State.Stack.size(); i != e; ++i)
1054 State.Stack[i].BreakBeforeParameter = true;
1055 }
1056
Daniel Jasper04b6a082013-12-20 06:22:01 +00001057 Penalty += Current.isStringLiteral() ? Style.PenaltyBreakString
1058 : Style.PenaltyBreakComment;
Daniel Jasper2739af32013-08-28 10:03:58 +00001059
Daniel Jasperde0328a2013-08-16 11:20:30 +00001060 State.Stack.back().LastSpace = StartColumn;
1061 }
1062 return Penalty;
1063}
1064
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001065unsigned ContinuationIndenter::getColumnLimit(const LineState &State) const {
Daniel Jasperde0328a2013-08-16 11:20:30 +00001066 // In preprocessor directives reserve two chars for trailing " \"
Daniel Jasper9fe0e8d2013-09-05 09:29:45 +00001067 return Style.ColumnLimit - (State.Line->InPPDirective ? 2 : 0);
Daniel Jasperde0328a2013-08-16 11:20:30 +00001068}
1069
Daniel Jasperc39b56f2013-12-16 07:23:08 +00001070bool ContinuationIndenter::nextIsMultilineString(const LineState &State) {
Daniel Jasperf438cb72013-08-23 11:57:34 +00001071 const FormatToken &Current = *State.NextToken;
Daniel Jaspera98b7b02014-11-25 10:05:17 +00001072 if (!Current.isStringLiteral() || Current.is(TT_ImplicitStringLiteral))
Daniel Jasperf438cb72013-08-23 11:57:34 +00001073 return false;
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001074 // We never consider raw string literals "multiline" for the purpose of
Daniel Jasperc39b56f2013-12-16 07:23:08 +00001075 // AlwaysBreakBeforeMultilineStrings implementation as they are special-cased
1076 // (see TokenAnnotator::mustBreakBefore().
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001077 if (Current.TokenText.startswith("R\""))
1078 return false;
Alexander Kornienko39856b72013-09-10 09:38:25 +00001079 if (Current.IsMultiline)
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001080 return true;
Daniel Jasperf438cb72013-08-23 11:57:34 +00001081 if (Current.getNextNonComment() &&
Daniel Jasper04b6a082013-12-20 06:22:01 +00001082 Current.getNextNonComment()->isStringLiteral())
Daniel Jasperf438cb72013-08-23 11:57:34 +00001083 return true; // Implicit concatenation.
Alexander Kornienko39856b72013-09-10 09:38:25 +00001084 if (State.Column + Current.ColumnWidth + Current.UnbreakableTailLength >
Daniel Jasperf438cb72013-08-23 11:57:34 +00001085 Style.ColumnLimit)
1086 return true; // String will be split.
Alexander Kornienkod7b837e2013-08-29 17:32:57 +00001087 return false;
Daniel Jasperf438cb72013-08-23 11:57:34 +00001088}
1089
Daniel Jasperde0328a2013-08-16 11:20:30 +00001090} // namespace format
1091} // namespace clang