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.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma)
59 return Previous.is(tok::comma) && !Current.isTrailingComment() &&
60 ((Previous.isNot(TT_CtorInitializerComma) ||
61 Style.BreakConstructorInitializers !=
62 FormatStyle::BCIS_BeforeComma) &&
63 (Previous.isNot(TT_InheritanceComma) ||
64 !Style.BreakBeforeInheritanceComma));
67 ContinuationIndenter::ContinuationIndenter(const FormatStyle &Style,
68 const AdditionalKeywords &Keywords,
69 const SourceManager &SourceMgr,
70 WhitespaceManager &Whitespaces,
71 encoding::Encoding Encoding,
72 bool BinPackInconclusiveFunctions)
73 : Style(Style), Keywords(Keywords), SourceMgr(SourceMgr),
74 Whitespaces(Whitespaces), Encoding(Encoding),
75 BinPackInconclusiveFunctions(BinPackInconclusiveFunctions),
76 CommentPragmasRegex(Style.CommentPragmas) {}
78 LineState ContinuationIndenter::getInitialState(unsigned FirstIndent,
79 const AnnotatedLine *Line,
82 State.FirstIndent = FirstIndent;
83 State.Column = FirstIndent;
85 State.NextToken = Line->First;
86 State.Stack.push_back(ParenState(FirstIndent, FirstIndent,
87 /*AvoidBinPacking=*/false,
88 /*NoLineBreak=*/false));
89 State.LineContainsContinuedForLoopSection = false;
90 State.StartOfStringLiteral = 0;
91 State.StartOfLineLevel = 0;
92 State.LowestLevelOnLine = 0;
93 State.IgnoreStackForComparison = false;
95 // The first token has already been indented and thus consumed.
96 moveStateToNextToken(State, DryRun, /*Newline=*/false);
100 bool ContinuationIndenter::canBreak(const LineState &State) {
101 const FormatToken &Current = *State.NextToken;
102 const FormatToken &Previous = *Current.Previous;
103 assert(&Previous == Current.Previous);
104 if (!Current.CanBreakBefore &&
105 !(State.Stack.back().BreakBeforeClosingBrace &&
106 Current.closesBlockOrBlockTypeList(Style)))
108 // The opening "{" of a braced list has to be on the same line as the first
109 // element if it is nested in another braced init list or function call.
110 if (!Current.MustBreakBefore && Previous.is(tok::l_brace) &&
111 Previous.isNot(TT_DictLiteral) && Previous.BlockKind == BK_BracedInit &&
113 Previous.Previous->isOneOf(tok::l_brace, tok::l_paren, tok::comma))
115 // This prevents breaks like:
117 // SomeParameter, OtherParameter).DoSomething(
119 // As they hide "DoSomething" and are generally bad for readability.
120 if (Previous.opensScope() && Previous.isNot(tok::l_brace) &&
121 State.LowestLevelOnLine < State.StartOfLineLevel &&
122 State.LowestLevelOnLine < Current.NestingLevel)
124 if (Current.isMemberAccess() && State.Stack.back().ContainsUnwrappedBuilder)
127 // Don't create a 'hanging' indent if there are multiple blocks in a single
129 if (Previous.is(tok::l_brace) && State.Stack.size() > 1 &&
130 State.Stack[State.Stack.size() - 2].NestedBlockInlined &&
131 State.Stack[State.Stack.size() - 2].HasMultipleNestedBlocks)
134 // Don't break after very short return types (e.g. "void") as that is often
136 if (Current.is(TT_FunctionDeclarationName) && State.Column < 6) {
137 if (Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None)
141 // If binary operators are moved to the next line (including commas for some
142 // styles of constructor initializers), that's always ok.
143 if (!Current.isOneOf(TT_BinaryOperator, tok::comma) &&
144 State.Stack.back().NoLineBreakInOperand)
147 return !State.Stack.back().NoLineBreak;
150 bool ContinuationIndenter::mustBreak(const LineState &State) {
151 const FormatToken &Current = *State.NextToken;
152 const FormatToken &Previous = *Current.Previous;
153 if (Current.MustBreakBefore || Current.is(TT_InlineASMColon))
155 if (State.Stack.back().BreakBeforeClosingBrace &&
156 Current.closesBlockOrBlockTypeList(Style))
158 if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection)
160 if ((startsNextParameter(Current, Style) || Previous.is(tok::semi) ||
161 (Previous.is(TT_TemplateCloser) && Current.is(TT_StartOfName) &&
163 // FIXME: This is a temporary workaround for the case where clang-format
164 // sets BreakBeforeParameter to avoid bin packing and this creates a
165 // completely unnecessary line break after a template type that isn't
167 (Previous.NestingLevel == 1 || Style.BinPackParameters)) ||
168 (Style.BreakBeforeTernaryOperators && Current.is(TT_ConditionalExpr) &&
169 Previous.isNot(tok::question)) ||
170 (!Style.BreakBeforeTernaryOperators &&
171 Previous.is(TT_ConditionalExpr))) &&
172 State.Stack.back().BreakBeforeParameter && !Current.isTrailingComment() &&
173 !Current.isOneOf(tok::r_paren, tok::r_brace))
175 if (((Previous.is(TT_DictLiteral) && Previous.is(tok::l_brace)) ||
176 (Previous.is(TT_ArrayInitializerLSquare) &&
177 Previous.ParameterCount > 1)) &&
178 Style.ColumnLimit > 0 &&
179 getLengthToMatchingParen(Previous) + State.Column - 1 >
180 getColumnLimit(State))
183 const FormatToken &BreakConstructorInitializersToken =
184 Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon
187 if (BreakConstructorInitializersToken.is(TT_CtorInitializerColon) &&
188 (State.Column + State.Line->Last->TotalLength - Previous.TotalLength >
189 getColumnLimit(State) ||
190 State.Stack.back().BreakBeforeParameter) &&
191 (Style.AllowShortFunctionsOnASingleLine != FormatStyle::SFS_All ||
192 Style.BreakConstructorInitializers != FormatStyle::BCIS_BeforeColon ||
193 Style.ColumnLimit != 0))
196 if (Current.is(TT_ObjCMethodExpr) && !Previous.is(TT_SelectorName) &&
197 State.Line->startsWith(TT_ObjCMethodSpecifier))
199 if (Current.is(TT_SelectorName) && State.Stack.back().ObjCSelectorNameFound &&
200 State.Stack.back().BreakBeforeParameter)
203 unsigned NewLineColumn = getNewLineColumn(State);
204 if (Current.isMemberAccess() && Style.ColumnLimit != 0 &&
205 State.Column + getLengthToNextOperator(Current) > Style.ColumnLimit &&
206 (State.Column > NewLineColumn ||
207 Current.NestingLevel < State.StartOfLineLevel))
210 if (startsSegmentOfBuilderTypeCall(Current) &&
211 (State.Stack.back().CallContinuation != 0 ||
212 State.Stack.back().BreakBeforeParameter) &&
213 // JavaScript is treated different here as there is a frequent pattern:
214 // SomeFunction(function() {
217 // FIXME: We should find a more generic solution to this problem.
218 !(State.Column <= NewLineColumn &&
219 Style.Language == FormatStyle::LK_JavaScript))
222 if (State.Column <= NewLineColumn)
225 if (Style.AlwaysBreakBeforeMultilineStrings &&
226 (NewLineColumn == State.FirstIndent + Style.ContinuationIndentWidth ||
227 Previous.is(tok::comma) || Current.NestingLevel < 2) &&
228 !Previous.isOneOf(tok::kw_return, tok::lessless, tok::at) &&
229 !Previous.isOneOf(TT_InlineASMColon, TT_ConditionalExpr) &&
230 nextIsMultilineString(State))
233 // Using CanBreakBefore here and below takes care of the decision whether the
234 // current style uses wrapping before or after operators for the given
236 if (Previous.is(TT_BinaryOperator) && Current.CanBreakBefore) {
237 // If we need to break somewhere inside the LHS of a binary expression, we
238 // should also break after the operator. Otherwise, the formatting would
239 // hide the operator precedence, e.g. in:
240 // if (aaaaaaaaaaaaaa ==
241 // bbbbbbbbbbbbbb && c) {..
242 // For comparisons, we only apply this rule, if the LHS is a binary
243 // expression itself as otherwise, the line breaks seem superfluous.
244 // We need special cases for ">>" which we have split into two ">" while
245 // lexing in order to make template parsing easier.
246 bool IsComparison = (Previous.getPrecedence() == prec::Relational ||
247 Previous.getPrecedence() == prec::Equality) &&
249 Previous.Previous->isNot(TT_BinaryOperator); // For >>.
250 bool LHSIsBinaryExpr =
251 Previous.Previous && Previous.Previous->EndsBinaryExpression;
252 if ((!IsComparison || LHSIsBinaryExpr) && !Current.isTrailingComment() &&
253 Previous.getPrecedence() != prec::Assignment &&
254 State.Stack.back().BreakBeforeParameter)
256 } else if (Current.is(TT_BinaryOperator) && Current.CanBreakBefore &&
257 State.Stack.back().BreakBeforeParameter) {
261 // Same as above, but for the first "<<" operator.
262 if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator) &&
263 State.Stack.back().BreakBeforeParameter &&
264 State.Stack.back().FirstLessLess == 0)
267 if (Current.NestingLevel == 0 && !Current.isTrailingComment()) {
268 // Always break after "template <...>" and leading annotations. This is only
269 // for cases where the entire line does not fit on a single line as a
270 // different LineFormatter would be used otherwise.
271 if (Previous.ClosesTemplateDeclaration)
273 if (Previous.is(TT_FunctionAnnotationRParen))
275 if (Previous.is(TT_LeadingJavaAnnotation) && Current.isNot(tok::l_paren) &&
276 Current.isNot(TT_LeadingJavaAnnotation))
280 // If the return type spans multiple lines, wrap before the function name.
281 if ((Current.is(TT_FunctionDeclarationName) ||
282 (Current.is(tok::kw_operator) && !Previous.is(tok::coloncolon))) &&
283 !Previous.is(tok::kw_template) && State.Stack.back().BreakBeforeParameter)
286 // The following could be precomputed as they do not depend on the state.
287 // However, as they should take effect only if the UnwrappedLine does not fit
288 // into the ColumnLimit, they are checked here in the ContinuationIndenter.
289 if (Style.ColumnLimit != 0 && Previous.BlockKind == BK_Block &&
290 Previous.is(tok::l_brace) && !Current.isOneOf(tok::r_brace, tok::comment))
293 if (Current.is(tok::lessless) &&
294 ((Previous.is(tok::identifier) && Previous.TokenText == "endl") ||
295 (Previous.Tok.isLiteral() && (Previous.TokenText.endswith("\\n\"") ||
296 Previous.TokenText == "\'\\n\'"))))
302 unsigned ContinuationIndenter::addTokenToState(LineState &State, bool Newline,
304 unsigned ExtraSpaces) {
305 const FormatToken &Current = *State.NextToken;
307 assert(!State.Stack.empty());
308 if ((Current.is(TT_ImplicitStringLiteral) &&
309 (Current.Previous->Tok.getIdentifierInfo() == nullptr ||
310 Current.Previous->Tok.getIdentifierInfo()->getPPKeywordID() ==
311 tok::pp_not_keyword))) {
313 SourceMgr.getSpellingColumnNumber(Current.WhitespaceRange.getEnd());
314 if (Current.LastNewlineOffset != 0) {
315 // If there is a newline within this token, the final column will solely
316 // determined by the current end column.
317 State.Column = EndColumn;
319 unsigned StartColumn =
320 SourceMgr.getSpellingColumnNumber(Current.WhitespaceRange.getBegin());
321 assert(EndColumn >= StartColumn);
322 State.Column += EndColumn - StartColumn;
324 moveStateToNextToken(State, DryRun, /*Newline=*/false);
328 unsigned Penalty = 0;
330 Penalty = addTokenOnNewLine(State, DryRun);
332 addTokenOnCurrentLine(State, DryRun, ExtraSpaces);
334 return moveStateToNextToken(State, DryRun, Newline) + Penalty;
337 void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun,
338 unsigned ExtraSpaces) {
339 FormatToken &Current = *State.NextToken;
340 const FormatToken &Previous = *State.NextToken->Previous;
341 if (Current.is(tok::equal) &&
342 (State.Line->First->is(tok::kw_for) || Current.NestingLevel == 0) &&
343 State.Stack.back().VariablePos == 0) {
344 State.Stack.back().VariablePos = State.Column;
345 // Move over * and & if they are bound to the variable name.
346 const FormatToken *Tok = &Previous;
347 while (Tok && State.Stack.back().VariablePos >= Tok->ColumnWidth) {
348 State.Stack.back().VariablePos -= Tok->ColumnWidth;
349 if (Tok->SpacesRequiredBefore != 0)
353 if (Previous.PartOfMultiVariableDeclStmt)
354 State.Stack.back().LastSpace = State.Stack.back().VariablePos;
357 unsigned Spaces = Current.SpacesRequiredBefore + ExtraSpaces;
360 Whitespaces.replaceWhitespace(Current, /*Newlines=*/0, Spaces,
361 State.Column + Spaces);
363 // If "BreakBeforeInheritanceComma" mode, don't break within the inheritance
364 // declaration unless there is multiple inheritance.
365 if (Style.BreakBeforeInheritanceComma && Current.is(TT_InheritanceColon))
366 State.Stack.back().NoLineBreak = true;
368 if (Current.is(TT_SelectorName) &&
369 !State.Stack.back().ObjCSelectorNameFound) {
371 std::max(State.FirstIndent + Style.ContinuationIndentWidth,
372 State.Stack.back().Indent);
373 unsigned FirstColonPos = State.Column + Spaces + Current.ColumnWidth;
374 if (Current.LongestObjCSelectorName == 0)
375 State.Stack.back().AlignColons = false;
376 else if (MinIndent + Current.LongestObjCSelectorName > FirstColonPos)
377 State.Stack.back().ColonPos = MinIndent + Current.LongestObjCSelectorName;
379 State.Stack.back().ColonPos = FirstColonPos;
382 // In "AlwaysBreak" mode, enforce wrapping directly after the parenthesis by
383 // disallowing any further line breaks if there is no line break after the
384 // opening parenthesis. Don't break if it doesn't conserve columns.
385 if (Style.AlignAfterOpenBracket == FormatStyle::BAS_AlwaysBreak &&
386 Previous.isOneOf(tok::l_paren, TT_TemplateOpener, tok::l_square) &&
387 State.Column > getNewLineColumn(State) &&
388 (!Previous.Previous ||
389 !Previous.Previous->isOneOf(tok::kw_for, tok::kw_while,
391 // Don't do this for simple (no expressions) one-argument function calls
392 // as that feels like needlessly wasting whitespace, e.g.:
397 // caaaaaaaaaaaaaaaaaaaaaaall(aaaaaaaaaaaaaa, aaaaaaaaa))));
398 Current.FakeLParens.size() > 0 &&
399 Current.FakeLParens.back() > prec::Unknown)
400 State.Stack.back().NoLineBreak = true;
401 if (Previous.is(TT_TemplateString) && Previous.opensScope())
402 State.Stack.back().NoLineBreak = true;
404 if (Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign &&
405 Previous.opensScope() && Previous.isNot(TT_ObjCMethodExpr) &&
406 (Current.isNot(TT_LineComment) || Previous.BlockKind == BK_BracedInit))
407 State.Stack.back().Indent = State.Column + Spaces;
408 if (State.Stack.back().AvoidBinPacking && startsNextParameter(Current, Style))
409 State.Stack.back().NoLineBreak = true;
410 if (startsSegmentOfBuilderTypeCall(Current) &&
411 State.Column > getNewLineColumn(State))
412 State.Stack.back().ContainsUnwrappedBuilder = true;
414 if (Current.is(TT_LambdaArrow) && Style.Language == FormatStyle::LK_Java)
415 State.Stack.back().NoLineBreak = true;
416 if (Current.isMemberAccess() && Previous.is(tok::r_paren) &&
417 (Previous.MatchingParen &&
418 (Previous.TotalLength - Previous.MatchingParen->TotalLength > 10)))
419 // If there is a function call with long parameters, break before trailing
420 // calls. This prevents things like:
421 // EXPECT_CALL(SomeLongParameter).Times(
423 // We don't want to do this for short parameters as they can just be
425 State.Stack.back().NoLineBreak = true;
427 // Don't allow the RHS of an operator to be split over multiple lines unless
428 // there is a line-break right after the operator.
429 // Exclude relational operators, as there, it is always more desirable to
430 // have the LHS 'left' of the RHS.
431 const FormatToken *P = Current.getPreviousNonComment();
432 if (!Current.is(tok::comment) && P &&
433 (P->isOneOf(TT_BinaryOperator, tok::comma) ||
434 (P->is(TT_ConditionalExpr) && P->is(tok::colon))) &&
435 !P->isOneOf(TT_OverloadedOperator, TT_CtorInitializerComma) &&
436 P->getPrecedence() != prec::Assignment &&
437 P->getPrecedence() != prec::Relational) {
438 bool BreakBeforeOperator =
439 P->MustBreakBefore || P->is(tok::lessless) ||
440 (P->is(TT_BinaryOperator) &&
441 Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None) ||
442 (P->is(TT_ConditionalExpr) && Style.BreakBeforeTernaryOperators);
443 // Don't do this if there are only two operands. In these cases, there is
444 // always a nice vertical separation between them and the extra line break
446 bool HasTwoOperands =
447 P->OperatorIndex == 0 && !P->NextOperator && !P->is(TT_ConditionalExpr);
448 if ((!BreakBeforeOperator && !(HasTwoOperands && Style.AlignOperands)) ||
449 (!State.Stack.back().LastOperatorWrapped && BreakBeforeOperator))
450 State.Stack.back().NoLineBreakInOperand = true;
453 State.Column += Spaces;
454 if (Current.isNot(tok::comment) && Previous.is(tok::l_paren) &&
456 Previous.Previous->isOneOf(tok::kw_if, tok::kw_for)) {
457 // Treat the condition inside an if as if it was a second function
458 // parameter, i.e. let nested calls have a continuation indent.
459 State.Stack.back().LastSpace = State.Column;
460 State.Stack.back().NestedBlockIndent = State.Column;
461 } else if (!Current.isOneOf(tok::comment, tok::caret) &&
462 ((Previous.is(tok::comma) &&
463 !Previous.is(TT_OverloadedOperator)) ||
464 (Previous.is(tok::colon) && Previous.is(TT_ObjCMethodExpr)))) {
465 State.Stack.back().LastSpace = State.Column;
466 } else if (Previous.is(TT_CtorInitializerColon) &&
467 Style.BreakConstructorInitializers ==
468 FormatStyle::BCIS_AfterColon) {
469 State.Stack.back().Indent = State.Column;
470 State.Stack.back().LastSpace = State.Column;
471 } else if ((Previous.isOneOf(TT_BinaryOperator, TT_ConditionalExpr,
472 TT_CtorInitializerColon)) &&
473 ((Previous.getPrecedence() != prec::Assignment &&
474 (Previous.isNot(tok::lessless) || Previous.OperatorIndex != 0 ||
475 Previous.NextOperator)) ||
476 Current.StartsBinaryExpression)) {
477 // Indent relative to the RHS of the expression unless this is a simple
478 // assignment without binary expression on the RHS. Also indent relative to
479 // unary operators and the colons of constructor initializers.
480 State.Stack.back().LastSpace = State.Column;
481 } else if (Previous.is(TT_InheritanceColon)) {
482 State.Stack.back().Indent = State.Column;
483 State.Stack.back().LastSpace = State.Column;
484 } else if (Previous.opensScope()) {
485 // If a function has a trailing call, indent all parameters from the
486 // opening parenthesis. This avoids confusing indents like:
487 // OuterFunction(InnerFunctionCall( // break
488 // ParameterToInnerFunction)) // break
489 // .SecondInnerFunctionCall();
490 bool HasTrailingCall = false;
491 if (Previous.MatchingParen) {
492 const FormatToken *Next = Previous.MatchingParen->getNextNonComment();
493 HasTrailingCall = Next && Next->isMemberAccess();
495 if (HasTrailingCall && State.Stack.size() > 1 &&
496 State.Stack[State.Stack.size() - 2].CallContinuation == 0)
497 State.Stack.back().LastSpace = State.Column;
501 unsigned ContinuationIndenter::addTokenOnNewLine(LineState &State,
503 FormatToken &Current = *State.NextToken;
504 const FormatToken &Previous = *State.NextToken->Previous;
506 // Extra penalty that needs to be added because of the way certain line
507 // breaks are chosen.
508 unsigned Penalty = 0;
510 const FormatToken *PreviousNonComment = Current.getPreviousNonComment();
511 const FormatToken *NextNonComment = Previous.getNextNonComment();
513 NextNonComment = &Current;
514 // The first line break on any NestingLevel causes an extra penalty in order
515 // prefer similar line breaks.
516 if (!State.Stack.back().ContainsLineBreak)
518 State.Stack.back().ContainsLineBreak = true;
520 Penalty += State.NextToken->SplitPenalty;
522 // Breaking before the first "<<" is generally not desirable if the LHS is
523 // short. Also always add the penalty if the LHS is split over multiple lines
524 // to avoid unnecessary line breaks that just work around this penalty.
525 if (NextNonComment->is(tok::lessless) &&
526 State.Stack.back().FirstLessLess == 0 &&
527 (State.Column <= Style.ColumnLimit / 3 ||
528 State.Stack.back().BreakBeforeParameter))
529 Penalty += Style.PenaltyBreakFirstLessLess;
531 State.Column = getNewLineColumn(State);
533 // Indent nested blocks relative to this column, unless in a very specific
534 // JavaScript special case where:
536 // var loooooong_name =
541 // is common and should be formatted like a free-standing function. The same
542 // goes for wrapping before the lambda return type arrow.
543 if (!Current.is(TT_LambdaArrow) &&
544 (Style.Language != FormatStyle::LK_JavaScript ||
545 Current.NestingLevel != 0 || !PreviousNonComment ||
546 !PreviousNonComment->is(tok::equal) ||
547 !Current.isOneOf(Keywords.kw_async, Keywords.kw_function)))
548 State.Stack.back().NestedBlockIndent = State.Column;
550 if (NextNonComment->isMemberAccess()) {
551 if (State.Stack.back().CallContinuation == 0)
552 State.Stack.back().CallContinuation = State.Column;
553 } else if (NextNonComment->is(TT_SelectorName)) {
554 if (!State.Stack.back().ObjCSelectorNameFound) {
555 if (NextNonComment->LongestObjCSelectorName == 0) {
556 State.Stack.back().AlignColons = false;
558 State.Stack.back().ColonPos =
559 (Style.IndentWrappedFunctionNames
560 ? std::max(State.Stack.back().Indent,
561 State.FirstIndent + Style.ContinuationIndentWidth)
562 : State.Stack.back().Indent) +
563 NextNonComment->LongestObjCSelectorName;
565 } else if (State.Stack.back().AlignColons &&
566 State.Stack.back().ColonPos <= NextNonComment->ColumnWidth) {
567 State.Stack.back().ColonPos = State.Column + NextNonComment->ColumnWidth;
569 } else if (PreviousNonComment && PreviousNonComment->is(tok::colon) &&
570 PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral)) {
571 // FIXME: This is hacky, find a better way. The problem is that in an ObjC
572 // method expression, the block should be aligned to the line starting it,
574 // [aaaaaaaaaaaaaaa aaaaaaaaa: \\ break for some reason
578 // Thus, we set LastSpace of the next higher NestingLevel, to which we move
579 // when we consume all of the "}"'s FakeRParens at the "{".
580 if (State.Stack.size() > 1)
581 State.Stack[State.Stack.size() - 2].LastSpace =
582 std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) +
583 Style.ContinuationIndentWidth;
586 if ((PreviousNonComment &&
587 PreviousNonComment->isOneOf(tok::comma, tok::semi) &&
588 !State.Stack.back().AvoidBinPacking) ||
589 Previous.is(TT_BinaryOperator))
590 State.Stack.back().BreakBeforeParameter = false;
591 if (Previous.isOneOf(TT_TemplateCloser, TT_JavaAnnotation) &&
592 Current.NestingLevel == 0)
593 State.Stack.back().BreakBeforeParameter = false;
594 if (NextNonComment->is(tok::question) ||
595 (PreviousNonComment && PreviousNonComment->is(tok::question)))
596 State.Stack.back().BreakBeforeParameter = true;
597 if (Current.is(TT_BinaryOperator) && Current.CanBreakBefore)
598 State.Stack.back().BreakBeforeParameter = false;
601 unsigned Newlines = std::max(
602 1u, std::min(Current.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1));
603 bool ContinuePPDirective =
604 State.Line->InPPDirective && State.Line->Type != LT_ImportStatement;
605 Whitespaces.replaceWhitespace(Current, Newlines, State.Column, State.Column,
606 ContinuePPDirective);
609 if (!Current.isTrailingComment())
610 State.Stack.back().LastSpace = State.Column;
611 if (Current.is(tok::lessless))
612 // If we are breaking before a "<<", we always want to indent relative to
613 // RHS. This is necessary only for "<<", as we special-case it and don't
614 // always indent relative to the RHS.
615 State.Stack.back().LastSpace += 3; // 3 -> width of "<< ".
617 State.StartOfLineLevel = Current.NestingLevel;
618 State.LowestLevelOnLine = Current.NestingLevel;
620 // Any break on this level means that the parent level has been broken
621 // and we need to avoid bin packing there.
622 bool NestedBlockSpecialCase =
623 !Style.isCpp() && Current.is(tok::r_brace) && State.Stack.size() > 1 &&
624 State.Stack[State.Stack.size() - 2].NestedBlockInlined;
625 if (!NestedBlockSpecialCase)
626 for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i)
627 State.Stack[i].BreakBeforeParameter = true;
629 if (PreviousNonComment &&
630 !PreviousNonComment->isOneOf(tok::comma, tok::colon, tok::semi) &&
631 (PreviousNonComment->isNot(TT_TemplateCloser) ||
632 Current.NestingLevel != 0) &&
633 !PreviousNonComment->isOneOf(
634 TT_BinaryOperator, TT_FunctionAnnotationRParen, TT_JavaAnnotation,
635 TT_LeadingJavaAnnotation) &&
636 Current.isNot(TT_BinaryOperator) && !PreviousNonComment->opensScope())
637 State.Stack.back().BreakBeforeParameter = true;
639 // If we break after { or the [ of an array initializer, we should also break
640 // before the corresponding } or ].
641 if (PreviousNonComment &&
642 (PreviousNonComment->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) ||
643 (PreviousNonComment->is(TT_TemplateString) &&
644 PreviousNonComment->opensScope())))
645 State.Stack.back().BreakBeforeClosingBrace = true;
647 if (State.Stack.back().AvoidBinPacking) {
648 // If we are breaking after '(', '{', '<', this is not bin packing
649 // unless AllowAllParametersOfDeclarationOnNextLine is false or this is a
650 // dict/object literal.
651 if (!Previous.isOneOf(tok::l_paren, tok::l_brace, TT_BinaryOperator) ||
652 (!Style.AllowAllParametersOfDeclarationOnNextLine &&
653 State.Line->MustBeDeclaration) ||
654 Previous.is(TT_DictLiteral))
655 State.Stack.back().BreakBeforeParameter = true;
661 unsigned ContinuationIndenter::getNewLineColumn(const LineState &State) {
662 if (!State.NextToken || !State.NextToken->Previous)
664 FormatToken &Current = *State.NextToken;
665 const FormatToken &Previous = *Current.Previous;
666 // If we are continuing an expression, we want to use the continuation indent.
667 unsigned ContinuationIndent =
668 std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) +
669 Style.ContinuationIndentWidth;
670 const FormatToken *PreviousNonComment = Current.getPreviousNonComment();
671 const FormatToken *NextNonComment = Previous.getNextNonComment();
673 NextNonComment = &Current;
675 // Java specific bits.
676 if (Style.Language == FormatStyle::LK_Java &&
677 Current.isOneOf(Keywords.kw_implements, Keywords.kw_extends))
678 return std::max(State.Stack.back().LastSpace,
679 State.Stack.back().Indent + Style.ContinuationIndentWidth);
681 if (NextNonComment->is(tok::l_brace) && NextNonComment->BlockKind == BK_Block)
682 return Current.NestingLevel == 0 ? State.FirstIndent
683 : State.Stack.back().Indent;
684 if (Current.isOneOf(tok::r_brace, tok::r_square) && State.Stack.size() > 1) {
685 if (Current.closesBlockOrBlockTypeList(Style))
686 return State.Stack[State.Stack.size() - 2].NestedBlockIndent;
687 if (Current.MatchingParen &&
688 Current.MatchingParen->BlockKind == BK_BracedInit)
689 return State.Stack[State.Stack.size() - 2].LastSpace;
690 return State.FirstIndent;
692 // Indent a closing parenthesis at the previous level if followed by a semi or
693 // opening brace. This allows indentations such as:
702 if (Current.is(tok::r_paren) && State.Stack.size() > 1 &&
703 (!Current.Next || Current.Next->isOneOf(tok::semi, tok::l_brace)))
704 return State.Stack[State.Stack.size() - 2].LastSpace;
705 if (NextNonComment->is(TT_TemplateString) && NextNonComment->closesScope())
706 return State.Stack[State.Stack.size() - 2].LastSpace;
707 if (Current.is(tok::identifier) && Current.Next &&
708 Current.Next->is(TT_DictLiteral))
709 return State.Stack.back().Indent;
710 if (NextNonComment->is(TT_ObjCStringLiteral) &&
711 State.StartOfStringLiteral != 0)
712 return State.StartOfStringLiteral - 1;
713 if (NextNonComment->isStringLiteral() && State.StartOfStringLiteral != 0)
714 return State.StartOfStringLiteral;
715 if (NextNonComment->is(tok::lessless) &&
716 State.Stack.back().FirstLessLess != 0)
717 return State.Stack.back().FirstLessLess;
718 if (NextNonComment->isMemberAccess()) {
719 if (State.Stack.back().CallContinuation == 0)
720 return ContinuationIndent;
721 return State.Stack.back().CallContinuation;
723 if (State.Stack.back().QuestionColumn != 0 &&
724 ((NextNonComment->is(tok::colon) &&
725 NextNonComment->is(TT_ConditionalExpr)) ||
726 Previous.is(TT_ConditionalExpr)))
727 return State.Stack.back().QuestionColumn;
728 if (Previous.is(tok::comma) && State.Stack.back().VariablePos != 0)
729 return State.Stack.back().VariablePos;
730 if ((PreviousNonComment &&
731 (PreviousNonComment->ClosesTemplateDeclaration ||
732 PreviousNonComment->isOneOf(
733 TT_AttributeParen, TT_FunctionAnnotationRParen, TT_JavaAnnotation,
734 TT_LeadingJavaAnnotation))) ||
735 (!Style.IndentWrappedFunctionNames &&
736 NextNonComment->isOneOf(tok::kw_operator, TT_FunctionDeclarationName)))
737 return std::max(State.Stack.back().LastSpace, State.Stack.back().Indent);
738 if (NextNonComment->is(TT_SelectorName)) {
739 if (!State.Stack.back().ObjCSelectorNameFound) {
740 if (NextNonComment->LongestObjCSelectorName == 0)
741 return State.Stack.back().Indent;
742 return (Style.IndentWrappedFunctionNames
743 ? std::max(State.Stack.back().Indent,
744 State.FirstIndent + Style.ContinuationIndentWidth)
745 : State.Stack.back().Indent) +
746 NextNonComment->LongestObjCSelectorName -
747 NextNonComment->ColumnWidth;
749 if (!State.Stack.back().AlignColons)
750 return State.Stack.back().Indent;
751 if (State.Stack.back().ColonPos > NextNonComment->ColumnWidth)
752 return State.Stack.back().ColonPos - NextNonComment->ColumnWidth;
753 return State.Stack.back().Indent;
755 if (NextNonComment->is(tok::colon) && NextNonComment->is(TT_ObjCMethodExpr))
756 return State.Stack.back().ColonPos;
757 if (NextNonComment->is(TT_ArraySubscriptLSquare)) {
758 if (State.Stack.back().StartOfArraySubscripts != 0)
759 return State.Stack.back().StartOfArraySubscripts;
760 return ContinuationIndent;
763 // This ensure that we correctly format ObjC methods calls without inputs,
764 // i.e. where the last element isn't selector like: [callee method];
765 if (NextNonComment->is(tok::identifier) && NextNonComment->FakeRParens == 0 &&
766 NextNonComment->Next && NextNonComment->Next->is(TT_ObjCMethodExpr))
767 return State.Stack.back().Indent;
769 if (NextNonComment->isOneOf(TT_StartOfName, TT_PointerOrReference) ||
770 Previous.isOneOf(tok::coloncolon, tok::equal, TT_JsTypeColon))
771 return ContinuationIndent;
772 if (PreviousNonComment && PreviousNonComment->is(tok::colon) &&
773 PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral))
774 return ContinuationIndent;
775 if (NextNonComment->is(TT_CtorInitializerComma))
776 return State.Stack.back().Indent;
777 if (PreviousNonComment && PreviousNonComment->is(TT_CtorInitializerColon) &&
778 Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon)
779 return State.Stack.back().Indent;
780 if (NextNonComment->isOneOf(TT_CtorInitializerColon, TT_InheritanceColon,
781 TT_InheritanceComma))
782 return State.FirstIndent + Style.ConstructorInitializerIndentWidth;
783 if (Previous.is(tok::r_paren) && !Current.isBinaryOperator() &&
784 !Current.isOneOf(tok::colon, tok::comment))
785 return ContinuationIndent;
786 if (State.Stack.back().Indent == State.FirstIndent && PreviousNonComment &&
787 PreviousNonComment->isNot(tok::r_brace))
788 // Ensure that we fall back to the continuation indent width instead of
789 // just flushing continuations left.
790 return State.Stack.back().Indent + Style.ContinuationIndentWidth;
791 return State.Stack.back().Indent;
794 unsigned ContinuationIndenter::moveStateToNextToken(LineState &State,
795 bool DryRun, bool Newline) {
796 assert(State.Stack.size());
797 const FormatToken &Current = *State.NextToken;
799 if (Current.isOneOf(tok::comma, TT_BinaryOperator))
800 State.Stack.back().NoLineBreakInOperand = false;
801 if (Current.is(TT_InheritanceColon))
802 State.Stack.back().AvoidBinPacking = true;
803 if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator)) {
804 if (State.Stack.back().FirstLessLess == 0)
805 State.Stack.back().FirstLessLess = State.Column;
807 State.Stack.back().LastOperatorWrapped = Newline;
809 if (Current.is(TT_BinaryOperator) && Current.isNot(tok::lessless))
810 State.Stack.back().LastOperatorWrapped = Newline;
811 if (Current.is(TT_ConditionalExpr) && Current.Previous &&
812 !Current.Previous->is(TT_ConditionalExpr))
813 State.Stack.back().LastOperatorWrapped = Newline;
814 if (Current.is(TT_ArraySubscriptLSquare) &&
815 State.Stack.back().StartOfArraySubscripts == 0)
816 State.Stack.back().StartOfArraySubscripts = State.Column;
817 if (Style.BreakBeforeTernaryOperators && Current.is(tok::question))
818 State.Stack.back().QuestionColumn = State.Column;
819 if (!Style.BreakBeforeTernaryOperators && Current.isNot(tok::colon)) {
820 const FormatToken *Previous = Current.Previous;
821 while (Previous && Previous->isTrailingComment())
822 Previous = Previous->Previous;
823 if (Previous && Previous->is(tok::question))
824 State.Stack.back().QuestionColumn = State.Column;
826 if (!Current.opensScope() && !Current.closesScope() &&
827 !Current.is(TT_PointerOrReference))
828 State.LowestLevelOnLine =
829 std::min(State.LowestLevelOnLine, Current.NestingLevel);
830 if (Current.isMemberAccess())
831 State.Stack.back().StartOfFunctionCall =
832 !Current.NextOperator ? 0 : State.Column;
833 if (Current.is(TT_SelectorName)) {
834 State.Stack.back().ObjCSelectorNameFound = true;
835 if (Style.IndentWrappedFunctionNames) {
836 State.Stack.back().Indent =
837 State.FirstIndent + Style.ContinuationIndentWidth;
840 if (Current.is(TT_CtorInitializerColon) &&
841 Style.BreakConstructorInitializers != FormatStyle::BCIS_AfterColon) {
842 // Indent 2 from the column, so:
843 // SomeClass::SomeClass()
847 State.Stack.back().Indent =
848 State.Column + (Style.BreakConstructorInitializers ==
849 FormatStyle::BCIS_BeforeComma ? 0 : 2);
850 State.Stack.back().NestedBlockIndent = State.Stack.back().Indent;
851 if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
852 State.Stack.back().AvoidBinPacking = true;
853 State.Stack.back().BreakBeforeParameter = false;
855 if (Current.is(TT_CtorInitializerColon) &&
856 Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon) {
857 State.Stack.back().Indent =
858 State.FirstIndent + Style.ConstructorInitializerIndentWidth;
859 State.Stack.back().NestedBlockIndent = State.Stack.back().Indent;
860 if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine)
861 State.Stack.back().AvoidBinPacking = true;
863 if (Current.is(TT_InheritanceColon))
864 State.Stack.back().Indent =
865 State.FirstIndent + Style.ContinuationIndentWidth;
866 if (Current.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) && Newline)
867 State.Stack.back().NestedBlockIndent =
868 State.Column + Current.ColumnWidth + 1;
869 if (Current.isOneOf(TT_LambdaLSquare, TT_LambdaArrow))
870 State.Stack.back().LastSpace = State.Column;
872 // Insert scopes created by fake parenthesis.
873 const FormatToken *Previous = Current.getPreviousNonComment();
875 // Add special behavior to support a format commonly used for JavaScript
877 // SomeFunction(function() {
881 if (Current.isNot(tok::comment) && Previous &&
882 Previous->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) &&
883 !Previous->is(TT_DictLiteral) && State.Stack.size() > 1) {
884 if (State.Stack[State.Stack.size() - 2].NestedBlockInlined && Newline)
885 for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i)
886 State.Stack[i].NoLineBreak = true;
887 State.Stack[State.Stack.size() - 2].NestedBlockInlined = false;
889 if (Previous && (Previous->isOneOf(tok::l_paren, tok::comma, tok::colon) ||
890 Previous->isOneOf(TT_BinaryOperator, TT_ConditionalExpr)) &&
891 !Previous->isOneOf(TT_DictLiteral, TT_ObjCMethodExpr)) {
892 State.Stack.back().NestedBlockInlined =
894 (Previous->isNot(tok::l_paren) || Previous->ParameterCount > 1);
897 moveStatePastFakeLParens(State, Newline);
898 moveStatePastScopeCloser(State);
899 if (Current.is(TT_TemplateString) && Current.opensScope())
900 State.Stack.back().LastSpace =
901 (Current.IsMultiline ? Current.LastLineColumnWidth
902 : State.Column + Current.ColumnWidth) -
904 bool CanBreakProtrudingToken = !State.Stack.back().NoLineBreak &&
905 !State.Stack.back().NoLineBreakInOperand;
906 moveStatePastScopeOpener(State, Newline);
907 moveStatePastFakeRParens(State);
909 if (Current.is(TT_ObjCStringLiteral) && State.StartOfStringLiteral == 0)
910 State.StartOfStringLiteral = State.Column + 1;
911 else if (Current.isStringLiteral() && State.StartOfStringLiteral == 0)
912 State.StartOfStringLiteral = State.Column;
913 else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash) &&
914 !Current.isStringLiteral())
915 State.StartOfStringLiteral = 0;
917 State.Column += Current.ColumnWidth;
918 State.NextToken = State.NextToken->Next;
919 unsigned Penalty = 0;
920 if (CanBreakProtrudingToken)
921 Penalty = breakProtrudingToken(Current, State, DryRun);
922 if (State.Column > getColumnLimit(State)) {
923 unsigned ExcessCharacters = State.Column - getColumnLimit(State);
924 Penalty += Style.PenaltyExcessCharacter * ExcessCharacters;
928 Current.Role->formatFromToken(State, this, DryRun);
929 // If the previous has a special role, let it consume tokens as appropriate.
930 // It is necessary to start at the previous token for the only implemented
931 // role (comma separated list). That way, the decision whether or not to break
932 // after the "{" is already done and both options are tried and evaluated.
933 // FIXME: This is ugly, find a better way.
934 if (Previous && Previous->Role)
935 Penalty += Previous->Role->formatAfterToken(State, this, DryRun);
940 void ContinuationIndenter::moveStatePastFakeLParens(LineState &State,
942 const FormatToken &Current = *State.NextToken;
943 const FormatToken *Previous = Current.getPreviousNonComment();
945 // Don't add extra indentation for the first fake parenthesis after
946 // 'return', assignments or opening <({[. The indentation for these cases
948 bool SkipFirstExtraIndent =
949 (Previous && (Previous->opensScope() ||
950 Previous->isOneOf(tok::semi, tok::kw_return) ||
951 (Previous->getPrecedence() == prec::Assignment &&
952 Style.AlignOperands) ||
953 Previous->is(TT_ObjCMethodExpr)));
954 for (SmallVectorImpl<prec::Level>::const_reverse_iterator
955 I = Current.FakeLParens.rbegin(),
956 E = Current.FakeLParens.rend();
958 ParenState NewParenState = State.Stack.back();
959 NewParenState.ContainsLineBreak = false;
960 NewParenState.LastOperatorWrapped = true;
961 NewParenState.NoLineBreak =
962 NewParenState.NoLineBreak || State.Stack.back().NoLineBreakInOperand;
964 // Don't propagate AvoidBinPacking into subexpressions of arg/param lists.
965 if (*I > prec::Comma)
966 NewParenState.AvoidBinPacking = false;
968 // Indent from 'LastSpace' unless these are fake parentheses encapsulating
969 // a builder type call after 'return' or, if the alignment after opening
970 // brackets is disabled.
971 if (!Current.isTrailingComment() &&
972 (Style.AlignOperands || *I < prec::Assignment) &&
973 (!Previous || Previous->isNot(tok::kw_return) ||
974 (Style.Language != FormatStyle::LK_Java && *I > 0)) &&
975 (Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign ||
976 *I != prec::Comma || Current.NestingLevel == 0))
977 NewParenState.Indent =
978 std::max(std::max(State.Column, NewParenState.Indent),
979 State.Stack.back().LastSpace);
981 // Do not indent relative to the fake parentheses inserted for "." or "->".
982 // This is a special case to make the following to statements consistent:
983 // OuterFunction(InnerFunctionCall( // break
984 // ParameterToInnerFunction));
985 // OuterFunction(SomeObject.InnerFunctionCall( // break
986 // ParameterToInnerFunction));
987 if (*I > prec::Unknown)
988 NewParenState.LastSpace = std::max(NewParenState.LastSpace, State.Column);
989 if (*I != prec::Conditional && !Current.is(TT_UnaryOperator) &&
990 Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign)
991 NewParenState.StartOfFunctionCall = State.Column;
993 // Always indent conditional expressions. Never indent expression where
994 // the 'operator' is ',', ';' or an assignment (i.e. *I <=
995 // prec::Assignment) as those have different indentation rules. Indent
996 // other expression, unless the indentation needs to be skipped.
997 if (*I == prec::Conditional ||
998 (!SkipFirstExtraIndent && *I > prec::Assignment &&
999 !Current.isTrailingComment()))
1000 NewParenState.Indent += Style.ContinuationIndentWidth;
1001 if ((Previous && !Previous->opensScope()) || *I != prec::Comma)
1002 NewParenState.BreakBeforeParameter = false;
1003 State.Stack.push_back(NewParenState);
1004 SkipFirstExtraIndent = false;
1008 void ContinuationIndenter::moveStatePastFakeRParens(LineState &State) {
1009 for (unsigned i = 0, e = State.NextToken->FakeRParens; i != e; ++i) {
1010 unsigned VariablePos = State.Stack.back().VariablePos;
1011 if (State.Stack.size() == 1) {
1012 // Do not pop the last element.
1015 State.Stack.pop_back();
1016 State.Stack.back().VariablePos = VariablePos;
1020 void ContinuationIndenter::moveStatePastScopeOpener(LineState &State,
1022 const FormatToken &Current = *State.NextToken;
1023 if (!Current.opensScope())
1026 if (Current.MatchingParen && Current.BlockKind == BK_Block) {
1027 moveStateToNewBlock(State);
1032 unsigned LastSpace = State.Stack.back().LastSpace;
1033 bool AvoidBinPacking;
1034 bool BreakBeforeParameter = false;
1035 unsigned NestedBlockIndent = std::max(State.Stack.back().StartOfFunctionCall,
1036 State.Stack.back().NestedBlockIndent);
1037 if (Current.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare)) {
1038 if (Current.opensBlockOrBlockTypeList(Style)) {
1039 NewIndent = State.Stack.back().NestedBlockIndent + Style.IndentWidth;
1040 NewIndent = std::min(State.Column + 2, NewIndent);
1042 NewIndent = State.Stack.back().LastSpace + Style.ContinuationIndentWidth;
1044 const FormatToken *NextNoComment = Current.getNextNonComment();
1045 bool EndsInComma = Current.MatchingParen &&
1046 Current.MatchingParen->Previous &&
1047 Current.MatchingParen->Previous->is(tok::comma);
1049 (Current.is(TT_ArrayInitializerLSquare) && EndsInComma) ||
1050 Current.is(TT_DictLiteral) ||
1051 Style.Language == FormatStyle::LK_Proto || !Style.BinPackArguments ||
1052 (NextNoComment && NextNoComment->is(TT_DesignatedInitializerPeriod));
1053 if (Current.ParameterCount > 1)
1054 NestedBlockIndent = std::max(NestedBlockIndent, State.Column + 1);
1056 NewIndent = Style.ContinuationIndentWidth +
1057 std::max(State.Stack.back().LastSpace,
1058 State.Stack.back().StartOfFunctionCall);
1060 // Ensure that different different brackets force relative alignment, e.g.:
1061 // void SomeFunction(vector< // break
1063 // FIXME: We likely want to do this for more combinations of brackets.
1064 // Verify that it is wanted for ObjC, too.
1065 if (Current.is(tok::less) && Current.ParentBracket == tok::l_paren) {
1066 NewIndent = std::max(NewIndent, State.Stack.back().Indent);
1067 LastSpace = std::max(LastSpace, State.Stack.back().Indent);
1070 // JavaScript template strings are special as we always want to indent
1071 // nested expressions relative to the ${}. Otherwise, this can create quite
1073 if (Current.is(TT_TemplateString)) {
1074 unsigned Column = Current.IsMultiline
1075 ? Current.LastLineColumnWidth
1076 : State.Column + Current.ColumnWidth;
1079 NestedBlockIndent = Column;
1083 Current.MatchingParen &&
1084 Current.MatchingParen->getPreviousNonComment() &&
1085 Current.MatchingParen->getPreviousNonComment()->is(tok::comma);
1088 (Style.Language == FormatStyle::LK_JavaScript && EndsInComma) ||
1089 (State.Line->MustBeDeclaration && !Style.BinPackParameters) ||
1090 (!State.Line->MustBeDeclaration && !Style.BinPackArguments) ||
1091 (Style.ExperimentalAutoDetectBinPacking &&
1092 (Current.PackingKind == PPK_OnePerLine ||
1093 (!BinPackInconclusiveFunctions &&
1094 Current.PackingKind == PPK_Inconclusive)));
1096 if (Current.is(TT_ObjCMethodExpr) && Current.MatchingParen) {
1097 if (Style.ColumnLimit) {
1098 // If this '[' opens an ObjC call, determine whether all parameters fit
1099 // into one line and put one per line if they don't.
1100 if (getLengthToMatchingParen(Current) + State.Column >
1101 getColumnLimit(State))
1102 BreakBeforeParameter = true;
1104 // For ColumnLimit = 0, we have to figure out whether there is or has to
1105 // be a line break within this call.
1106 for (const FormatToken *Tok = &Current;
1107 Tok && Tok != Current.MatchingParen; Tok = Tok->Next) {
1108 if (Tok->MustBreakBefore ||
1109 (Tok->CanBreakBefore && Tok->NewlinesBefore > 0)) {
1110 BreakBeforeParameter = true;
1117 if (Style.Language == FormatStyle::LK_JavaScript && EndsInComma)
1118 BreakBeforeParameter = true;
1120 // Generally inherit NoLineBreak from the current scope to nested scope.
1121 // However, don't do this for non-empty nested blocks, dict literals and
1122 // array literals as these follow different indentation rules.
1124 Current.Children.empty() &&
1125 !Current.isOneOf(TT_DictLiteral, TT_ArrayInitializerLSquare) &&
1126 (State.Stack.back().NoLineBreak ||
1127 State.Stack.back().NoLineBreakInOperand ||
1128 (Current.is(TT_TemplateOpener) &&
1129 State.Stack.back().ContainsUnwrappedBuilder));
1130 State.Stack.push_back(
1131 ParenState(NewIndent, LastSpace, AvoidBinPacking, NoLineBreak));
1132 State.Stack.back().NestedBlockIndent = NestedBlockIndent;
1133 State.Stack.back().BreakBeforeParameter = BreakBeforeParameter;
1134 State.Stack.back().HasMultipleNestedBlocks = Current.BlockParameterCount > 1;
1137 void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) {
1138 const FormatToken &Current = *State.NextToken;
1139 if (!Current.closesScope())
1142 // If we encounter a closing ), ], } or >, we can remove a level from our
1144 if (State.Stack.size() > 1 &&
1145 (Current.isOneOf(tok::r_paren, tok::r_square, TT_TemplateString) ||
1146 (Current.is(tok::r_brace) && State.NextToken != State.Line->First) ||
1147 State.NextToken->is(TT_TemplateCloser)))
1148 State.Stack.pop_back();
1150 if (Current.is(tok::r_square)) {
1151 // If this ends the array subscript expr, reset the corresponding value.
1152 const FormatToken *NextNonComment = Current.getNextNonComment();
1153 if (NextNonComment && NextNonComment->isNot(tok::l_square))
1154 State.Stack.back().StartOfArraySubscripts = 0;
1158 void ContinuationIndenter::moveStateToNewBlock(LineState &State) {
1159 unsigned NestedBlockIndent = State.Stack.back().NestedBlockIndent;
1160 // ObjC block sometimes follow special indentation rules.
1161 unsigned NewIndent =
1162 NestedBlockIndent + (State.NextToken->is(TT_ObjCBlockLBrace)
1163 ? Style.ObjCBlockIndentWidth
1164 : Style.IndentWidth);
1165 State.Stack.push_back(ParenState(NewIndent, State.Stack.back().LastSpace,
1166 /*AvoidBinPacking=*/true,
1167 /*NoLineBreak=*/false));
1168 State.Stack.back().NestedBlockIndent = NestedBlockIndent;
1169 State.Stack.back().BreakBeforeParameter = true;
1172 unsigned ContinuationIndenter::addMultilineToken(const FormatToken &Current,
1174 if (!Current.IsMultiline)
1177 // Break before further function parameters on all levels.
1178 for (unsigned i = 0, e = State.Stack.size(); i != e; ++i)
1179 State.Stack[i].BreakBeforeParameter = true;
1181 unsigned ColumnsUsed = State.Column;
1182 // We can only affect layout of the first and the last line, so the penalty
1183 // for all other lines is constant, and we ignore it.
1184 State.Column = Current.LastLineColumnWidth;
1186 if (ColumnsUsed > getColumnLimit(State))
1187 return Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit(State));
1191 unsigned ContinuationIndenter::breakProtrudingToken(const FormatToken &Current,
1194 // Don't break multi-line tokens other than block comments. Instead, just
1195 // update the state.
1196 if (Current.isNot(TT_BlockComment) && Current.IsMultiline)
1197 return addMultilineToken(Current, State);
1199 // Don't break implicit string literals or import statements.
1200 if (Current.is(TT_ImplicitStringLiteral) ||
1201 State.Line->Type == LT_ImportStatement)
1204 if (!Current.isStringLiteral() && !Current.is(tok::comment))
1207 std::unique_ptr<BreakableToken> Token;
1208 unsigned StartColumn = State.Column - Current.ColumnWidth;
1209 unsigned ColumnLimit = getColumnLimit(State);
1211 if (Current.isStringLiteral()) {
1212 // FIXME: String literal breaking is currently disabled for Java and JS, as
1213 // it requires strings to be merged using "+" which we don't support.
1214 if (Style.Language == FormatStyle::LK_Java ||
1215 Style.Language == FormatStyle::LK_JavaScript ||
1216 !Style.BreakStringLiterals)
1219 // Don't break string literals inside preprocessor directives (except for
1220 // #define directives, as their contents are stored in separate lines and
1221 // are not affected by this check).
1222 // This way we avoid breaking code with line directives and unknown
1223 // preprocessor directives that contain long string literals.
1224 if (State.Line->Type == LT_PreprocessorDirective)
1226 // Exempts unterminated string literals from line breaking. The user will
1227 // likely want to terminate the string before any line breaking is done.
1228 if (Current.IsUnterminatedLiteral)
1231 StringRef Text = Current.TokenText;
1234 // FIXME: Handle whitespace between '_T', '(', '"..."', and ')'.
1235 // FIXME: Store Prefix and Suffix (or PrefixLength and SuffixLength to
1236 // reduce the overhead) for each FormatToken, which is a string, so that we
1237 // don't run multiple checks here on the hot path.
1238 if ((Text.endswith(Postfix = "\"") &&
1239 (Text.startswith(Prefix = "@\"") || Text.startswith(Prefix = "\"") ||
1240 Text.startswith(Prefix = "u\"") || Text.startswith(Prefix = "U\"") ||
1241 Text.startswith(Prefix = "u8\"") ||
1242 Text.startswith(Prefix = "L\""))) ||
1243 (Text.startswith(Prefix = "_T(\"") && Text.endswith(Postfix = "\")"))) {
1244 Token.reset(new BreakableStringLiteral(Current, StartColumn, Prefix,
1245 Postfix, State.Line->InPPDirective,
1250 } else if (Current.is(TT_BlockComment)) {
1251 if (!Current.isTrailingComment() || !Style.ReflowComments ||
1252 // If a comment token switches formatting, like
1253 // /* clang-format on */, we don't want to break it further,
1254 // but we may still want to adjust its indentation.
1255 switchesFormatting(Current))
1256 return addMultilineToken(Current, State);
1257 Token.reset(new BreakableBlockComment(
1258 Current, StartColumn, Current.OriginalColumn, !Current.Previous,
1259 State.Line->InPPDirective, Encoding, Style));
1260 } else if (Current.is(TT_LineComment) &&
1261 (Current.Previous == nullptr ||
1262 Current.Previous->isNot(TT_ImplicitStringLiteral))) {
1263 if (!Style.ReflowComments ||
1264 CommentPragmasRegex.match(Current.TokenText.substr(2)) ||
1265 switchesFormatting(Current))
1267 Token.reset(new BreakableLineCommentSection(
1268 Current, StartColumn, Current.OriginalColumn, !Current.Previous,
1269 /*InPPDirective=*/false, Encoding, Style));
1270 // We don't insert backslashes when breaking line comments.
1271 ColumnLimit = Style.ColumnLimit;
1275 if (Current.UnbreakableTailLength >= ColumnLimit)
1278 unsigned RemainingSpace = ColumnLimit - Current.UnbreakableTailLength;
1279 bool BreakInserted = false;
1280 // We use a conservative reflowing strategy. Reflow starts after a line is
1281 // broken or the corresponding whitespace compressed. Reflow ends as soon as a
1282 // line that doesn't get reflown with the previous line is reached.
1283 bool ReflowInProgress = false;
1284 unsigned Penalty = 0;
1285 unsigned RemainingTokenColumns = 0;
1286 for (unsigned LineIndex = 0, EndIndex = Token->getLineCount();
1287 LineIndex != EndIndex; ++LineIndex) {
1288 BreakableToken::Split SplitBefore(StringRef::npos, 0);
1289 if (ReflowInProgress) {
1290 SplitBefore = Token->getSplitBefore(LineIndex, RemainingTokenColumns,
1291 RemainingSpace, CommentPragmasRegex);
1293 ReflowInProgress = SplitBefore.first != StringRef::npos;
1294 unsigned TailOffset =
1295 ReflowInProgress ? (SplitBefore.first + SplitBefore.second) : 0;
1297 Token->replaceWhitespaceBefore(LineIndex, RemainingTokenColumns,
1298 RemainingSpace, SplitBefore, Whitespaces);
1299 RemainingTokenColumns = Token->getLineLengthAfterSplitBefore(
1300 LineIndex, TailOffset, RemainingTokenColumns, ColumnLimit, SplitBefore);
1301 while (RemainingTokenColumns > RemainingSpace) {
1302 BreakableToken::Split Split = Token->getSplit(
1303 LineIndex, TailOffset, ColumnLimit, CommentPragmasRegex);
1304 if (Split.first == StringRef::npos) {
1305 // The last line's penalty is handled in addNextStateToQueue().
1306 if (LineIndex < EndIndex - 1)
1307 Penalty += Style.PenaltyExcessCharacter *
1308 (RemainingTokenColumns - RemainingSpace);
1311 assert(Split.first != 0);
1313 // Check if compressing the whitespace range will bring the line length
1314 // under the limit. If that is the case, we perform whitespace compression
1315 // instead of inserting a line break.
1316 unsigned RemainingTokenColumnsAfterCompression =
1317 Token->getLineLengthAfterCompression(RemainingTokenColumns, Split);
1318 if (RemainingTokenColumnsAfterCompression <= RemainingSpace) {
1319 RemainingTokenColumns = RemainingTokenColumnsAfterCompression;
1320 ReflowInProgress = true;
1322 Token->compressWhitespace(LineIndex, TailOffset, Split, Whitespaces);
1326 unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit(
1327 LineIndex, TailOffset + Split.first + Split.second, StringRef::npos);
1329 // When breaking before a tab character, it may be moved by a few columns,
1330 // but will still be expanded to the next tab stop, so we don't save any
1332 if (NewRemainingTokenColumns == RemainingTokenColumns)
1335 assert(NewRemainingTokenColumns < RemainingTokenColumns);
1337 Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces);
1338 Penalty += Current.SplitPenalty;
1339 unsigned ColumnsUsed =
1340 Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first);
1341 if (ColumnsUsed > ColumnLimit) {
1342 Penalty += Style.PenaltyExcessCharacter * (ColumnsUsed - ColumnLimit);
1344 TailOffset += Split.first + Split.second;
1345 RemainingTokenColumns = NewRemainingTokenColumns;
1346 ReflowInProgress = true;
1347 BreakInserted = true;
1351 State.Column = RemainingTokenColumns;
1353 if (BreakInserted) {
1354 // If we break the token inside a parameter list, we need to break before
1355 // the next parameter on all levels, so that the next parameter is clearly
1356 // visible. Line comments already introduce a break.
1357 if (Current.isNot(TT_LineComment)) {
1358 for (unsigned i = 0, e = State.Stack.size(); i != e; ++i)
1359 State.Stack[i].BreakBeforeParameter = true;
1362 Penalty += Current.isStringLiteral() ? Style.PenaltyBreakString
1363 : Style.PenaltyBreakComment;
1365 State.Stack.back().LastSpace = StartColumn;
1368 Token->updateNextToken(State);
1373 unsigned ContinuationIndenter::getColumnLimit(const LineState &State) const {
1374 // In preprocessor directives reserve two chars for trailing " \"
1375 return Style.ColumnLimit - (State.Line->InPPDirective ? 2 : 0);
1378 bool ContinuationIndenter::nextIsMultilineString(const LineState &State) {
1379 const FormatToken &Current = *State.NextToken;
1380 if (!Current.isStringLiteral() || Current.is(TT_ImplicitStringLiteral))
1382 // We never consider raw string literals "multiline" for the purpose of
1383 // AlwaysBreakBeforeMultilineStrings implementation as they are special-cased
1384 // (see TokenAnnotator::mustBreakBefore().
1385 if (Current.TokenText.startswith("R\""))
1387 if (Current.IsMultiline)
1389 if (Current.getNextNonComment() &&
1390 Current.getNextNonComment()->isStringLiteral())
1391 return true; // Implicit concatenation.
1392 if (Style.ColumnLimit != 0 &&
1393 State.Column + Current.ColumnWidth + Current.UnbreakableTailLength >
1395 return true; // String will be split.
1399 } // namespace format
1400 } // namespace clang