1 //===--- ContinuationIndenter.cpp - Format C++ code -----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief This file implements the continuation indenter.
13 //===----------------------------------------------------------------------===//
15 #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"
23 #define DEBUG_TYPE "format-indenter"
28 // Returns the length of everything up to the first possible line break after
29 // the ), ], } or > matching \c Tok.
30 static unsigned getLengthToMatchingParen(const FormatToken &Tok) {
31 if (!Tok.MatchingParen)
33 FormatToken *End = Tok.MatchingParen;
34 while (End->Next && !End->Next->CanBreakBefore) {
37 return End->TotalLength - Tok.TotalLength + 1;
40 static unsigned getLengthToNextOperator(const FormatToken &Tok) {
41 if (!Tok.NextOperator)
43 return Tok.NextOperator->TotalLength - Tok.TotalLength;
46 // Returns \c true if \c Tok is the "." or "->" of a call and starts the next
47 // segment of a builder type call.
48 static bool startsSegmentOfBuilderTypeCall(const FormatToken &Tok) {
49 return Tok.isMemberAccess() && Tok.Previous && Tok.Previous->closesScope();
52 // Returns \c true if \c Current starts a new parameter.
53 static bool startsNextParameter(const FormatToken &Current,
54 const FormatStyle &Style) {
55 const FormatToken &Previous = *Current.Previous;
56 if (Current.is(TT_CtorInitializerComma) &&
57 Style.BreakConstructorInitializersBeforeComma)
59 return Previous.is(tok::comma) && !Current.isTrailingComment() &&
60 ((Previous.isNot(TT_CtorInitializerComma) ||
61 !Style.BreakConstructorInitializersBeforeComma) &&
62 (Previous.isNot(TT_InheritanceComma) ||
63 !Style.BreakBeforeInheritanceComma));
66 ContinuationIndenter::ContinuationIndenter(const FormatStyle &Style,
67 const AdditionalKeywords &Keywords,
68 const SourceManager &SourceMgr,
69 WhitespaceManager &Whitespaces,
70 encoding::Encoding Encoding,
71 bool BinPackInconclusiveFunctions)
72 : Style(Style), Keywords(Keywords), SourceMgr(SourceMgr),
73 Whitespaces(Whitespaces), Encoding(Encoding),
74 BinPackInconclusiveFunctions(BinPackInconclusiveFunctions),
75 CommentPragmasRegex(Style.CommentPragmas) {}
77 LineState ContinuationIndenter::getInitialState(unsigned FirstIndent,
78 const AnnotatedLine *Line,
81 State.FirstIndent = FirstIndent;
82 State.Column = FirstIndent;
84 State.NextToken = Line->First;
85 State.Stack.push_back(ParenState(FirstIndent, FirstIndent,
86 /*AvoidBinPacking=*/false,
87 /*NoLineBreak=*/false));
88 State.LineContainsContinuedForLoopSection = false;
89 State.StartOfStringLiteral = 0;
90 State.StartOfLineLevel = 0;
91 State.LowestLevelOnLine = 0;
92 State.IgnoreStackForComparison = false;
94 // The first token has already been indented and thus consumed.
95 moveStateToNextToken(State, DryRun, /*Newline=*/false);
99 bool ContinuationIndenter::canBreak(const LineState &State) {
100 const FormatToken &Current = *State.NextToken;
101 const FormatToken &Previous = *Current.Previous;
102 assert(&Previous == Current.Previous);
103 if (!Current.CanBreakBefore &&
104 !(State.Stack.back().BreakBeforeClosingBrace &&
105 Current.closesBlockOrBlockTypeList(Style)))
107 // The opening "{" of a braced list has to be on the same line as the first
108 // element if it is nested in another braced init list or function call.
109 if (!Current.MustBreakBefore && Previous.is(tok::l_brace) &&
110 Previous.isNot(TT_DictLiteral) && Previous.BlockKind == BK_BracedInit &&
112 Previous.Previous->isOneOf(tok::l_brace, tok::l_paren, tok::comma))
114 // This prevents breaks like:
116 // SomeParameter, OtherParameter).DoSomething(
118 // As they hide "DoSomething" and are generally bad for readability.
119 if (Previous.opensScope() && Previous.isNot(tok::l_brace) &&
120 State.LowestLevelOnLine < State.StartOfLineLevel &&
121 State.LowestLevelOnLine < Current.NestingLevel)
123 if (Current.isMemberAccess() && State.Stack.back().ContainsUnwrappedBuilder)
126 // Don't create a 'hanging' indent if there are multiple blocks in a single
128 if (Previous.is(tok::l_brace) && State.Stack.size() > 1 &&
129 State.Stack[State.Stack.size() - 2].NestedBlockInlined &&
130 State.Stack[State.Stack.size() - 2].HasMultipleNestedBlocks)
133 // Don't break after very short return types (e.g. "void") as that is often
135 if (Current.is(TT_FunctionDeclarationName) && State.Column < 6) {
136 if (Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None)
140 // If binary operators are moved to the next line (including commas for some
141 // styles of constructor initializers), that's always ok.
142 if (!Current.isOneOf(TT_BinaryOperator, tok::comma) &&
143 State.Stack.back().NoLineBreakInOperand)
146 return !State.Stack.back().NoLineBreak;
149 bool ContinuationIndenter::mustBreak(const LineState &State) {
150 const FormatToken &Current = *State.NextToken;
151 const FormatToken &Previous = *Current.Previous;
152 if (Current.MustBreakBefore || Current.is(TT_InlineASMColon))
154 if (State.Stack.back().BreakBeforeClosingBrace &&
155 Current.closesBlockOrBlockTypeList(Style))
157 if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection)
159 if ((startsNextParameter(Current, Style) || Previous.is(tok::semi) ||
160 (Previous.is(TT_TemplateCloser) && Current.is(TT_StartOfName) &&
162 // FIXME: This is a temporary workaround for the case where clang-format
163 // sets BreakBeforeParameter to avoid bin packing and this creates a
164 // completely unnecessary line break after a template type that isn't
166 (Previous.NestingLevel == 1 || Style.BinPackParameters)) ||
167 (Style.BreakBeforeTernaryOperators && Current.is(TT_ConditionalExpr) &&
168 Previous.isNot(tok::question)) ||
169 (!Style.BreakBeforeTernaryOperators &&
170 Previous.is(TT_ConditionalExpr))) &&
171 State.Stack.back().BreakBeforeParameter && !Current.isTrailingComment() &&
172 !Current.isOneOf(tok::r_paren, tok::r_brace))
174 if (((Previous.is(TT_DictLiteral) && Previous.is(tok::l_brace)) ||
175 (Previous.is(TT_ArrayInitializerLSquare) &&
176 Previous.ParameterCount > 1)) &&
177 Style.ColumnLimit > 0 &&
178 getLengthToMatchingParen(Previous) + State.Column - 1 >
179 getColumnLimit(State))
181 if (Current.is(TT_CtorInitializerColon) &&
182 (State.Column + State.Line->Last->TotalLength - Current.TotalLength + 2 >
183 getColumnLimit(State) ||
184 State.Stack.back().BreakBeforeParameter) &&
185 ((Style.AllowShortFunctionsOnASingleLine != FormatStyle::SFS_All) ||
186 Style.BreakConstructorInitializersBeforeComma || Style.ColumnLimit != 0))
188 if (Current.is(TT_ObjCMethodExpr) && !Previous.is(TT_SelectorName) &&
189 State.Line->startsWith(TT_ObjCMethodSpecifier))
191 if (Current.is(TT_SelectorName) && State.Stack.back().ObjCSelectorNameFound &&
192 State.Stack.back().BreakBeforeParameter)
195 unsigned NewLineColumn = getNewLineColumn(State);
196 if (Current.isMemberAccess() && Style.ColumnLimit != 0 &&
197 State.Column + getLengthToNextOperator(Current) > Style.ColumnLimit &&
198 (State.Column > NewLineColumn ||
199 Current.NestingLevel < State.StartOfLineLevel))
202 if (startsSegmentOfBuilderTypeCall(Current) &&
203 (State.Stack.back().CallContinuation != 0 ||
204 State.Stack.back().BreakBeforeParameter) &&
205 // JavaScript is treated different here as there is a frequent pattern:
206 // SomeFunction(function() {
209 // FIXME: We should find a more generic solution to this problem.
210 !(State.Column <= NewLineColumn &&
211 Style.Language == FormatStyle::LK_JavaScript))
214 if (State.Column <= NewLineColumn)
217 if (Style.AlwaysBreakBeforeMultilineStrings &&
218 (NewLineColumn == State.FirstIndent + Style.ContinuationIndentWidth ||
219 Previous.is(tok::comma) || Current.NestingLevel < 2) &&
220 !Previous.isOneOf(tok::kw_return, tok::lessless, tok::at) &&
221 !Previous.isOneOf(TT_InlineASMColon, TT_ConditionalExpr) &&
222 nextIsMultilineString(State))
225 // Using CanBreakBefore here and below takes care of the decision whether the
226 // current style uses wrapping before or after operators for the given
228 if (Previous.is(TT_BinaryOperator) && Current.CanBreakBefore) {
229 // If we need to break somewhere inside the LHS of a binary expression, we
230 // should also break after the operator. Otherwise, the formatting would
231 // hide the operator precedence, e.g. in:
232 // if (aaaaaaaaaaaaaa ==
233 // bbbbbbbbbbbbbb && c) {..
234 // For comparisons, we only apply this rule, if the LHS is a binary
235 // expression itself as otherwise, the line breaks seem superfluous.
236 // We need special cases for ">>" which we have split into two ">" while
237 // lexing in order to make template parsing easier.
238 bool IsComparison = (Previous.getPrecedence() == prec::Relational ||
239 Previous.getPrecedence() == prec::Equality) &&
241 Previous.Previous->isNot(TT_BinaryOperator); // For >>.
242 bool LHSIsBinaryExpr =
243 Previous.Previous && Previous.Previous->EndsBinaryExpression;
244 if ((!IsComparison || LHSIsBinaryExpr) && !Current.isTrailingComment() &&
245 Previous.getPrecedence() != prec::Assignment &&
246 State.Stack.back().BreakBeforeParameter)
248 } else if (Current.is(TT_BinaryOperator) && Current.CanBreakBefore &&
249 State.Stack.back().BreakBeforeParameter) {
253 // Same as above, but for the first "<<" operator.
254 if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator) &&
255 State.Stack.back().BreakBeforeParameter &&
256 State.Stack.back().FirstLessLess == 0)
259 if (Current.NestingLevel == 0 && !Current.isTrailingComment()) {
260 // Always break after "template <...>" and leading annotations. This is only
261 // for cases where the entire line does not fit on a single line as a
262 // different LineFormatter would be used otherwise.
263 if (Previous.ClosesTemplateDeclaration)
265 if (Previous.is(TT_FunctionAnnotationRParen))
267 if (Previous.is(TT_LeadingJavaAnnotation) && Current.isNot(tok::l_paren) &&
268 Current.isNot(TT_LeadingJavaAnnotation))
272 // If the return type spans multiple lines, wrap before the function name.
273 if ((Current.is(TT_FunctionDeclarationName) ||
274 (Current.is(tok::kw_operator) && !Previous.is(tok::coloncolon))) &&
275 !Previous.is(tok::kw_template) && State.Stack.back().BreakBeforeParameter)
278 // The following could be precomputed as they do not depend on the state.
279 // However, as they should take effect only if the UnwrappedLine does not fit
280 // into the ColumnLimit, they are checked here in the ContinuationIndenter.
281 if (Style.ColumnLimit != 0 && Previous.BlockKind == BK_Block &&
282 Previous.is(tok::l_brace) && !Current.isOneOf(tok::r_brace, tok::comment))
285 if (Current.is(tok::lessless) &&
286 ((Previous.is(tok::identifier) && Previous.TokenText == "endl") ||
287 (Previous.Tok.isLiteral() && (Previous.TokenText.endswith("\\n\"") ||
288 Previous.TokenText == "\'\\n\'"))))
294 unsigned ContinuationIndenter::addTokenToState(LineState &State, bool Newline,
296 unsigned ExtraSpaces) {
297 const FormatToken &Current = *State.NextToken;
299 assert(!State.Stack.empty());
300 if ((Current.is(TT_ImplicitStringLiteral) &&
301 (Current.Previous->Tok.getIdentifierInfo() == nullptr ||
302 Current.Previous->Tok.getIdentifierInfo()->getPPKeywordID() ==
303 tok::pp_not_keyword))) {
305 SourceMgr.getSpellingColumnNumber(Current.WhitespaceRange.getEnd());
306 if (Current.LastNewlineOffset != 0) {
307 // If there is a newline within this token, the final column will solely
308 // determined by the current end column.
309 State.Column = EndColumn;
311 unsigned StartColumn =
312 SourceMgr.getSpellingColumnNumber(Current.WhitespaceRange.getBegin());
313 assert(EndColumn >= StartColumn);
314 State.Column += EndColumn - StartColumn;
316 moveStateToNextToken(State, DryRun, /*Newline=*/false);
320 unsigned Penalty = 0;
322 Penalty = addTokenOnNewLine(State, DryRun);
324 addTokenOnCurrentLine(State, DryRun, ExtraSpaces);
326 return moveStateToNextToken(State, DryRun, Newline) + Penalty;
329 void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun,
330 unsigned ExtraSpaces) {
331 FormatToken &Current = *State.NextToken;
332 const FormatToken &Previous = *State.NextToken->Previous;
333 if (Current.is(tok::equal) &&
334 (State.Line->First->is(tok::kw_for) || Current.NestingLevel == 0) &&
335 State.Stack.back().VariablePos == 0) {
336 State.Stack.back().VariablePos = State.Column;
337 // Move over * and & if they are bound to the variable name.
338 const FormatToken *Tok = &Previous;
339 while (Tok && State.Stack.back().VariablePos >= Tok->ColumnWidth) {
340 State.Stack.back().VariablePos -= Tok->ColumnWidth;
341 if (Tok->SpacesRequiredBefore != 0)
345 if (Previous.PartOfMultiVariableDeclStmt)
346 State.Stack.back().LastSpace = State.Stack.back().VariablePos;
349 unsigned Spaces = Current.SpacesRequiredBefore + ExtraSpaces;
352 Whitespaces.replaceWhitespace(Current, /*Newlines=*/0, Spaces,
353 State.Column + Spaces);
355 // If "BreakBeforeInheritanceComma" mode, don't break within the inheritance
356 // declaration unless there is multiple inheritance.
357 if (Style.BreakBeforeInheritanceComma && Current.is(TT_InheritanceColon))
358 State.Stack.back().NoLineBreak = true;
360 if (Current.is(TT_SelectorName) &&
361 !State.Stack.back().ObjCSelectorNameFound) {
363 std::max(State.FirstIndent + Style.ContinuationIndentWidth,
364 State.Stack.back().Indent);
365 unsigned FirstColonPos = State.Column + Spaces + Current.ColumnWidth;
366 if (Current.LongestObjCSelectorName == 0)
367 State.Stack.back().AlignColons = false;
368 else if (MinIndent + Current.LongestObjCSelectorName > FirstColonPos)
369 State.Stack.back().ColonPos = MinIndent + Current.LongestObjCSelectorName;
371 State.Stack.back().ColonPos = FirstColonPos;
374 // In "AlwaysBreak" mode, enforce wrapping directly after the parenthesis by
375 // disallowing any further line breaks if there is no line break after the
376 // opening parenthesis. Don't break if it doesn't conserve columns.
377 if (Style.AlignAfterOpenBracket == FormatStyle::BAS_AlwaysBreak &&
378 Previous.isOneOf(tok::l_paren, TT_TemplateOpener, tok::l_square) &&
379 State.Column > getNewLineColumn(State) &&
380 (!Previous.Previous ||
381 !Previous.Previous->isOneOf(tok::kw_for, tok::kw_while,
383 // Don't do this for simple (no expressions) one-argument function calls
384 // as that feels like needlessly wasting whitespace, e.g.:
389 // caaaaaaaaaaaaaaaaaaaaaaall(aaaaaaaaaaaaaa, aaaaaaaaa))));
390 Current.FakeLParens.size() > 0 &&
391 Current.FakeLParens.back() > prec::Unknown)
392 State.Stack.back().NoLineBreak = true;
393 if (Previous.is(TT_TemplateString) && Previous.opensScope())
394 State.Stack.back().NoLineBreak = true;
396 if (Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign &&
397 Previous.opensScope() && Previous.isNot(TT_ObjCMethodExpr) &&
398 (Current.isNot(TT_LineComment) || Previous.BlockKind == BK_BracedInit))
399 State.Stack.back().Indent = State.Column + Spaces;
400 if (State.Stack.back().AvoidBinPacking && startsNextParameter(Current, Style))
401 State.Stack.back().NoLineBreak = true;
402 if (startsSegmentOfBuilderTypeCall(Current) &&
403 State.Column > getNewLineColumn(State))
404 State.Stack.back().ContainsUnwrappedBuilder = true;
406 if (Current.is(TT_LambdaArrow) && Style.Language == FormatStyle::LK_Java)
407 State.Stack.back().NoLineBreak = true;
408 if (Current.isMemberAccess() && Previous.is(tok::r_paren) &&
409 (Previous.MatchingParen &&
410 (Previous.TotalLength - Previous.MatchingParen->TotalLength > 10)))
411 // If there is a function call with long parameters, break before trailing
412 // calls. This prevents things like:
413 // EXPECT_CALL(SomeLongParameter).Times(
415 // We don't want to do this for short parameters as they can just be
417 State.Stack.back().NoLineBreak = true;
419 // Don't allow the RHS of an operator to be split over multiple lines unless
420 // there is a line-break right after the operator.
421 // Exclude relational operators, as there, it is always more desirable to
422 // have the LHS 'left' of the RHS.
423 const FormatToken *P = Current.getPreviousNonComment();
424 if (!Current.is(tok::comment) && P &&
425 (P->isOneOf(TT_BinaryOperator, tok::comma) ||
426 (P->is(TT_ConditionalExpr) && P->is(tok::colon))) &&
427 !P->isOneOf(TT_OverloadedOperator, TT_CtorInitializerComma) &&
428 P->getPrecedence() != prec::Assignment &&
429 P->getPrecedence() != prec::Relational) {
430 bool BreakBeforeOperator =
431 P->MustBreakBefore || P->is(tok::lessless) ||
432 (P->is(TT_BinaryOperator) &&
433 Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None) ||
434 (P->is(TT_ConditionalExpr) && Style.BreakBeforeTernaryOperators);
435 // Don't do this if there are only two operands. In these cases, there is
436 // always a nice vertical separation between them and the extra line break
438 bool HasTwoOperands =
439 P->OperatorIndex == 0 && !P->NextOperator && !P->is(TT_ConditionalExpr);
440 if ((!BreakBeforeOperator && !(HasTwoOperands && Style.AlignOperands)) ||
441 (!State.Stack.back().LastOperatorWrapped && BreakBeforeOperator))
442 State.Stack.back().NoLineBreakInOperand = true;
445 State.Column += Spaces;
446 if (Current.isNot(tok::comment) && Previous.is(tok::l_paren) &&
448 Previous.Previous->isOneOf(tok::kw_if, tok::kw_for)) {
449 // Treat the condition inside an if as if it was a second function
450 // parameter, i.e. let nested calls have a continuation indent.
451 State.Stack.back().LastSpace = State.Column;
452 State.Stack.back().NestedBlockIndent = State.Column;
453 } else if (!Current.isOneOf(tok::comment, tok::caret) &&
454 ((Previous.is(tok::comma) &&
455 !Previous.is(TT_OverloadedOperator)) ||
456 (Previous.is(tok::colon) && Previous.is(TT_ObjCMethodExpr)))) {
457 State.Stack.back().LastSpace = State.Column;
458 } else if ((Previous.isOneOf(TT_BinaryOperator, TT_ConditionalExpr,
459 TT_CtorInitializerColon)) &&
460 ((Previous.getPrecedence() != prec::Assignment &&
461 (Previous.isNot(tok::lessless) || Previous.OperatorIndex != 0 ||
462 Previous.NextOperator)) ||
463 Current.StartsBinaryExpression)) {
464 // Indent relative to the RHS of the expression unless this is a simple
465 // assignment without binary expression on the RHS. Also indent relative to
466 // unary operators and the colons of constructor initializers.
467 State.Stack.back().LastSpace = State.Column;
468 } else if (Previous.is(TT_InheritanceColon)) {
469 State.Stack.back().Indent = State.Column;
470 State.Stack.back().LastSpace = State.Column;
471 } else if (Previous.opensScope()) {
472 // If a function has a trailing call, indent all parameters from the
473 // opening parenthesis. This avoids confusing indents like:
474 // OuterFunction(InnerFunctionCall( // break
475 // ParameterToInnerFunction)) // break
476 // .SecondInnerFunctionCall();
477 bool HasTrailingCall = false;
478 if (Previous.MatchingParen) {
479 const FormatToken *Next = Previous.MatchingParen->getNextNonComment();
480 HasTrailingCall = Next && Next->isMemberAccess();
482 if (HasTrailingCall && State.Stack.size() > 1 &&
483 State.Stack[State.Stack.size() - 2].CallContinuation == 0)
484 State.Stack.back().LastSpace = State.Column;
488 unsigned ContinuationIndenter::addTokenOnNewLine(LineState &State,
490 FormatToken &Current = *State.NextToken;
491 const FormatToken &Previous = *State.NextToken->Previous;
493 // Extra penalty that needs to be added because of the way certain line
494 // breaks are chosen.
495 unsigned Penalty = 0;
497 const FormatToken *PreviousNonComment = Current.getPreviousNonComment();
498 const FormatToken *NextNonComment = Previous.getNextNonComment();
500 NextNonComment = &Current;
501 // The first line break on any NestingLevel causes an extra penalty in order
502 // prefer similar line breaks.
503 if (!State.Stack.back().ContainsLineBreak)
505 State.Stack.back().ContainsLineBreak = true;
507 Penalty += State.NextToken->SplitPenalty;
509 // Breaking before the first "<<" is generally not desirable if the LHS is
510 // short. Also always add the penalty if the LHS is split over multiple lines
511 // to avoid unnecessary line breaks that just work around this penalty.
512 if (NextNonComment->is(tok::lessless) &&
513 State.Stack.back().FirstLessLess == 0 &&
514 (State.Column <= Style.ColumnLimit / 3 ||
515 State.Stack.back().BreakBeforeParameter))
516 Penalty += Style.PenaltyBreakFirstLessLess;
518 State.Column = getNewLineColumn(State);
520 // Indent nested blocks relative to this column, unless in a very specific
521 // JavaScript special case where:
523 // var loooooong_name =
528 // is common and should be formatted like a free-standing function. The same
529 // goes for wrapping before the lambda return type arrow.
530 if (!Current.is(TT_LambdaArrow) &&
531 (Style.Language != FormatStyle::LK_JavaScript ||
532 Current.NestingLevel != 0 || !PreviousNonComment ||
533 !PreviousNonComment->is(tok::equal) ||
534 !Current.isOneOf(Keywords.kw_async, Keywords.kw_function)))
535 State.Stack.back().NestedBlockIndent = State.Column;
537 if (NextNonComment->isMemberAccess()) {
538 if (State.Stack.back().CallContinuation == 0)
539 State.Stack.back().CallContinuation = State.Column;
540 } else if (NextNonComment->is(TT_SelectorName)) {
541 if (!State.Stack.back().ObjCSelectorNameFound) {
542 if (NextNonComment->LongestObjCSelectorName == 0) {
543 State.Stack.back().AlignColons = false;
545 State.Stack.back().ColonPos =
546 (Style.IndentWrappedFunctionNames
547 ? std::max(State.Stack.back().Indent,
548 State.FirstIndent + Style.ContinuationIndentWidth)
549 : State.Stack.back().Indent) +
550 NextNonComment->LongestObjCSelectorName;
552 } else if (State.Stack.back().AlignColons &&
553 State.Stack.back().ColonPos <= NextNonComment->ColumnWidth) {
554 State.Stack.back().ColonPos = State.Column + NextNonComment->ColumnWidth;
556 } else if (PreviousNonComment && PreviousNonComment->is(tok::colon) &&
557 PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral)) {
558 // FIXME: This is hacky, find a better way. The problem is that in an ObjC
559 // method expression, the block should be aligned to the line starting it,
561 // [aaaaaaaaaaaaaaa aaaaaaaaa: \\ break for some reason
565 // Thus, we set LastSpace of the next higher NestingLevel, to which we move
566 // when we consume all of the "}"'s FakeRParens at the "{".
567 if (State.Stack.size() > 1)
568 State.Stack[State.Stack.size() - 2].LastSpace =
569 std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) +
570 Style.ContinuationIndentWidth;
573 if ((PreviousNonComment &&
574 PreviousNonComment->isOneOf(tok::comma, tok::semi) &&
575 !State.Stack.back().AvoidBinPacking) ||
576 Previous.is(TT_BinaryOperator))
577 State.Stack.back().BreakBeforeParameter = false;
578 if (Previous.isOneOf(TT_TemplateCloser, TT_JavaAnnotation) &&
579 Current.NestingLevel == 0)
580 State.Stack.back().BreakBeforeParameter = false;
581 if (NextNonComment->is(tok::question) ||
582 (PreviousNonComment && PreviousNonComment->is(tok::question)))
583 State.Stack.back().BreakBeforeParameter = true;
584 if (Current.is(TT_BinaryOperator) && Current.CanBreakBefore)
585 State.Stack.back().BreakBeforeParameter = false;
588 unsigned Newlines = std::max(
589 1u, std::min(Current.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1));
590 Whitespaces.replaceWhitespace(Current, Newlines, State.Column, State.Column,
591 State.Line->InPPDirective);
594 if (!Current.isTrailingComment())
595 State.Stack.back().LastSpace = State.Column;
596 if (Current.is(tok::lessless))
597 // If we are breaking before a "<<", we always want to indent relative to
598 // RHS. This is necessary only for "<<", as we special-case it and don't
599 // always indent relative to the RHS.
600 State.Stack.back().LastSpace += 3; // 3 -> width of "<< ".
602 State.StartOfLineLevel = Current.NestingLevel;
603 State.LowestLevelOnLine = Current.NestingLevel;
605 // Any break on this level means that the parent level has been broken
606 // and we need to avoid bin packing there.
607 bool NestedBlockSpecialCase =
608 !Style.isCpp() && Current.is(tok::r_brace) && State.Stack.size() > 1 &&
609 State.Stack[State.Stack.size() - 2].NestedBlockInlined;
610 if (!NestedBlockSpecialCase)
611 for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i)
612 State.Stack[i].BreakBeforeParameter = true;
614 if (PreviousNonComment &&
615 !PreviousNonComment->isOneOf(tok::comma, tok::semi) &&
616 (PreviousNonComment->isNot(TT_TemplateCloser) ||
617 Current.NestingLevel != 0) &&
618 !PreviousNonComment->isOneOf(
619 TT_BinaryOperator, TT_FunctionAnnotationRParen, TT_JavaAnnotation,
620 TT_LeadingJavaAnnotation) &&
621 Current.isNot(TT_BinaryOperator) && !PreviousNonComment->opensScope())
622 State.Stack.back().BreakBeforeParameter = true;
624 // If we break after { or the [ of an array initializer, we should also break
625 // before the corresponding } or ].
626 if (PreviousNonComment &&
627 (PreviousNonComment->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) ||
628 (PreviousNonComment->is(TT_TemplateString) &&
629 PreviousNonComment->opensScope())))
630 State.Stack.back().BreakBeforeClosingBrace = true;
632 if (State.Stack.back().AvoidBinPacking) {
633 // If we are breaking after '(', '{', '<', this is not bin packing
634 // unless AllowAllParametersOfDeclarationOnNextLine is false or this is a
635 // dict/object literal.
636 if (!Previous.isOneOf(tok::l_paren, tok::l_brace, TT_BinaryOperator) ||
637 (!Style.AllowAllParametersOfDeclarationOnNextLine &&
638 State.Line->MustBeDeclaration) ||
639 Previous.is(TT_DictLiteral))
640 State.Stack.back().BreakBeforeParameter = true;
646 unsigned ContinuationIndenter::getNewLineColumn(const LineState &State) {
647 if (!State.NextToken || !State.NextToken->Previous)
649 FormatToken &Current = *State.NextToken;
650 const FormatToken &Previous = *Current.Previous;
651 // If we are continuing an expression, we want to use the continuation indent.
652 unsigned ContinuationIndent =
653 std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) +
654 Style.ContinuationIndentWidth;
655 const FormatToken *PreviousNonComment = Current.getPreviousNonComment();
656 const FormatToken *NextNonComment = Previous.getNextNonComment();
658 NextNonComment = &Current;
660 // Java specific bits.
661 if (Style.Language == FormatStyle::LK_Java &&
662 Current.isOneOf(Keywords.kw_implements, Keywords.kw_extends))
663 return std::max(State.Stack.back().LastSpace,
664 State.Stack.back().Indent + Style.ContinuationIndentWidth);
666 if (NextNonComment->is(tok::l_brace) && NextNonComment->BlockKind == BK_Block)
667 return Current.NestingLevel == 0 ? State.FirstIndent
668 : State.Stack.back().Indent;
669 if (Current.isOneOf(tok::r_brace, tok::r_square) && State.Stack.size() > 1) {
670 if (Current.closesBlockOrBlockTypeList(Style))
671 return State.Stack[State.Stack.size() - 2].NestedBlockIndent;
672 if (Current.MatchingParen &&
673 Current.MatchingParen->BlockKind == BK_BracedInit)
674 return State.Stack[State.Stack.size() - 2].LastSpace;
675 return State.FirstIndent;
677 if (NextNonComment->is(TT_TemplateString) && NextNonComment->closesScope())
678 return State.Stack[State.Stack.size() - 2].LastSpace;
679 if (Current.is(tok::identifier) && Current.Next &&
680 Current.Next->is(TT_DictLiteral))
681 return State.Stack.back().Indent;
682 if (NextNonComment->is(TT_ObjCStringLiteral) &&
683 State.StartOfStringLiteral != 0)
684 return State.StartOfStringLiteral - 1;
685 if (NextNonComment->isStringLiteral() && State.StartOfStringLiteral != 0)
686 return State.StartOfStringLiteral;
687 if (NextNonComment->is(tok::lessless) &&
688 State.Stack.back().FirstLessLess != 0)
689 return State.Stack.back().FirstLessLess;
690 if (NextNonComment->isMemberAccess()) {
691 if (State.Stack.back().CallContinuation == 0)
692 return ContinuationIndent;
693 return State.Stack.back().CallContinuation;
695 if (State.Stack.back().QuestionColumn != 0 &&
696 ((NextNonComment->is(tok::colon) &&
697 NextNonComment->is(TT_ConditionalExpr)) ||
698 Previous.is(TT_ConditionalExpr)))
699 return State.Stack.back().QuestionColumn;
700 if (Previous.is(tok::comma) && State.Stack.back().VariablePos != 0)
701 return State.Stack.back().VariablePos;
702 if ((PreviousNonComment &&
703 (PreviousNonComment->ClosesTemplateDeclaration ||
704 PreviousNonComment->isOneOf(
705 TT_AttributeParen, TT_FunctionAnnotationRParen, TT_JavaAnnotation,
706 TT_LeadingJavaAnnotation))) ||
707 (!Style.IndentWrappedFunctionNames &&
708 NextNonComment->isOneOf(tok::kw_operator, TT_FunctionDeclarationName)))
709 return std::max(State.Stack.back().LastSpace, State.Stack.back().Indent);
710 if (NextNonComment->is(TT_SelectorName)) {
711 if (!State.Stack.back().ObjCSelectorNameFound) {
712 if (NextNonComment->LongestObjCSelectorName == 0)
713 return State.Stack.back().Indent;
714 return (Style.IndentWrappedFunctionNames
715 ? std::max(State.Stack.back().Indent,
716 State.FirstIndent + Style.ContinuationIndentWidth)
717 : State.Stack.back().Indent) +
718 NextNonComment->LongestObjCSelectorName -
719 NextNonComment->ColumnWidth;
721 if (!State.Stack.back().AlignColons)
722 return State.Stack.back().Indent;
723 if (State.Stack.back().ColonPos > NextNonComment->ColumnWidth)
724 return State.Stack.back().ColonPos - NextNonComment->ColumnWidth;
725 return State.Stack.back().Indent;
727 if (NextNonComment->is(tok::colon) && NextNonComment->is(TT_ObjCMethodExpr))
728 return State.Stack.back().ColonPos;
729 if (NextNonComment->is(TT_ArraySubscriptLSquare)) {
730 if (State.Stack.back().StartOfArraySubscripts != 0)
731 return State.Stack.back().StartOfArraySubscripts;
732 return ContinuationIndent;
735 // This ensure that we correctly format ObjC methods calls without inputs,
736 // i.e. where the last element isn't selector like: [callee method];
737 if (NextNonComment->is(tok::identifier) && NextNonComment->FakeRParens == 0 &&
738 NextNonComment->Next && NextNonComment->Next->is(TT_ObjCMethodExpr))
739 return State.Stack.back().Indent;
741 if (NextNonComment->isOneOf(TT_StartOfName, TT_PointerOrReference) ||
742 Previous.isOneOf(tok::coloncolon, tok::equal, TT_JsTypeColon))
743 return ContinuationIndent;
744 if (PreviousNonComment && PreviousNonComment->is(tok::colon) &&
745 PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral))
746 return ContinuationIndent;
747 if (NextNonComment->is(TT_CtorInitializerComma))
748 return State.Stack.back().Indent;
749 if (NextNonComment->isOneOf(TT_CtorInitializerColon, TT_InheritanceColon,
750 TT_InheritanceComma))
751 return State.FirstIndent + Style.ConstructorInitializerIndentWidth;
752 if (Previous.is(tok::r_paren) && !Current.isBinaryOperator() &&
753 !Current.isOneOf(tok::colon, tok::comment))
754 return ContinuationIndent;
755 if (State.Stack.back().Indent == State.FirstIndent && PreviousNonComment &&
756 PreviousNonComment->isNot(tok::r_brace))
757 // Ensure that we fall back to the continuation indent width instead of
758 // just flushing continuations left.
759 return State.Stack.back().Indent + Style.ContinuationIndentWidth;
760 return State.Stack.back().Indent;
763 unsigned ContinuationIndenter::moveStateToNextToken(LineState &State,
764 bool DryRun, bool Newline) {
765 assert(State.Stack.size());
766 const FormatToken &Current = *State.NextToken;
768 if (Current.isOneOf(tok::comma, TT_BinaryOperator))
769 State.Stack.back().NoLineBreakInOperand = false;
770 if (Current.is(TT_InheritanceColon))
771 State.Stack.back().AvoidBinPacking = true;
772 if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator)) {
773 if (State.Stack.back().FirstLessLess == 0)
774 State.Stack.back().FirstLessLess = State.Column;
776 State.Stack.back().LastOperatorWrapped = Newline;
778 if (Current.is(TT_BinaryOperator) && Current.isNot(tok::lessless))
779 State.Stack.back().LastOperatorWrapped = Newline;
780 if (Current.is(TT_ConditionalExpr) && Current.Previous &&
781 !Current.Previous->is(TT_ConditionalExpr))
782 State.Stack.back().LastOperatorWrapped = Newline;
783 if (Current.is(TT_ArraySubscriptLSquare) &&
784 State.Stack.back().StartOfArraySubscripts == 0)
785 State.Stack.back().StartOfArraySubscripts = State.Column;
786 if (Style.BreakBeforeTernaryOperators && Current.is(tok::question))
787 State.Stack.back().QuestionColumn = State.Column;
788 if (!Style.BreakBeforeTernaryOperators && Current.isNot(tok::colon)) {
789 const FormatToken *Previous = Current.Previous;
790 while (Previous && Previous->isTrailingComment())
791 Previous = Previous->Previous;
792 if (Previous && Previous->is(tok::question))
793 State.Stack.back().QuestionColumn = State.Column;
795 if (!Current.opensScope() && !Current.closesScope() &&
796 !Current.is(TT_PointerOrReference))
797 State.LowestLevelOnLine =
798 std::min(State.LowestLevelOnLine, Current.NestingLevel);
799 if (Current.isMemberAccess())
800 State.Stack.back().StartOfFunctionCall =
801 !Current.NextOperator ? 0 : State.Column;
802 if (Current.is(TT_SelectorName)) {
803 State.Stack.back().ObjCSelectorNameFound = true;
804 if (Style.IndentWrappedFunctionNames) {
805 State.Stack.back().Indent =
806 State.FirstIndent + Style.ContinuationIndentWidth;
809 if (Current.is(TT_CtorInitializerColon)) {
810 // Indent 2 from the column, so:
811 // SomeClass::SomeClass()
815 State.Stack.back().Indent =
816 State.Column + (Style.BreakConstructorInitializersBeforeComma ? 0 : 2);
817 State.Stack.back().NestedBlockIndent = State.Stack.back().Indent;
818 if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
819 State.Stack.back().AvoidBinPacking = true;
820 State.Stack.back().BreakBeforeParameter = false;
822 if (Current.is(TT_InheritanceColon))
823 State.Stack.back().Indent =
824 State.FirstIndent + Style.ContinuationIndentWidth;
825 if (Current.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) && Newline)
826 State.Stack.back().NestedBlockIndent =
827 State.Column + Current.ColumnWidth + 1;
828 if (Current.isOneOf(TT_LambdaLSquare, TT_LambdaArrow))
829 State.Stack.back().LastSpace = State.Column;
831 // Insert scopes created by fake parenthesis.
832 const FormatToken *Previous = Current.getPreviousNonComment();
834 // Add special behavior to support a format commonly used for JavaScript
836 // SomeFunction(function() {
840 if (Current.isNot(tok::comment) && Previous &&
841 Previous->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) &&
842 !Previous->is(TT_DictLiteral) && State.Stack.size() > 1) {
843 if (State.Stack[State.Stack.size() - 2].NestedBlockInlined && Newline)
844 for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i)
845 State.Stack[i].NoLineBreak = true;
846 State.Stack[State.Stack.size() - 2].NestedBlockInlined = false;
848 if (Previous && (Previous->isOneOf(tok::l_paren, tok::comma, tok::colon) ||
849 Previous->isOneOf(TT_BinaryOperator, TT_ConditionalExpr)) &&
850 !Previous->isOneOf(TT_DictLiteral, TT_ObjCMethodExpr)) {
851 State.Stack.back().NestedBlockInlined =
853 (Previous->isNot(tok::l_paren) || Previous->ParameterCount > 1);
856 moveStatePastFakeLParens(State, Newline);
857 moveStatePastScopeCloser(State);
858 if (Current.is(TT_TemplateString) && Current.opensScope())
859 State.Stack.back().LastSpace =
860 (Current.IsMultiline ? Current.LastLineColumnWidth
861 : State.Column + Current.ColumnWidth) -
863 bool CanBreakProtrudingToken = !State.Stack.back().NoLineBreak &&
864 !State.Stack.back().NoLineBreakInOperand;
865 moveStatePastScopeOpener(State, Newline);
866 moveStatePastFakeRParens(State);
868 if (Current.is(TT_ObjCStringLiteral) && State.StartOfStringLiteral == 0)
869 State.StartOfStringLiteral = State.Column + 1;
870 else if (Current.isStringLiteral() && State.StartOfStringLiteral == 0)
871 State.StartOfStringLiteral = State.Column;
872 else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash) &&
873 !Current.isStringLiteral())
874 State.StartOfStringLiteral = 0;
876 State.Column += Current.ColumnWidth;
877 State.NextToken = State.NextToken->Next;
878 unsigned Penalty = 0;
879 if (CanBreakProtrudingToken)
880 Penalty = breakProtrudingToken(Current, State, DryRun);
881 if (State.Column > getColumnLimit(State)) {
882 unsigned ExcessCharacters = State.Column - getColumnLimit(State);
883 Penalty += Style.PenaltyExcessCharacter * ExcessCharacters;
887 Current.Role->formatFromToken(State, this, DryRun);
888 // If the previous has a special role, let it consume tokens as appropriate.
889 // It is necessary to start at the previous token for the only implemented
890 // role (comma separated list). That way, the decision whether or not to break
891 // after the "{" is already done and both options are tried and evaluated.
892 // FIXME: This is ugly, find a better way.
893 if (Previous && Previous->Role)
894 Penalty += Previous->Role->formatAfterToken(State, this, DryRun);
899 void ContinuationIndenter::moveStatePastFakeLParens(LineState &State,
901 const FormatToken &Current = *State.NextToken;
902 const FormatToken *Previous = Current.getPreviousNonComment();
904 // Don't add extra indentation for the first fake parenthesis after
905 // 'return', assignments or opening <({[. The indentation for these cases
907 bool SkipFirstExtraIndent =
908 (Previous && (Previous->opensScope() ||
909 Previous->isOneOf(tok::semi, tok::kw_return) ||
910 (Previous->getPrecedence() == prec::Assignment &&
911 Style.AlignOperands) ||
912 Previous->is(TT_ObjCMethodExpr)));
913 for (SmallVectorImpl<prec::Level>::const_reverse_iterator
914 I = Current.FakeLParens.rbegin(),
915 E = Current.FakeLParens.rend();
917 ParenState NewParenState = State.Stack.back();
918 NewParenState.ContainsLineBreak = false;
919 NewParenState.LastOperatorWrapped = true;
920 NewParenState.NoLineBreak =
921 NewParenState.NoLineBreak || State.Stack.back().NoLineBreakInOperand;
923 // Indent from 'LastSpace' unless these are fake parentheses encapsulating
924 // a builder type call after 'return' or, if the alignment after opening
925 // brackets is disabled.
926 if (!Current.isTrailingComment() &&
927 (Style.AlignOperands || *I < prec::Assignment) &&
928 (!Previous || Previous->isNot(tok::kw_return) ||
929 (Style.Language != FormatStyle::LK_Java && *I > 0)) &&
930 (Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign ||
931 *I != prec::Comma || Current.NestingLevel == 0))
932 NewParenState.Indent =
933 std::max(std::max(State.Column, NewParenState.Indent),
934 State.Stack.back().LastSpace);
936 // Do not indent relative to the fake parentheses inserted for "." or "->".
937 // This is a special case to make the following to statements consistent:
938 // OuterFunction(InnerFunctionCall( // break
939 // ParameterToInnerFunction));
940 // OuterFunction(SomeObject.InnerFunctionCall( // break
941 // ParameterToInnerFunction));
942 if (*I > prec::Unknown)
943 NewParenState.LastSpace = std::max(NewParenState.LastSpace, State.Column);
944 if (*I != prec::Conditional && !Current.is(TT_UnaryOperator) &&
945 Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign)
946 NewParenState.StartOfFunctionCall = State.Column;
948 // Always indent conditional expressions. Never indent expression where
949 // the 'operator' is ',', ';' or an assignment (i.e. *I <=
950 // prec::Assignment) as those have different indentation rules. Indent
951 // other expression, unless the indentation needs to be skipped.
952 if (*I == prec::Conditional ||
953 (!SkipFirstExtraIndent && *I > prec::Assignment &&
954 !Current.isTrailingComment()))
955 NewParenState.Indent += Style.ContinuationIndentWidth;
956 if ((Previous && !Previous->opensScope()) || *I != prec::Comma)
957 NewParenState.BreakBeforeParameter = false;
958 State.Stack.push_back(NewParenState);
959 SkipFirstExtraIndent = false;
963 void ContinuationIndenter::moveStatePastFakeRParens(LineState &State) {
964 for (unsigned i = 0, e = State.NextToken->FakeRParens; i != e; ++i) {
965 unsigned VariablePos = State.Stack.back().VariablePos;
966 if (State.Stack.size() == 1) {
967 // Do not pop the last element.
970 State.Stack.pop_back();
971 State.Stack.back().VariablePos = VariablePos;
975 void ContinuationIndenter::moveStatePastScopeOpener(LineState &State,
977 const FormatToken &Current = *State.NextToken;
978 if (!Current.opensScope())
981 if (Current.MatchingParen && Current.BlockKind == BK_Block) {
982 moveStateToNewBlock(State);
987 unsigned LastSpace = State.Stack.back().LastSpace;
988 bool AvoidBinPacking;
989 bool BreakBeforeParameter = false;
990 unsigned NestedBlockIndent = std::max(State.Stack.back().StartOfFunctionCall,
991 State.Stack.back().NestedBlockIndent);
992 if (Current.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare)) {
993 if (Current.opensBlockOrBlockTypeList(Style)) {
994 NewIndent = State.Stack.back().NestedBlockIndent + Style.IndentWidth;
995 NewIndent = std::min(State.Column + 2, NewIndent);
997 NewIndent = State.Stack.back().LastSpace + Style.ContinuationIndentWidth;
999 const FormatToken *NextNoComment = Current.getNextNonComment();
1000 bool EndsInComma = Current.MatchingParen &&
1001 Current.MatchingParen->Previous &&
1002 Current.MatchingParen->Previous->is(tok::comma);
1004 (Current.is(TT_ArrayInitializerLSquare) && EndsInComma) ||
1005 Current.is(TT_DictLiteral) ||
1006 Style.Language == FormatStyle::LK_Proto || !Style.BinPackArguments ||
1007 (NextNoComment && NextNoComment->is(TT_DesignatedInitializerPeriod));
1008 if (Current.ParameterCount > 1)
1009 NestedBlockIndent = std::max(NestedBlockIndent, State.Column + 1);
1011 NewIndent = Style.ContinuationIndentWidth +
1012 std::max(State.Stack.back().LastSpace,
1013 State.Stack.back().StartOfFunctionCall);
1015 // Ensure that different different brackets force relative alignment, e.g.:
1016 // void SomeFunction(vector< // break
1018 // FIXME: We likely want to do this for more combinations of brackets.
1019 // Verify that it is wanted for ObjC, too.
1020 if (Current.is(tok::less) && Current.ParentBracket == tok::l_paren) {
1021 NewIndent = std::max(NewIndent, State.Stack.back().Indent);
1022 LastSpace = std::max(LastSpace, State.Stack.back().Indent);
1025 // JavaScript template strings are special as we always want to indent
1026 // nested expressions relative to the ${}. Otherwise, this can create quite
1028 if (Current.is(TT_TemplateString)) {
1029 unsigned Column = Current.IsMultiline
1030 ? Current.LastLineColumnWidth
1031 : State.Column + Current.ColumnWidth;
1034 NestedBlockIndent = Column;
1038 (State.Line->MustBeDeclaration && !Style.BinPackParameters) ||
1039 (!State.Line->MustBeDeclaration && !Style.BinPackArguments) ||
1040 (Style.ExperimentalAutoDetectBinPacking &&
1041 (Current.PackingKind == PPK_OnePerLine ||
1042 (!BinPackInconclusiveFunctions &&
1043 Current.PackingKind == PPK_Inconclusive)));
1044 if (Current.is(TT_ObjCMethodExpr) && Current.MatchingParen) {
1045 if (Style.ColumnLimit) {
1046 // If this '[' opens an ObjC call, determine whether all parameters fit
1047 // into one line and put one per line if they don't.
1048 if (getLengthToMatchingParen(Current) + State.Column >
1049 getColumnLimit(State))
1050 BreakBeforeParameter = true;
1052 // For ColumnLimit = 0, we have to figure out whether there is or has to
1053 // be a line break within this call.
1054 for (const FormatToken *Tok = &Current;
1055 Tok && Tok != Current.MatchingParen; Tok = Tok->Next) {
1056 if (Tok->MustBreakBefore ||
1057 (Tok->CanBreakBefore && Tok->NewlinesBefore > 0)) {
1058 BreakBeforeParameter = true;
1065 // Generally inherit NoLineBreak from the current scope to nested scope.
1066 // However, don't do this for non-empty nested blocks, dict literals and
1067 // array literals as these follow different indentation rules.
1069 Current.Children.empty() &&
1070 !Current.isOneOf(TT_DictLiteral, TT_ArrayInitializerLSquare) &&
1071 (State.Stack.back().NoLineBreak ||
1072 State.Stack.back().NoLineBreakInOperand ||
1073 (Current.is(TT_TemplateOpener) &&
1074 State.Stack.back().ContainsUnwrappedBuilder));
1075 State.Stack.push_back(
1076 ParenState(NewIndent, LastSpace, AvoidBinPacking, NoLineBreak));
1077 State.Stack.back().NestedBlockIndent = NestedBlockIndent;
1078 State.Stack.back().BreakBeforeParameter = BreakBeforeParameter;
1079 State.Stack.back().HasMultipleNestedBlocks = Current.BlockParameterCount > 1;
1082 void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) {
1083 const FormatToken &Current = *State.NextToken;
1084 if (!Current.closesScope())
1087 // If we encounter a closing ), ], } or >, we can remove a level from our
1089 if (State.Stack.size() > 1 &&
1090 (Current.isOneOf(tok::r_paren, tok::r_square, TT_TemplateString) ||
1091 (Current.is(tok::r_brace) && State.NextToken != State.Line->First) ||
1092 State.NextToken->is(TT_TemplateCloser)))
1093 State.Stack.pop_back();
1095 if (Current.is(tok::r_square)) {
1096 // If this ends the array subscript expr, reset the corresponding value.
1097 const FormatToken *NextNonComment = Current.getNextNonComment();
1098 if (NextNonComment && NextNonComment->isNot(tok::l_square))
1099 State.Stack.back().StartOfArraySubscripts = 0;
1103 void ContinuationIndenter::moveStateToNewBlock(LineState &State) {
1104 unsigned NestedBlockIndent = State.Stack.back().NestedBlockIndent;
1105 // ObjC block sometimes follow special indentation rules.
1106 unsigned NewIndent =
1107 NestedBlockIndent + (State.NextToken->is(TT_ObjCBlockLBrace)
1108 ? Style.ObjCBlockIndentWidth
1109 : Style.IndentWidth);
1110 State.Stack.push_back(ParenState(NewIndent, State.Stack.back().LastSpace,
1111 /*AvoidBinPacking=*/true,
1112 /*NoLineBreak=*/false));
1113 State.Stack.back().NestedBlockIndent = NestedBlockIndent;
1114 State.Stack.back().BreakBeforeParameter = true;
1117 unsigned ContinuationIndenter::addMultilineToken(const FormatToken &Current,
1119 if (!Current.IsMultiline)
1122 // Break before further function parameters on all levels.
1123 for (unsigned i = 0, e = State.Stack.size(); i != e; ++i)
1124 State.Stack[i].BreakBeforeParameter = true;
1126 unsigned ColumnsUsed = State.Column;
1127 // We can only affect layout of the first and the last line, so the penalty
1128 // for all other lines is constant, and we ignore it.
1129 State.Column = Current.LastLineColumnWidth;
1131 if (ColumnsUsed > getColumnLimit(State))
1132 return Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit(State));
1136 unsigned ContinuationIndenter::breakProtrudingToken(const FormatToken &Current,
1139 // Don't break multi-line tokens other than block comments. Instead, just
1140 // update the state.
1141 if (Current.isNot(TT_BlockComment) && Current.IsMultiline)
1142 return addMultilineToken(Current, State);
1144 // Don't break implicit string literals or import statements.
1145 if (Current.is(TT_ImplicitStringLiteral) ||
1146 State.Line->Type == LT_ImportStatement)
1149 if (!Current.isStringLiteral() && !Current.is(tok::comment))
1152 std::unique_ptr<BreakableToken> Token;
1153 unsigned StartColumn = State.Column - Current.ColumnWidth;
1154 unsigned ColumnLimit = getColumnLimit(State);
1156 if (Current.isStringLiteral()) {
1157 // FIXME: String literal breaking is currently disabled for Java and JS, as
1158 // it requires strings to be merged using "+" which we don't support.
1159 if (Style.Language == FormatStyle::LK_Java ||
1160 Style.Language == FormatStyle::LK_JavaScript ||
1161 !Style.BreakStringLiterals)
1164 // Don't break string literals inside preprocessor directives (except for
1165 // #define directives, as their contents are stored in separate lines and
1166 // are not affected by this check).
1167 // This way we avoid breaking code with line directives and unknown
1168 // preprocessor directives that contain long string literals.
1169 if (State.Line->Type == LT_PreprocessorDirective)
1171 // Exempts unterminated string literals from line breaking. The user will
1172 // likely want to terminate the string before any line breaking is done.
1173 if (Current.IsUnterminatedLiteral)
1176 StringRef Text = Current.TokenText;
1179 // FIXME: Handle whitespace between '_T', '(', '"..."', and ')'.
1180 // FIXME: Store Prefix and Suffix (or PrefixLength and SuffixLength to
1181 // reduce the overhead) for each FormatToken, which is a string, so that we
1182 // don't run multiple checks here on the hot path.
1183 if ((Text.endswith(Postfix = "\"") &&
1184 (Text.startswith(Prefix = "@\"") || Text.startswith(Prefix = "\"") ||
1185 Text.startswith(Prefix = "u\"") || Text.startswith(Prefix = "U\"") ||
1186 Text.startswith(Prefix = "u8\"") ||
1187 Text.startswith(Prefix = "L\""))) ||
1188 (Text.startswith(Prefix = "_T(\"") && Text.endswith(Postfix = "\")"))) {
1189 Token.reset(new BreakableStringLiteral(Current, StartColumn, Prefix,
1190 Postfix, State.Line->InPPDirective,
1195 } else if (Current.is(TT_BlockComment)) {
1196 if (!Current.isTrailingComment() || !Style.ReflowComments ||
1197 // If a comment token switches formatting, like
1198 // /* clang-format on */, we don't want to break it further,
1199 // but we may still want to adjust its indentation.
1200 switchesFormatting(Current))
1201 return addMultilineToken(Current, State);
1202 Token.reset(new BreakableBlockComment(
1203 Current, StartColumn, Current.OriginalColumn, !Current.Previous,
1204 State.Line->InPPDirective, Encoding, Style));
1205 } else if (Current.is(TT_LineComment) &&
1206 (Current.Previous == nullptr ||
1207 Current.Previous->isNot(TT_ImplicitStringLiteral))) {
1208 if (!Style.ReflowComments ||
1209 CommentPragmasRegex.match(Current.TokenText.substr(2)) ||
1210 switchesFormatting(Current))
1212 Token.reset(new BreakableLineCommentSection(
1213 Current, StartColumn, Current.OriginalColumn, !Current.Previous,
1214 /*InPPDirective=*/false, Encoding, Style));
1215 // We don't insert backslashes when breaking line comments.
1216 ColumnLimit = Style.ColumnLimit;
1220 if (Current.UnbreakableTailLength >= ColumnLimit)
1223 unsigned RemainingSpace = ColumnLimit - Current.UnbreakableTailLength;
1224 bool BreakInserted = false;
1225 // We use a conservative reflowing strategy. Reflow starts after a line is
1226 // broken or the corresponding whitespace compressed. Reflow ends as soon as a
1227 // line that doesn't get reflown with the previous line is reached.
1228 bool ReflowInProgress = false;
1229 unsigned Penalty = 0;
1230 unsigned RemainingTokenColumns = 0;
1231 for (unsigned LineIndex = 0, EndIndex = Token->getLineCount();
1232 LineIndex != EndIndex; ++LineIndex) {
1233 BreakableToken::Split SplitBefore(StringRef::npos, 0);
1234 if (ReflowInProgress) {
1235 SplitBefore = Token->getSplitBefore(LineIndex, RemainingTokenColumns,
1236 RemainingSpace, CommentPragmasRegex);
1238 ReflowInProgress = SplitBefore.first != StringRef::npos;
1239 unsigned TailOffset =
1240 ReflowInProgress ? (SplitBefore.first + SplitBefore.second) : 0;
1242 Token->replaceWhitespaceBefore(LineIndex, RemainingTokenColumns,
1243 RemainingSpace, SplitBefore, Whitespaces);
1244 RemainingTokenColumns = Token->getLineLengthAfterSplitBefore(
1245 LineIndex, TailOffset, RemainingTokenColumns, ColumnLimit, SplitBefore);
1246 while (RemainingTokenColumns > RemainingSpace) {
1247 BreakableToken::Split Split = Token->getSplit(
1248 LineIndex, TailOffset, ColumnLimit, CommentPragmasRegex);
1249 if (Split.first == StringRef::npos) {
1250 // The last line's penalty is handled in addNextStateToQueue().
1251 if (LineIndex < EndIndex - 1)
1252 Penalty += Style.PenaltyExcessCharacter *
1253 (RemainingTokenColumns - RemainingSpace);
1256 assert(Split.first != 0);
1258 // Check if compressing the whitespace range will bring the line length
1259 // under the limit. If that is the case, we perform whitespace compression
1260 // instead of inserting a line break.
1261 unsigned RemainingTokenColumnsAfterCompression =
1262 Token->getLineLengthAfterCompression(RemainingTokenColumns, Split);
1263 if (RemainingTokenColumnsAfterCompression <= RemainingSpace) {
1264 RemainingTokenColumns = RemainingTokenColumnsAfterCompression;
1265 ReflowInProgress = true;
1267 Token->compressWhitespace(LineIndex, TailOffset, Split, Whitespaces);
1271 unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit(
1272 LineIndex, TailOffset + Split.first + Split.second, StringRef::npos);
1274 // When breaking before a tab character, it may be moved by a few columns,
1275 // but will still be expanded to the next tab stop, so we don't save any
1277 if (NewRemainingTokenColumns == RemainingTokenColumns)
1280 assert(NewRemainingTokenColumns < RemainingTokenColumns);
1282 Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces);
1283 Penalty += Current.SplitPenalty;
1284 unsigned ColumnsUsed =
1285 Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first);
1286 if (ColumnsUsed > ColumnLimit) {
1287 Penalty += Style.PenaltyExcessCharacter * (ColumnsUsed - ColumnLimit);
1289 TailOffset += Split.first + Split.second;
1290 RemainingTokenColumns = NewRemainingTokenColumns;
1291 ReflowInProgress = true;
1292 BreakInserted = true;
1296 State.Column = RemainingTokenColumns;
1298 if (BreakInserted) {
1299 // If we break the token inside a parameter list, we need to break before
1300 // the next parameter on all levels, so that the next parameter is clearly
1301 // visible. Line comments already introduce a break.
1302 if (Current.isNot(TT_LineComment)) {
1303 for (unsigned i = 0, e = State.Stack.size(); i != e; ++i)
1304 State.Stack[i].BreakBeforeParameter = true;
1307 Penalty += Current.isStringLiteral() ? Style.PenaltyBreakString
1308 : Style.PenaltyBreakComment;
1310 State.Stack.back().LastSpace = StartColumn;
1313 Token->updateNextToken(State);
1318 unsigned ContinuationIndenter::getColumnLimit(const LineState &State) const {
1319 // In preprocessor directives reserve two chars for trailing " \"
1320 return Style.ColumnLimit - (State.Line->InPPDirective ? 2 : 0);
1323 bool ContinuationIndenter::nextIsMultilineString(const LineState &State) {
1324 const FormatToken &Current = *State.NextToken;
1325 if (!Current.isStringLiteral() || Current.is(TT_ImplicitStringLiteral))
1327 // We never consider raw string literals "multiline" for the purpose of
1328 // AlwaysBreakBeforeMultilineStrings implementation as they are special-cased
1329 // (see TokenAnnotator::mustBreakBefore().
1330 if (Current.TokenText.startswith("R\""))
1332 if (Current.IsMultiline)
1334 if (Current.getNextNonComment() &&
1335 Current.getNextNonComment()->isStringLiteral())
1336 return true; // Implicit concatenation.
1337 if (Style.ColumnLimit != 0 &&
1338 State.Column + Current.ColumnWidth + Current.UnbreakableTailLength >
1340 return true; // String will be split.
1344 } // namespace format
1345 } // namespace clang