1de0328aeSDaniel Jasper //===--- ContinuationIndenter.cpp - Format C++ code -----------------------===// 2de0328aeSDaniel Jasper // 3de0328aeSDaniel Jasper // The LLVM Compiler Infrastructure 4de0328aeSDaniel Jasper // 5de0328aeSDaniel Jasper // This file is distributed under the University of Illinois Open Source 6de0328aeSDaniel Jasper // License. See LICENSE.TXT for details. 7de0328aeSDaniel Jasper // 8de0328aeSDaniel Jasper //===----------------------------------------------------------------------===// 9de0328aeSDaniel Jasper /// 10de0328aeSDaniel Jasper /// \file 11de0328aeSDaniel Jasper /// \brief This file implements the continuation indenter. 12de0328aeSDaniel Jasper /// 13de0328aeSDaniel Jasper //===----------------------------------------------------------------------===// 14de0328aeSDaniel Jasper 15de0328aeSDaniel Jasper #include "BreakableToken.h" 16de0328aeSDaniel Jasper #include "ContinuationIndenter.h" 17de0328aeSDaniel Jasper #include "WhitespaceManager.h" 18de0328aeSDaniel Jasper #include "clang/Basic/OperatorPrecedence.h" 19de0328aeSDaniel Jasper #include "clang/Basic/SourceManager.h" 20de0328aeSDaniel Jasper #include "clang/Format/Format.h" 21de0328aeSDaniel Jasper #include "llvm/Support/Debug.h" 22de0328aeSDaniel Jasper #include <string> 23de0328aeSDaniel Jasper 2410346667SChandler Carruth #define DEBUG_TYPE "format-formatter" 2510346667SChandler Carruth 26de0328aeSDaniel Jasper namespace clang { 27de0328aeSDaniel Jasper namespace format { 28de0328aeSDaniel Jasper 29de0328aeSDaniel Jasper // Returns the length of everything up to the first possible line break after 30de0328aeSDaniel Jasper // the ), ], } or > matching \c Tok. 31de0328aeSDaniel Jasper static unsigned getLengthToMatchingParen(const FormatToken &Tok) { 322145bc02SCraig Topper if (!Tok.MatchingParen) 33de0328aeSDaniel Jasper return 0; 34de0328aeSDaniel Jasper FormatToken *End = Tok.MatchingParen; 35de0328aeSDaniel Jasper while (End->Next && !End->Next->CanBreakBefore) { 36de0328aeSDaniel Jasper End = End->Next; 37de0328aeSDaniel Jasper } 38de0328aeSDaniel Jasper return End->TotalLength - Tok.TotalLength + 1; 39de0328aeSDaniel Jasper } 40de0328aeSDaniel Jasper 414c6e0059SDaniel Jasper // Returns \c true if \c Tok is the "." or "->" of a call and starts the next 424c6e0059SDaniel Jasper // segment of a builder type call. 434c6e0059SDaniel Jasper static bool startsSegmentOfBuilderTypeCall(const FormatToken &Tok) { 444c6e0059SDaniel Jasper return Tok.isMemberAccess() && Tok.Previous && Tok.Previous->closesScope(); 454c6e0059SDaniel Jasper } 464c6e0059SDaniel Jasper 47ec01cd6eSDaniel Jasper // Returns \c true if \c Current starts a new parameter. 48ec01cd6eSDaniel Jasper static bool startsNextParameter(const FormatToken &Current, 49ec01cd6eSDaniel Jasper const FormatStyle &Style) { 50ec01cd6eSDaniel Jasper const FormatToken &Previous = *Current.Previous; 51ec01cd6eSDaniel Jasper if (Current.Type == TT_CtorInitializerComma && 52ec01cd6eSDaniel Jasper Style.BreakConstructorInitializersBeforeComma) 53ec01cd6eSDaniel Jasper return true; 54ec01cd6eSDaniel Jasper return Previous.is(tok::comma) && !Current.isTrailingComment() && 55ec01cd6eSDaniel Jasper (Previous.Type != TT_CtorInitializerComma || 56ec01cd6eSDaniel Jasper !Style.BreakConstructorInitializersBeforeComma); 57ec01cd6eSDaniel Jasper } 58ec01cd6eSDaniel Jasper 59de0328aeSDaniel Jasper ContinuationIndenter::ContinuationIndenter(const FormatStyle &Style, 60de0328aeSDaniel Jasper SourceManager &SourceMgr, 61de0328aeSDaniel Jasper WhitespaceManager &Whitespaces, 62de0328aeSDaniel Jasper encoding::Encoding Encoding, 63de0328aeSDaniel Jasper bool BinPackInconclusiveFunctions) 649fe0e8daSDaniel Jasper : Style(Style), SourceMgr(SourceMgr), Whitespaces(Whitespaces), 659fe0e8daSDaniel Jasper Encoding(Encoding), 66ce9161a5SAlexander Kornienko BinPackInconclusiveFunctions(BinPackInconclusiveFunctions), 67ce9161a5SAlexander Kornienko CommentPragmasRegex(Style.CommentPragmas) {} 68de0328aeSDaniel Jasper 699fe0e8daSDaniel Jasper LineState ContinuationIndenter::getInitialState(unsigned FirstIndent, 701c5d9df8SDaniel Jasper const AnnotatedLine *Line, 711c5d9df8SDaniel Jasper bool DryRun) { 72de0328aeSDaniel Jasper LineState State; 739fe0e8daSDaniel Jasper State.FirstIndent = FirstIndent; 74de0328aeSDaniel Jasper State.Column = FirstIndent; 759fe0e8daSDaniel Jasper State.Line = Line; 769fe0e8daSDaniel Jasper State.NextToken = Line->First; 77e2e0387fSAlexander Kornienko State.Stack.push_back(ParenState(FirstIndent, Line->Level, FirstIndent, 78de0328aeSDaniel Jasper /*AvoidBinPacking=*/false, 79de0328aeSDaniel Jasper /*NoLineBreak=*/false)); 80de0328aeSDaniel Jasper State.LineContainsContinuedForLoopSection = false; 81de0328aeSDaniel Jasper State.StartOfStringLiteral = 0; 8205cd5868SDaniel Jasper State.StartOfLineLevel = 0; 8305cd5868SDaniel Jasper State.LowestLevelOnLine = 0; 84de0328aeSDaniel Jasper State.IgnoreStackForComparison = false; 85de0328aeSDaniel Jasper 86de0328aeSDaniel Jasper // The first token has already been indented and thus consumed. 871c5d9df8SDaniel Jasper moveStateToNextToken(State, DryRun, /*Newline=*/false); 88de0328aeSDaniel Jasper return State; 89de0328aeSDaniel Jasper } 90de0328aeSDaniel Jasper 91de0328aeSDaniel Jasper bool ContinuationIndenter::canBreak(const LineState &State) { 92de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 93de0328aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 94de0328aeSDaniel Jasper assert(&Previous == Current.Previous); 951db6c386SDaniel Jasper if (!Current.CanBreakBefore && !(State.Stack.back().BreakBeforeClosingBrace && 961db6c386SDaniel Jasper Current.closesBlockTypeList(Style))) 97de0328aeSDaniel Jasper return false; 98de0328aeSDaniel Jasper // The opening "{" of a braced list has to be on the same line as the first 99de0328aeSDaniel Jasper // element if it is nested in another braced init list or function call. 100de0328aeSDaniel Jasper if (!Current.MustBreakBefore && Previous.is(tok::l_brace) && 101b05a81deSDaniel Jasper Previous.Type != TT_DictLiteral && Previous.BlockKind == BK_BracedInit && 102b05a81deSDaniel Jasper Previous.Previous && 103de0328aeSDaniel Jasper Previous.Previous->isOneOf(tok::l_brace, tok::l_paren, tok::comma)) 104de0328aeSDaniel Jasper return false; 105de0328aeSDaniel Jasper // This prevents breaks like: 106de0328aeSDaniel Jasper // ... 107de0328aeSDaniel Jasper // SomeParameter, OtherParameter).DoSomething( 108de0328aeSDaniel Jasper // ... 109de0328aeSDaniel Jasper // As they hide "DoSomething" and are generally bad for readability. 1108f59ae53SDaniel Jasper if (Previous.opensScope() && Previous.isNot(tok::l_brace) && 111fcfac10cSDaniel Jasper State.LowestLevelOnLine < State.StartOfLineLevel && 112fcfac10cSDaniel Jasper State.LowestLevelOnLine < Current.NestingLevel) 113de0328aeSDaniel Jasper return false; 1144c6e0059SDaniel Jasper if (Current.isMemberAccess() && State.Stack.back().ContainsUnwrappedBuilder) 1154c6e0059SDaniel Jasper return false; 116114a2bc9SDaniel Jasper 117114a2bc9SDaniel Jasper // Don't create a 'hanging' indent if there are multiple blocks in a single 118114a2bc9SDaniel Jasper // statement. 119114a2bc9SDaniel Jasper if (Style.Language == FormatStyle::LK_JavaScript && 120114a2bc9SDaniel Jasper Previous.is(tok::l_brace) && State.Stack.size() > 1 && 121114a2bc9SDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined && 122114a2bc9SDaniel Jasper State.Stack[State.Stack.size() - 2].HasMultipleNestedBlocks) 123114a2bc9SDaniel Jasper return false; 124114a2bc9SDaniel Jasper 125de0328aeSDaniel Jasper return !State.Stack.back().NoLineBreak; 126de0328aeSDaniel Jasper } 127de0328aeSDaniel Jasper 128de0328aeSDaniel Jasper bool ContinuationIndenter::mustBreak(const LineState &State) { 129de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 130de0328aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 131de0328aeSDaniel Jasper if (Current.MustBreakBefore || Current.Type == TT_InlineASMColon) 132de0328aeSDaniel Jasper return true; 1331db6c386SDaniel Jasper if (State.Stack.back().BreakBeforeClosingBrace && 1341db6c386SDaniel Jasper Current.closesBlockTypeList(Style)) 135de0328aeSDaniel Jasper return true; 136de0328aeSDaniel Jasper if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection) 137de0328aeSDaniel Jasper return true; 138ec01cd6eSDaniel Jasper if ((startsNextParameter(Current, Style) || Previous.is(tok::semi) || 139165b29e2SDaniel Jasper (Style.BreakBeforeTernaryOperators && 140165b29e2SDaniel Jasper (Current.is(tok::question) || (Current.Type == TT_ConditionalExpr && 141165b29e2SDaniel Jasper Previous.isNot(tok::question)))) || 142165b29e2SDaniel Jasper (!Style.BreakBeforeTernaryOperators && 143165b29e2SDaniel Jasper (Previous.is(tok::question) || Previous.Type == TT_ConditionalExpr))) && 144de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter && !Current.isTrailingComment() && 145de0328aeSDaniel Jasper !Current.isOneOf(tok::r_paren, tok::r_brace)) 146de0328aeSDaniel Jasper return true; 147de0328aeSDaniel Jasper if (Style.AlwaysBreakBeforeMultilineStrings && 148f438cb76SDaniel Jasper State.Column > State.Stack.back().Indent && // Breaking saves columns. 14927943058SDaniel Jasper !Previous.isOneOf(tok::kw_return, tok::lessless, tok::at) && 1503251fff0SDaniel Jasper Previous.Type != TT_InlineASMColon && 1513251fff0SDaniel Jasper Previous.Type != TT_ConditionalExpr && nextIsMultilineString(State)) 152de0328aeSDaniel Jasper return true; 153a382cbe4SDaniel Jasper if (Style.Language != FormatStyle::LK_Proto && 154a382cbe4SDaniel Jasper ((Previous.Type == TT_DictLiteral && Previous.is(tok::l_brace)) || 1551db6c386SDaniel Jasper Previous.Type == TT_ArrayInitializerLSquare) && 156db8804b3SDaniel Jasper Style.ColumnLimit > 0 && 157d489dd34SDaniel Jasper getLengthToMatchingParen(Previous) + State.Column > getColumnLimit(State)) 158d489dd34SDaniel Jasper return true; 1595d2587daSDaniel Jasper if (Current.Type == TT_CtorInitializerColon && 160d74cf403SDaniel Jasper ((Style.AllowShortFunctionsOnASingleLine != FormatStyle::SFS_All) || 1615d2587daSDaniel Jasper Style.BreakConstructorInitializersBeforeComma || Style.ColumnLimit != 0)) 1625d2587daSDaniel Jasper return true; 163de0328aeSDaniel Jasper 1645d2587daSDaniel Jasper if (State.Column < getNewLineColumn(State)) 1655d2587daSDaniel Jasper return false; 166de0328aeSDaniel Jasper if (!Style.BreakBeforeBinaryOperators) { 167de0328aeSDaniel Jasper // If we need to break somewhere inside the LHS of a binary expression, we 168de0328aeSDaniel Jasper // should also break after the operator. Otherwise, the formatting would 169de0328aeSDaniel Jasper // hide the operator precedence, e.g. in: 170de0328aeSDaniel Jasper // if (aaaaaaaaaaaaaa == 171de0328aeSDaniel Jasper // bbbbbbbbbbbbbb && c) {.. 172de0328aeSDaniel Jasper // For comparisons, we only apply this rule, if the LHS is a binary 173de0328aeSDaniel Jasper // expression itself as otherwise, the line breaks seem superfluous. 174de0328aeSDaniel Jasper // We need special cases for ">>" which we have split into two ">" while 175de0328aeSDaniel Jasper // lexing in order to make template parsing easier. 176de0328aeSDaniel Jasper // 177de0328aeSDaniel Jasper // FIXME: We'll need something similar for styles that break before binary 178de0328aeSDaniel Jasper // operators. 179de0328aeSDaniel Jasper bool IsComparison = (Previous.getPrecedence() == prec::Relational || 180de0328aeSDaniel Jasper Previous.getPrecedence() == prec::Equality) && 181de0328aeSDaniel Jasper Previous.Previous && 182de0328aeSDaniel Jasper Previous.Previous->Type != TT_BinaryOperator; // For >>. 183de0328aeSDaniel Jasper bool LHSIsBinaryExpr = 184562ecd44SDaniel Jasper Previous.Previous && Previous.Previous->EndsBinaryExpression; 185de0328aeSDaniel Jasper if (Previous.Type == TT_BinaryOperator && 186de0328aeSDaniel Jasper (!IsComparison || LHSIsBinaryExpr) && 187de0328aeSDaniel Jasper Current.Type != TT_BinaryOperator && // For >>. 188c0d606a5SDaniel Jasper !Current.isTrailingComment() && !Previous.is(tok::lessless) && 189de0328aeSDaniel Jasper Previous.getPrecedence() != prec::Assignment && 190de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter) 191de0328aeSDaniel Jasper return true; 192de0328aeSDaniel Jasper } 193de0328aeSDaniel Jasper 194de0328aeSDaniel Jasper // Same as above, but for the first "<<" operator. 19586b2dfdcSAlexander Kornienko if (Current.is(tok::lessless) && Current.Type != TT_OverloadedOperator && 19686b2dfdcSAlexander Kornienko State.Stack.back().BreakBeforeParameter && 197de0328aeSDaniel Jasper State.Stack.back().FirstLessLess == 0) 198de0328aeSDaniel Jasper return true; 199de0328aeSDaniel Jasper 20017062ff5SDaniel Jasper if (Current.Type == TT_SelectorName && 201b88b25feSDaniel Jasper State.Stack.back().ObjCSelectorNameFound && 202de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter) 203de0328aeSDaniel Jasper return true; 20405cd5868SDaniel Jasper if (Previous.ClosesTemplateDeclaration && Current.NestingLevel == 0 && 205a594ba8aSAlexander Kornienko !Current.isTrailingComment()) 206de0328aeSDaniel Jasper return true; 207de0328aeSDaniel Jasper 2084355e7f0SDaniel Jasper // If the return type spans multiple lines, wrap before the function name. 2094355e7f0SDaniel Jasper if ((Current.Type == TT_FunctionDeclarationName || 2104355e7f0SDaniel Jasper Current.is(tok::kw_operator)) && 2114355e7f0SDaniel Jasper State.Stack.back().BreakBeforeParameter) 212de0328aeSDaniel Jasper return true; 2134355e7f0SDaniel Jasper 2144c6e0059SDaniel Jasper if (startsSegmentOfBuilderTypeCall(Current) && 215f8151e9bSDaniel Jasper (State.Stack.back().CallContinuation != 0 || 216f8151e9bSDaniel Jasper (State.Stack.back().BreakBeforeParameter && 217f8151e9bSDaniel Jasper State.Stack.back().ContainsUnwrappedBuilder))) 2184c6e0059SDaniel Jasper return true; 2199697281eSDaniel Jasper 2209697281eSDaniel Jasper // The following could be precomputed as they do not depend on the state. 2219697281eSDaniel Jasper // However, as they should take effect only if the UnwrappedLine does not fit 2229697281eSDaniel Jasper // into the ColumnLimit, they are checked here in the ContinuationIndenter. 22335995679SDaniel Jasper if (Style.ColumnLimit != 0 && Previous.BlockKind == BK_Block && 22435995679SDaniel Jasper Previous.is(tok::l_brace) && !Current.isOneOf(tok::r_brace, tok::comment)) 2259697281eSDaniel Jasper return true; 2269697281eSDaniel Jasper 227de0328aeSDaniel Jasper return false; 228de0328aeSDaniel Jasper } 229de0328aeSDaniel Jasper 230de0328aeSDaniel Jasper unsigned ContinuationIndenter::addTokenToState(LineState &State, bool Newline, 2318de9ed05SDaniel Jasper bool DryRun, 2328de9ed05SDaniel Jasper unsigned ExtraSpaces) { 233de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 234de0328aeSDaniel Jasper 235819788daSManuel Klimek assert(!State.Stack.empty()); 236819788daSManuel Klimek if ((Current.Type == TT_ImplicitStringLiteral && 2372145bc02SCraig Topper (Current.Previous->Tok.getIdentifierInfo() == nullptr || 2389885784dSDaniel Jasper Current.Previous->Tok.getIdentifierInfo()->getPPKeywordID() == 2399885784dSDaniel Jasper tok::pp_not_keyword))) { 240de0328aeSDaniel Jasper // FIXME: Is this correct? 241de0328aeSDaniel Jasper int WhitespaceLength = SourceMgr.getSpellingColumnNumber( 242de0328aeSDaniel Jasper State.NextToken->WhitespaceRange.getEnd()) - 243de0328aeSDaniel Jasper SourceMgr.getSpellingColumnNumber( 244de0328aeSDaniel Jasper State.NextToken->WhitespaceRange.getBegin()); 245da353cd5SDaniel Jasper State.Column += WhitespaceLength; 246240dfda3SDaniel Jasper moveStateToNextToken(State, DryRun, /*Newline=*/false); 247de0328aeSDaniel Jasper return 0; 248de0328aeSDaniel Jasper } 249de0328aeSDaniel Jasper 2501f80396dSAlexander Kornienko unsigned Penalty = 0; 2511f80396dSAlexander Kornienko if (Newline) 2521f80396dSAlexander Kornienko Penalty = addTokenOnNewLine(State, DryRun); 2531f80396dSAlexander Kornienko else 25448437ce5SDaniel Jasper addTokenOnCurrentLine(State, DryRun, ExtraSpaces); 2551f80396dSAlexander Kornienko 2561f80396dSAlexander Kornienko return moveStateToNextToken(State, DryRun, Newline) + Penalty; 2571f80396dSAlexander Kornienko } 2581f80396dSAlexander Kornienko 25948437ce5SDaniel Jasper void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun, 2601f80396dSAlexander Kornienko unsigned ExtraSpaces) { 26171814b44SManuel Klimek FormatToken &Current = *State.NextToken; 2621f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 2631f80396dSAlexander Kornienko if (Current.is(tok::equal) && 26405cd5868SDaniel Jasper (State.Line->First->is(tok::kw_for) || Current.NestingLevel == 0) && 2651f80396dSAlexander Kornienko State.Stack.back().VariablePos == 0) { 2661f80396dSAlexander Kornienko State.Stack.back().VariablePos = State.Column; 2671f80396dSAlexander Kornienko // Move over * and & if they are bound to the variable name. 2681f80396dSAlexander Kornienko const FormatToken *Tok = &Previous; 2691f80396dSAlexander Kornienko while (Tok && State.Stack.back().VariablePos >= Tok->ColumnWidth) { 2701f80396dSAlexander Kornienko State.Stack.back().VariablePos -= Tok->ColumnWidth; 2711f80396dSAlexander Kornienko if (Tok->SpacesRequiredBefore != 0) 2721f80396dSAlexander Kornienko break; 2731f80396dSAlexander Kornienko Tok = Tok->Previous; 2741f80396dSAlexander Kornienko } 2751f80396dSAlexander Kornienko if (Previous.PartOfMultiVariableDeclStmt) 2761f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Stack.back().VariablePos; 2771f80396dSAlexander Kornienko } 2781f80396dSAlexander Kornienko 2791f80396dSAlexander Kornienko unsigned Spaces = Current.SpacesRequiredBefore + ExtraSpaces; 2801f80396dSAlexander Kornienko 2811f80396dSAlexander Kornienko if (!DryRun) 2821f80396dSAlexander Kornienko Whitespaces.replaceWhitespace(Current, /*Newlines=*/0, /*IndentLevel=*/0, 2831f80396dSAlexander Kornienko Spaces, State.Column + Spaces); 2841f80396dSAlexander Kornienko 28517062ff5SDaniel Jasper if (Current.Type == TT_SelectorName && 286b88b25feSDaniel Jasper !State.Stack.back().ObjCSelectorNameFound) { 287b88b25feSDaniel Jasper if (Current.LongestObjCSelectorName == 0) 288b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 289b88b25feSDaniel Jasper else if (State.Stack.back().Indent + Current.LongestObjCSelectorName > 2901f80396dSAlexander Kornienko State.Column + Spaces + Current.ColumnWidth) 2911f80396dSAlexander Kornienko State.Stack.back().ColonPos = 2921f80396dSAlexander Kornienko State.Stack.back().Indent + Current.LongestObjCSelectorName; 2931f80396dSAlexander Kornienko else 2941f80396dSAlexander Kornienko State.Stack.back().ColonPos = State.Column + Spaces + Current.ColumnWidth; 2951f80396dSAlexander Kornienko } 2961f80396dSAlexander Kornienko 2971f80396dSAlexander Kornienko if (Previous.opensScope() && Previous.Type != TT_ObjCMethodExpr && 2985a611397SDaniel Jasper (Current.Type != TT_LineComment || Previous.BlockKind == BK_BracedInit)) 2991f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column + Spaces; 300ec01cd6eSDaniel Jasper if (State.Stack.back().AvoidBinPacking && startsNextParameter(Current, Style)) 3011f80396dSAlexander Kornienko State.Stack.back().NoLineBreak = true; 3021f80396dSAlexander Kornienko if (startsSegmentOfBuilderTypeCall(Current)) 3031f80396dSAlexander Kornienko State.Stack.back().ContainsUnwrappedBuilder = true; 3041f80396dSAlexander Kornienko 305d6f17d83SDaniel Jasper if (Current.isMemberAccess() && Previous.is(tok::r_paren) && 306d6f17d83SDaniel Jasper (Previous.MatchingParen && 307d6f17d83SDaniel Jasper (Previous.TotalLength - Previous.MatchingParen->TotalLength > 10))) { 308d6f17d83SDaniel Jasper // If there is a function call with long parameters, break before trailing 309d6f17d83SDaniel Jasper // calls. This prevents things like: 310d6f17d83SDaniel Jasper // EXPECT_CALL(SomeLongParameter).Times( 311d6f17d83SDaniel Jasper // 2); 312d6f17d83SDaniel Jasper // We don't want to do this for short parameters as they can just be 313d6f17d83SDaniel Jasper // indexes. 314d6f17d83SDaniel Jasper State.Stack.back().NoLineBreak = true; 315d6f17d83SDaniel Jasper } 316d6f17d83SDaniel Jasper 3171f80396dSAlexander Kornienko State.Column += Spaces; 3188acf822bSDaniel Jasper if (Current.isNot(tok::comment) && Previous.is(tok::l_paren) && 3198acf822bSDaniel Jasper Previous.Previous && Previous.Previous->isOneOf(tok::kw_if, tok::kw_for)) 3201f80396dSAlexander Kornienko // Treat the condition inside an if as if it was a second function 3216633ab8aSDaniel Jasper // parameter, i.e. let nested calls have a continuation indent. 3228acf822bSDaniel Jasper State.Stack.back().LastSpace = State.Column; 323114a2bc9SDaniel Jasper else if (!Current.isOneOf(tok::comment, tok::caret) && 324b88b25feSDaniel Jasper (Previous.is(tok::comma) || 325b88b25feSDaniel Jasper (Previous.is(tok::colon) && Previous.Type == TT_ObjCMethodExpr))) 3261f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 3271f80396dSAlexander Kornienko else if ((Previous.Type == TT_BinaryOperator || 3281f80396dSAlexander Kornienko Previous.Type == TT_ConditionalExpr || 3291f80396dSAlexander Kornienko Previous.Type == TT_CtorInitializerColon) && 3300e61784aSDaniel Jasper ((Previous.getPrecedence() != prec::Assignment && 3310e61784aSDaniel Jasper (Previous.isNot(tok::lessless) || Previous.OperatorIndex != 0 || 3320e61784aSDaniel Jasper !Previous.LastOperator)) || 3331f80396dSAlexander Kornienko Current.StartsBinaryExpression)) 3341f80396dSAlexander Kornienko // Always indent relative to the RHS of the expression unless this is a 3351f80396dSAlexander Kornienko // simple assignment without binary expression on the RHS. Also indent 3361f80396dSAlexander Kornienko // relative to unary operators and the colons of constructor initializers. 3371f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 338f9a5e404SDaniel Jasper else if (Previous.Type == TT_InheritanceColon) { 3391f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column; 340f9a5e404SDaniel Jasper State.Stack.back().LastSpace = State.Column; 341f9a5e404SDaniel Jasper } else if (Previous.opensScope()) { 3421f80396dSAlexander Kornienko // If a function has a trailing call, indent all parameters from the 3431f80396dSAlexander Kornienko // opening parenthesis. This avoids confusing indents like: 3441f80396dSAlexander Kornienko // OuterFunction(InnerFunctionCall( // break 3451f80396dSAlexander Kornienko // ParameterToInnerFunction)) // break 3461f80396dSAlexander Kornienko // .SecondInnerFunctionCall(); 3471f80396dSAlexander Kornienko bool HasTrailingCall = false; 3481f80396dSAlexander Kornienko if (Previous.MatchingParen) { 3491f80396dSAlexander Kornienko const FormatToken *Next = Previous.MatchingParen->getNextNonComment(); 3501f80396dSAlexander Kornienko HasTrailingCall = Next && Next->isMemberAccess(); 3511f80396dSAlexander Kornienko } 3521f80396dSAlexander Kornienko if (HasTrailingCall && 3531f80396dSAlexander Kornienko State.Stack[State.Stack.size() - 2].CallContinuation == 0) 3541f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 3551f80396dSAlexander Kornienko } 3561f80396dSAlexander Kornienko } 3571f80396dSAlexander Kornienko 3581f80396dSAlexander Kornienko unsigned ContinuationIndenter::addTokenOnNewLine(LineState &State, 3591f80396dSAlexander Kornienko bool DryRun) { 36071814b44SManuel Klimek FormatToken &Current = *State.NextToken; 3611f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 3629f388d04SDaniel Jasper 3631f80396dSAlexander Kornienko // Extra penalty that needs to be added because of the way certain line 3641f80396dSAlexander Kornienko // breaks are chosen. 3651f80396dSAlexander Kornienko unsigned Penalty = 0; 3661f80396dSAlexander Kornienko 367a0407740SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 368a0407740SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 369a0407740SDaniel Jasper if (!NextNonComment) 370a0407740SDaniel Jasper NextNonComment = &Current; 37105cd5868SDaniel Jasper // The first line break on any NestingLevel causes an extra penalty in order 3728de9ed05SDaniel Jasper // prefer similar line breaks. 3738de9ed05SDaniel Jasper if (!State.Stack.back().ContainsLineBreak) 3748de9ed05SDaniel Jasper Penalty += 15; 3758de9ed05SDaniel Jasper State.Stack.back().ContainsLineBreak = true; 3768de9ed05SDaniel Jasper 3778de9ed05SDaniel Jasper Penalty += State.NextToken->SplitPenalty; 3788de9ed05SDaniel Jasper 379de0328aeSDaniel Jasper // Breaking before the first "<<" is generally not desirable if the LHS is 38048437ce5SDaniel Jasper // short. Also always add the penalty if the LHS is split over mutliple lines 3812b7556ecSDaniel Jasper // to avoid unnecessary line breaks that just work around this penalty. 382a0407740SDaniel Jasper if (NextNonComment->is(tok::lessless) && 383a0407740SDaniel Jasper State.Stack.back().FirstLessLess == 0 && 384004177eeSDaniel Jasper (State.Column <= Style.ColumnLimit / 3 || 38548437ce5SDaniel Jasper State.Stack.back().BreakBeforeParameter)) 3868de9ed05SDaniel Jasper Penalty += Style.PenaltyBreakFirstLessLess; 387de0328aeSDaniel Jasper 3889f388d04SDaniel Jasper State.Column = getNewLineColumn(State); 3899f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 3909f388d04SDaniel Jasper if (State.Stack.back().CallContinuation == 0) 391de0328aeSDaniel Jasper State.Stack.back().CallContinuation = State.Column; 39217062ff5SDaniel Jasper } else if (NextNonComment->Type == TT_SelectorName) { 393b88b25feSDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 394a0407740SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) { 395b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 396b88b25feSDaniel Jasper } else { 397b302f9a0SDaniel Jasper State.Stack.back().ColonPos = 398a0407740SDaniel Jasper State.Stack.back().Indent + NextNonComment->LongestObjCSelectorName; 399b88b25feSDaniel Jasper } 4009f388d04SDaniel Jasper } else if (State.Stack.back().AlignColons && 4019f388d04SDaniel Jasper State.Stack.back().ColonPos <= NextNonComment->ColumnWidth) { 402a0407740SDaniel Jasper State.Stack.back().ColonPos = State.Column + NextNonComment->ColumnWidth; 403de0328aeSDaniel Jasper } 4041fd6f1f8SDaniel Jasper } else if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 4051fd6f1f8SDaniel Jasper (PreviousNonComment->Type == TT_ObjCMethodExpr || 4061fd6f1f8SDaniel Jasper PreviousNonComment->Type == TT_DictLiteral)) { 407b88b25feSDaniel Jasper // FIXME: This is hacky, find a better way. The problem is that in an ObjC 408b88b25feSDaniel Jasper // method expression, the block should be aligned to the line starting it, 409b88b25feSDaniel Jasper // e.g.: 410b88b25feSDaniel Jasper // [aaaaaaaaaaaaaaa aaaaaaaaa: \\ break for some reason 411b88b25feSDaniel Jasper // ^(int *i) { 412b88b25feSDaniel Jasper // // ... 413b88b25feSDaniel Jasper // }]; 41405cd5868SDaniel Jasper // Thus, we set LastSpace of the next higher NestingLevel, to which we move 415b88b25feSDaniel Jasper // when we consume all of the "}"'s FakeRParens at the "{". 4169a26e773SDaniel Jasper if (State.Stack.size() > 1) 4179f388d04SDaniel Jasper State.Stack[State.Stack.size() - 2].LastSpace = 4189f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 4199f388d04SDaniel Jasper Style.ContinuationIndentWidth; 420de0328aeSDaniel Jasper } 421de0328aeSDaniel Jasper 422de0328aeSDaniel Jasper if ((Previous.isOneOf(tok::comma, tok::semi) && 423de0328aeSDaniel Jasper !State.Stack.back().AvoidBinPacking) || 424de0328aeSDaniel Jasper Previous.Type == TT_BinaryOperator) 425de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 42605cd5868SDaniel Jasper if (Previous.Type == TT_TemplateCloser && Current.NestingLevel == 0) 427de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 428a0407740SDaniel Jasper if (NextNonComment->is(tok::question) || 429165b29e2SDaniel Jasper (PreviousNonComment && PreviousNonComment->is(tok::question))) 430165b29e2SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 431de0328aeSDaniel Jasper 432de0328aeSDaniel Jasper if (!DryRun) { 433a69ca9beSDaniel Jasper unsigned Newlines = std::max( 434a69ca9beSDaniel Jasper 1u, std::min(Current.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1)); 435e2e0387fSAlexander Kornienko Whitespaces.replaceWhitespace(Current, Newlines, 436e2e0387fSAlexander Kornienko State.Stack.back().IndentLevel, State.Column, 437e2e0387fSAlexander Kornienko State.Column, State.Line->InPPDirective); 438de0328aeSDaniel Jasper } 439de0328aeSDaniel Jasper 440de0328aeSDaniel Jasper if (!Current.isTrailingComment()) 441de0328aeSDaniel Jasper State.Stack.back().LastSpace = State.Column; 44205cd5868SDaniel Jasper State.StartOfLineLevel = Current.NestingLevel; 44305cd5868SDaniel Jasper State.LowestLevelOnLine = Current.NestingLevel; 444de0328aeSDaniel Jasper 445de0328aeSDaniel Jasper // Any break on this level means that the parent level has been broken 446de0328aeSDaniel Jasper // and we need to avoid bin packing there. 447b16b969dSDaniel Jasper bool JavaScriptFormat = Style.Language == FormatStyle::LK_JavaScript && 448b16b969dSDaniel Jasper Current.is(tok::r_brace) && 449b16b969dSDaniel Jasper State.Stack.size() > 1 && 450b16b969dSDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined; 451b16b969dSDaniel Jasper if (!JavaScriptFormat) { 452de0328aeSDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { 453de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 454de0328aeSDaniel Jasper } 455b16b969dSDaniel Jasper } 456b16b969dSDaniel Jasper 4579e5ede0fSDaniel Jasper if (PreviousNonComment && 4589e5ede0fSDaniel Jasper !PreviousNonComment->isOneOf(tok::comma, tok::semi) && 4599e5ede0fSDaniel Jasper PreviousNonComment->Type != TT_TemplateCloser && 4609e5ede0fSDaniel Jasper PreviousNonComment->Type != TT_BinaryOperator && 461b05a81deSDaniel Jasper Current.Type != TT_BinaryOperator && !PreviousNonComment->opensScope()) 462de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 463de0328aeSDaniel Jasper 4641db6c386SDaniel Jasper // If we break after { or the [ of an array initializer, we should also break 4651db6c386SDaniel Jasper // before the corresponding } or ]. 46690818057SDaniel Jasper if (PreviousNonComment && 46790818057SDaniel Jasper (PreviousNonComment->is(tok::l_brace) || 46890818057SDaniel Jasper PreviousNonComment->Type == TT_ArrayInitializerLSquare)) 469de0328aeSDaniel Jasper State.Stack.back().BreakBeforeClosingBrace = true; 470de0328aeSDaniel Jasper 471de0328aeSDaniel Jasper if (State.Stack.back().AvoidBinPacking) { 472de0328aeSDaniel Jasper // If we are breaking after '(', '{', '<', this is not bin packing 4732a958321SDaniel Jasper // unless AllowAllParametersOfDeclarationOnNextLine is false or this is a 4742a958321SDaniel Jasper // dict/object literal. 475de0328aeSDaniel Jasper if (!(Previous.isOneOf(tok::l_paren, tok::l_brace) || 476de0328aeSDaniel Jasper Previous.Type == TT_BinaryOperator) || 477de0328aeSDaniel Jasper (!Style.AllowAllParametersOfDeclarationOnNextLine && 4782a958321SDaniel Jasper State.Line->MustBeDeclaration) || 4792a958321SDaniel Jasper Previous.Type == TT_DictLiteral) 480de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 481de0328aeSDaniel Jasper } 482de0328aeSDaniel Jasper 4831f80396dSAlexander Kornienko return Penalty; 484de0328aeSDaniel Jasper } 485de0328aeSDaniel Jasper 4869f388d04SDaniel Jasper unsigned ContinuationIndenter::getNewLineColumn(const LineState &State) { 4875d2587daSDaniel Jasper if (!State.NextToken || !State.NextToken->Previous) 4885d2587daSDaniel Jasper return 0; 4899f388d04SDaniel Jasper FormatToken &Current = *State.NextToken; 4904281c5aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 4919f388d04SDaniel Jasper // If we are continuing an expression, we want to use the continuation indent. 4929f388d04SDaniel Jasper unsigned ContinuationIndent = 4939f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 4949f388d04SDaniel Jasper Style.ContinuationIndentWidth; 4959f388d04SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 4969f388d04SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 4979f388d04SDaniel Jasper if (!NextNonComment) 4989f388d04SDaniel Jasper NextNonComment = &Current; 499b05a81deSDaniel Jasper if (NextNonComment->is(tok::l_brace) && NextNonComment->BlockKind == BK_Block) 50005cd5868SDaniel Jasper return Current.NestingLevel == 0 ? State.FirstIndent 5019f388d04SDaniel Jasper : State.Stack.back().Indent; 5029f388d04SDaniel Jasper if (Current.isOneOf(tok::r_brace, tok::r_square)) { 503b16b969dSDaniel Jasper if (State.Stack.size() > 1 && 504b16b969dSDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined) 505b16b969dSDaniel Jasper return State.FirstIndent; 5069f388d04SDaniel Jasper if (Current.closesBlockTypeList(Style) || 5079f388d04SDaniel Jasper (Current.MatchingParen && 5089f388d04SDaniel Jasper Current.MatchingParen->BlockKind == BK_BracedInit)) 5099f388d04SDaniel Jasper return State.Stack[State.Stack.size() - 2].LastSpace; 5109f388d04SDaniel Jasper else 5119f388d04SDaniel Jasper return State.FirstIndent; 5129f388d04SDaniel Jasper } 513783bac6bSDaniel Jasper if (Current.is(tok::identifier) && Current.Next && 514783bac6bSDaniel Jasper Current.Next->Type == TT_DictLiteral) 515783bac6bSDaniel Jasper return State.Stack.back().Indent; 5169f388d04SDaniel Jasper if (NextNonComment->isStringLiteral() && State.StartOfStringLiteral != 0) 5179f388d04SDaniel Jasper return State.StartOfStringLiteral; 5189f388d04SDaniel Jasper if (NextNonComment->is(tok::lessless) && 5199f388d04SDaniel Jasper State.Stack.back().FirstLessLess != 0) 5209f388d04SDaniel Jasper return State.Stack.back().FirstLessLess; 5219f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 5229f388d04SDaniel Jasper if (State.Stack.back().CallContinuation == 0) { 5239f388d04SDaniel Jasper return ContinuationIndent; 5249f388d04SDaniel Jasper } else { 5259f388d04SDaniel Jasper return State.Stack.back().CallContinuation; 5269f388d04SDaniel Jasper } 5279f388d04SDaniel Jasper } 5289f388d04SDaniel Jasper if (State.Stack.back().QuestionColumn != 0 && 529c0d606a5SDaniel Jasper ((NextNonComment->is(tok::colon) && 530c0d606a5SDaniel Jasper NextNonComment->Type == TT_ConditionalExpr) || 5319f388d04SDaniel Jasper Previous.Type == TT_ConditionalExpr)) 5329f388d04SDaniel Jasper return State.Stack.back().QuestionColumn; 5339f388d04SDaniel Jasper if (Previous.is(tok::comma) && State.Stack.back().VariablePos != 0) 5349f388d04SDaniel Jasper return State.Stack.back().VariablePos; 5359f388d04SDaniel Jasper if ((PreviousNonComment && (PreviousNonComment->ClosesTemplateDeclaration || 5369f388d04SDaniel Jasper PreviousNonComment->Type == TT_AttributeParen)) || 537c75e1effSDaniel Jasper (!Style.IndentWrappedFunctionNames && 538c75e1effSDaniel Jasper (NextNonComment->is(tok::kw_operator) || 539c75e1effSDaniel Jasper NextNonComment->Type == TT_FunctionDeclarationName))) 5409f388d04SDaniel Jasper return std::max(State.Stack.back().LastSpace, State.Stack.back().Indent); 54117062ff5SDaniel Jasper if (NextNonComment->Type == TT_SelectorName) { 5429f388d04SDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 5439f388d04SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) { 5449f388d04SDaniel Jasper return State.Stack.back().Indent; 5459f388d04SDaniel Jasper } else { 5469f388d04SDaniel Jasper return State.Stack.back().Indent + 5479f388d04SDaniel Jasper NextNonComment->LongestObjCSelectorName - 5489f388d04SDaniel Jasper NextNonComment->ColumnWidth; 5499f388d04SDaniel Jasper } 5509f388d04SDaniel Jasper } else if (!State.Stack.back().AlignColons) { 5519f388d04SDaniel Jasper return State.Stack.back().Indent; 5529f388d04SDaniel Jasper } else if (State.Stack.back().ColonPos > NextNonComment->ColumnWidth) { 5539f388d04SDaniel Jasper return State.Stack.back().ColonPos - NextNonComment->ColumnWidth; 5549f388d04SDaniel Jasper } else { 5559f388d04SDaniel Jasper return State.Stack.back().Indent; 5569f388d04SDaniel Jasper } 5579f388d04SDaniel Jasper } 5589f388d04SDaniel Jasper if (NextNonComment->Type == TT_ArraySubscriptLSquare) { 5599f388d04SDaniel Jasper if (State.Stack.back().StartOfArraySubscripts != 0) 5609f388d04SDaniel Jasper return State.Stack.back().StartOfArraySubscripts; 5619f388d04SDaniel Jasper else 5629f388d04SDaniel Jasper return ContinuationIndent; 5639f388d04SDaniel Jasper } 5649f388d04SDaniel Jasper if (NextNonComment->Type == TT_StartOfName || 5659f388d04SDaniel Jasper Previous.isOneOf(tok::coloncolon, tok::equal)) { 5669f388d04SDaniel Jasper return ContinuationIndent; 5679f388d04SDaniel Jasper } 5689f388d04SDaniel Jasper if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 5699f388d04SDaniel Jasper (PreviousNonComment->Type == TT_ObjCMethodExpr || 5709f388d04SDaniel Jasper PreviousNonComment->Type == TT_DictLiteral)) 5719f388d04SDaniel Jasper return ContinuationIndent; 5729f388d04SDaniel Jasper if (NextNonComment->Type == TT_CtorInitializerColon) 5739f388d04SDaniel Jasper return State.FirstIndent + Style.ConstructorInitializerIndentWidth; 5749f388d04SDaniel Jasper if (NextNonComment->Type == TT_CtorInitializerComma) 5759f388d04SDaniel Jasper return State.Stack.back().Indent; 576316ab38eSDaniel Jasper if (Previous.is(tok::r_paren) && !Current.isBinaryOperator() && 577316ab38eSDaniel Jasper Current.isNot(tok::colon)) 578316ab38eSDaniel Jasper return ContinuationIndent; 5795d2587daSDaniel Jasper if (State.Stack.back().Indent == State.FirstIndent && PreviousNonComment && 5809f388d04SDaniel Jasper PreviousNonComment->isNot(tok::r_brace)) 5819f388d04SDaniel Jasper // Ensure that we fall back to the continuation indent width instead of 5829f388d04SDaniel Jasper // just flushing continuations left. 5839f388d04SDaniel Jasper return State.Stack.back().Indent + Style.ContinuationIndentWidth; 5849f388d04SDaniel Jasper return State.Stack.back().Indent; 5859f388d04SDaniel Jasper } 5869f388d04SDaniel Jasper 587de0328aeSDaniel Jasper unsigned ContinuationIndenter::moveStateToNextToken(LineState &State, 588de0328aeSDaniel Jasper bool DryRun, bool Newline) { 589de0328aeSDaniel Jasper assert(State.Stack.size()); 59060553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 591de0328aeSDaniel Jasper 592de0328aeSDaniel Jasper if (Current.Type == TT_InheritanceColon) 593de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 594c0d606a5SDaniel Jasper if (Current.is(tok::lessless) && Current.Type != TT_OverloadedOperator) { 595c0d606a5SDaniel Jasper if (State.Stack.back().FirstLessLess == 0) 596de0328aeSDaniel Jasper State.Stack.back().FirstLessLess = State.Column; 597c0d606a5SDaniel Jasper else 598c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 599c0d606a5SDaniel Jasper } 600c0d606a5SDaniel Jasper if ((Current.Type == TT_BinaryOperator && Current.isNot(tok::lessless)) || 601c0d606a5SDaniel Jasper Current.Type == TT_ConditionalExpr) 602c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 6031db6c386SDaniel Jasper if (Current.Type == TT_ArraySubscriptLSquare && 604de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts == 0) 605de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = State.Column; 606165b29e2SDaniel Jasper if ((Current.is(tok::question) && Style.BreakBeforeTernaryOperators) || 607165b29e2SDaniel Jasper (Current.getPreviousNonComment() && Current.isNot(tok::colon) && 608165b29e2SDaniel Jasper Current.getPreviousNonComment()->is(tok::question) && 609165b29e2SDaniel Jasper !Style.BreakBeforeTernaryOperators)) 610de0328aeSDaniel Jasper State.Stack.back().QuestionColumn = State.Column; 611de0328aeSDaniel Jasper if (!Current.opensScope() && !Current.closesScope()) 612de0328aeSDaniel Jasper State.LowestLevelOnLine = 61305cd5868SDaniel Jasper std::min(State.LowestLevelOnLine, Current.NestingLevel); 6144c6e0059SDaniel Jasper if (Current.isMemberAccess()) 615de0328aeSDaniel Jasper State.Stack.back().StartOfFunctionCall = 6160e61784aSDaniel Jasper Current.LastOperator ? 0 : State.Column + Current.ColumnWidth; 61717062ff5SDaniel Jasper if (Current.Type == TT_SelectorName) 618b88b25feSDaniel Jasper State.Stack.back().ObjCSelectorNameFound = true; 619de0328aeSDaniel Jasper if (Current.Type == TT_CtorInitializerColon) { 620de0328aeSDaniel Jasper // Indent 2 from the column, so: 621de0328aeSDaniel Jasper // SomeClass::SomeClass() 622de0328aeSDaniel Jasper // : First(...), ... 623de0328aeSDaniel Jasper // Next(...) 624de0328aeSDaniel Jasper // ^ line up here. 625de0328aeSDaniel Jasper State.Stack.back().Indent = 626de0328aeSDaniel Jasper State.Column + (Style.BreakConstructorInitializersBeforeComma ? 0 : 2); 627de0328aeSDaniel Jasper if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine) 628de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 629de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 630de0328aeSDaniel Jasper } 631de0328aeSDaniel Jasper 632de0328aeSDaniel Jasper // In ObjC method declaration we align on the ":" of parameters, but we need 6336633ab8aSDaniel Jasper // to ensure that we indent parameters on subsequent lines by at least our 6346633ab8aSDaniel Jasper // continuation indent width. 635de0328aeSDaniel Jasper if (Current.Type == TT_ObjCMethodSpecifier) 6366633ab8aSDaniel Jasper State.Stack.back().Indent += Style.ContinuationIndentWidth; 637de0328aeSDaniel Jasper 638de0328aeSDaniel Jasper // Insert scopes created by fake parenthesis. 639de0328aeSDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 640b16b969dSDaniel Jasper 641b16b969dSDaniel Jasper // Add special behavior to support a format commonly used for JavaScript 642b16b969dSDaniel Jasper // closures: 643b16b969dSDaniel Jasper // SomeFunction(function() { 644b16b969dSDaniel Jasper // foo(); 645b16b969dSDaniel Jasper // bar(); 646b16b969dSDaniel Jasper // }, a, b, c); 647b16b969dSDaniel Jasper if (Style.Language == FormatStyle::LK_JavaScript) { 648b16b969dSDaniel Jasper if (Current.isNot(tok::comment) && Previous && Previous->is(tok::l_brace) && 649b16b969dSDaniel Jasper State.Stack.size() > 1) { 650b16b969dSDaniel Jasper if (State.Stack[State.Stack.size() - 2].JSFunctionInlined && Newline) { 651b16b969dSDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { 652b16b969dSDaniel Jasper State.Stack[i].NoLineBreak = true; 653b16b969dSDaniel Jasper } 654b16b969dSDaniel Jasper } 655b16b969dSDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined = false; 656b16b969dSDaniel Jasper } 657b16b969dSDaniel Jasper if (Current.TokenText == "function") 65890ebc98eSDaniel Jasper State.Stack.back().JSFunctionInlined = 6591779d438SDaniel Jasper !Newline && Previous && Previous->Type != TT_DictLiteral && 6601779d438SDaniel Jasper // If the unnamed function is the only parameter to another function, 6611779d438SDaniel Jasper // we can likely inline it and come up with a good format. 6621779d438SDaniel Jasper (Previous->isNot(tok::l_paren) || Previous->ParameterCount > 1); 663b16b969dSDaniel Jasper } 664b16b969dSDaniel Jasper 66560553be5SDaniel Jasper moveStatePastFakeLParens(State, Newline); 66660553be5SDaniel Jasper moveStatePastScopeOpener(State, Newline); 66760553be5SDaniel Jasper moveStatePastScopeCloser(State); 66860553be5SDaniel Jasper moveStatePastFakeRParens(State); 66960553be5SDaniel Jasper 67060553be5SDaniel Jasper if (Current.isStringLiteral() && State.StartOfStringLiteral == 0) { 67160553be5SDaniel Jasper State.StartOfStringLiteral = State.Column; 67260553be5SDaniel Jasper } else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash) && 67360553be5SDaniel Jasper !Current.isStringLiteral()) { 67460553be5SDaniel Jasper State.StartOfStringLiteral = 0; 67560553be5SDaniel Jasper } 67660553be5SDaniel Jasper 67760553be5SDaniel Jasper State.Column += Current.ColumnWidth; 67860553be5SDaniel Jasper State.NextToken = State.NextToken->Next; 67960553be5SDaniel Jasper unsigned Penalty = breakProtrudingToken(Current, State, DryRun); 68060553be5SDaniel Jasper if (State.Column > getColumnLimit(State)) { 68160553be5SDaniel Jasper unsigned ExcessCharacters = State.Column - getColumnLimit(State); 68260553be5SDaniel Jasper Penalty += Style.PenaltyExcessCharacter * ExcessCharacters; 68360553be5SDaniel Jasper } 68460553be5SDaniel Jasper 68560553be5SDaniel Jasper if (Current.Role) 68660553be5SDaniel Jasper Current.Role->formatFromToken(State, this, DryRun); 68760553be5SDaniel Jasper // If the previous has a special role, let it consume tokens as appropriate. 68860553be5SDaniel Jasper // It is necessary to start at the previous token for the only implemented 68960553be5SDaniel Jasper // role (comma separated list). That way, the decision whether or not to break 69060553be5SDaniel Jasper // after the "{" is already done and both options are tried and evaluated. 69160553be5SDaniel Jasper // FIXME: This is ugly, find a better way. 69260553be5SDaniel Jasper if (Previous && Previous->Role) 69360553be5SDaniel Jasper Penalty += Previous->Role->formatAfterToken(State, this, DryRun); 69460553be5SDaniel Jasper 69560553be5SDaniel Jasper return Penalty; 69660553be5SDaniel Jasper } 69760553be5SDaniel Jasper 69860553be5SDaniel Jasper void ContinuationIndenter::moveStatePastFakeLParens(LineState &State, 69960553be5SDaniel Jasper bool Newline) { 70060553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 70160553be5SDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 70260553be5SDaniel Jasper 703de0328aeSDaniel Jasper // Don't add extra indentation for the first fake parenthesis after 7040db806b7SDinesh Dwivedi // 'return', assignments or opening <({[. The indentation for these cases 705de0328aeSDaniel Jasper // is special cased. 706de0328aeSDaniel Jasper bool SkipFirstExtraIndent = 707eabede6dSDaniel Jasper (Previous && (Previous->opensScope() || Previous->is(tok::kw_return) || 708f48b5abcSDaniel Jasper Previous->getPrecedence() == prec::Assignment || 709f48b5abcSDaniel Jasper Previous->Type == TT_ObjCMethodExpr)); 710de0328aeSDaniel Jasper for (SmallVectorImpl<prec::Level>::const_reverse_iterator 711de0328aeSDaniel Jasper I = Current.FakeLParens.rbegin(), 712de0328aeSDaniel Jasper E = Current.FakeLParens.rend(); 713de0328aeSDaniel Jasper I != E; ++I) { 714de0328aeSDaniel Jasper ParenState NewParenState = State.Stack.back(); 715de0328aeSDaniel Jasper NewParenState.ContainsLineBreak = false; 716eabede6dSDaniel Jasper 717eabede6dSDaniel Jasper // Indent from 'LastSpace' unless this the fake parentheses encapsulating a 718eabede6dSDaniel Jasper // builder type call after 'return'. If such a call is line-wrapped, we 719eabede6dSDaniel Jasper // commonly just want to indent from the start of the line. 7204281c5aeSDaniel Jasper if (!Current.isTrailingComment() && 7214281c5aeSDaniel Jasper (!Previous || Previous->isNot(tok::kw_return) || *I > 0)) 722de0328aeSDaniel Jasper NewParenState.Indent = 723de0328aeSDaniel Jasper std::max(std::max(State.Column, NewParenState.Indent), 724de0328aeSDaniel Jasper State.Stack.back().LastSpace); 725eabede6dSDaniel Jasper 7265c33265cSDaniel Jasper // Don't allow the RHS of an operator to be split over multiple lines unless 7275c33265cSDaniel Jasper // there is a line-break right after the operator. 7285c33265cSDaniel Jasper // Exclude relational operators, as there, it is always more desirable to 7295c33265cSDaniel Jasper // have the LHS 'left' of the RHS. 730c0d606a5SDaniel Jasper if (Previous && Previous->getPrecedence() > prec::Assignment && 731c0d606a5SDaniel Jasper (Previous->Type == TT_BinaryOperator || 732c0d606a5SDaniel Jasper Previous->Type == TT_ConditionalExpr) && 733c0d606a5SDaniel Jasper Previous->getPrecedence() != prec::Relational) { 734c0d606a5SDaniel Jasper bool BreakBeforeOperator = Previous->is(tok::lessless) || 735c0d606a5SDaniel Jasper (Previous->Type == TT_BinaryOperator && 736c0d606a5SDaniel Jasper Style.BreakBeforeBinaryOperators) || 737c0d606a5SDaniel Jasper (Previous->Type == TT_ConditionalExpr && 738c0d606a5SDaniel Jasper Style.BreakBeforeTernaryOperators); 739c0d606a5SDaniel Jasper if ((!Newline && !BreakBeforeOperator) || 740c0d606a5SDaniel Jasper (!State.Stack.back().LastOperatorWrapped && BreakBeforeOperator)) 7415c33265cSDaniel Jasper NewParenState.NoLineBreak = true; 742c0d606a5SDaniel Jasper } 7435c33265cSDaniel Jasper 7449fe0e8daSDaniel Jasper // Do not indent relative to the fake parentheses inserted for "." or "->". 7459fe0e8daSDaniel Jasper // This is a special case to make the following to statements consistent: 7469fe0e8daSDaniel Jasper // OuterFunction(InnerFunctionCall( // break 7479fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 7489fe0e8daSDaniel Jasper // OuterFunction(SomeObject.InnerFunctionCall( // break 7499fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 7509fe0e8daSDaniel Jasper if (*I > prec::Unknown) 7519fe0e8daSDaniel Jasper NewParenState.LastSpace = std::max(NewParenState.LastSpace, State.Column); 75296964359SDaniel Jasper NewParenState.StartOfFunctionCall = State.Column; 753de0328aeSDaniel Jasper 754de0328aeSDaniel Jasper // Always indent conditional expressions. Never indent expression where 755de0328aeSDaniel Jasper // the 'operator' is ',', ';' or an assignment (i.e. *I <= 756de0328aeSDaniel Jasper // prec::Assignment) as those have different indentation rules. Indent 757de0328aeSDaniel Jasper // other expression, unless the indentation needs to be skipped. 758de0328aeSDaniel Jasper if (*I == prec::Conditional || 759de0328aeSDaniel Jasper (!SkipFirstExtraIndent && *I > prec::Assignment && 7604281c5aeSDaniel Jasper !Current.isTrailingComment() && !Style.BreakBeforeBinaryOperators)) 7616633ab8aSDaniel Jasper NewParenState.Indent += Style.ContinuationIndentWidth; 7621db6c386SDaniel Jasper if ((Previous && !Previous->opensScope()) || *I > prec::Comma) 763de0328aeSDaniel Jasper NewParenState.BreakBeforeParameter = false; 764de0328aeSDaniel Jasper State.Stack.push_back(NewParenState); 765de0328aeSDaniel Jasper SkipFirstExtraIndent = false; 766de0328aeSDaniel Jasper } 76760553be5SDaniel Jasper } 768de0328aeSDaniel Jasper 769335ff266SDaniel Jasper // Remove the fake r_parens after 'Tok'. 770335ff266SDaniel Jasper static void consumeRParens(LineState& State, const FormatToken &Tok) { 771335ff266SDaniel Jasper for (unsigned i = 0, e = Tok.FakeRParens; i != e; ++i) { 77260553be5SDaniel Jasper unsigned VariablePos = State.Stack.back().VariablePos; 773819788daSManuel Klimek assert(State.Stack.size() > 1); 774819788daSManuel Klimek if (State.Stack.size() == 1) { 775819788daSManuel Klimek // Do not pop the last element. 776819788daSManuel Klimek break; 777819788daSManuel Klimek } 7789fe0e8daSDaniel Jasper State.Stack.pop_back(); 77960553be5SDaniel Jasper State.Stack.back().VariablePos = VariablePos; 780819788daSManuel Klimek } 78160553be5SDaniel Jasper } 782335ff266SDaniel Jasper 783335ff266SDaniel Jasper // Returns whether 'Tok' opens or closes a scope requiring special handling 784335ff266SDaniel Jasper // of the subsequent fake r_parens. 785335ff266SDaniel Jasper // 786335ff266SDaniel Jasper // For example, if this is an l_brace starting a nested block, we pretend (wrt. 787335ff266SDaniel Jasper // to indentation) that we already consumed the corresponding r_brace. Thus, we 788335ff266SDaniel Jasper // remove all ParenStates caused by fake parentheses that end at the r_brace. 789335ff266SDaniel Jasper // The net effect of this is that we don't indent relative to the l_brace, if 790335ff266SDaniel Jasper // the nested block is the last parameter of a function. This formats: 791335ff266SDaniel Jasper // 792335ff266SDaniel Jasper // SomeFunction(a, [] { 793335ff266SDaniel Jasper // f(); // break 794335ff266SDaniel Jasper // }); 795335ff266SDaniel Jasper // 796335ff266SDaniel Jasper // instead of: 797335ff266SDaniel Jasper // SomeFunction(a, [] { 798335ff266SDaniel Jasper // f(); // break 799335ff266SDaniel Jasper // }); 800114a2bc9SDaniel Jasper static bool fakeRParenSpecialCase(const LineState &State) { 801114a2bc9SDaniel Jasper const FormatToken &Tok = *State.NextToken; 802335ff266SDaniel Jasper if (!Tok.MatchingParen) 803335ff266SDaniel Jasper return false; 804335ff266SDaniel Jasper const FormatToken *Left = &Tok; 805335ff266SDaniel Jasper if (Tok.isOneOf(tok::r_brace, tok::r_square)) 806335ff266SDaniel Jasper Left = Tok.MatchingParen; 807114a2bc9SDaniel Jasper return !State.Stack.back().HasMultipleNestedBlocks && 808114a2bc9SDaniel Jasper Left->isOneOf(tok::l_brace, tok::l_square) && 809335ff266SDaniel Jasper (Left->BlockKind == BK_Block || 810335ff266SDaniel Jasper Left->Type == TT_ArrayInitializerLSquare || 811335ff266SDaniel Jasper Left->Type == TT_DictLiteral); 812335ff266SDaniel Jasper } 813335ff266SDaniel Jasper 814335ff266SDaniel Jasper void ContinuationIndenter::moveStatePastFakeRParens(LineState &State) { 815335ff266SDaniel Jasper // Don't remove FakeRParens attached to r_braces that surround nested blocks 816335ff266SDaniel Jasper // as they will have been removed early (see above). 817114a2bc9SDaniel Jasper if (fakeRParenSpecialCase(State)) 818335ff266SDaniel Jasper return; 819335ff266SDaniel Jasper 820335ff266SDaniel Jasper consumeRParens(State, *State.NextToken); 82160553be5SDaniel Jasper } 82260553be5SDaniel Jasper 82360553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeOpener(LineState &State, 82460553be5SDaniel Jasper bool Newline) { 82560553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 82660553be5SDaniel Jasper if (!Current.opensScope()) 82760553be5SDaniel Jasper return; 82860553be5SDaniel Jasper 82960553be5SDaniel Jasper if (Current.MatchingParen && Current.BlockKind == BK_Block) { 83060553be5SDaniel Jasper moveStateToNewBlock(State); 83160553be5SDaniel Jasper return; 83260553be5SDaniel Jasper } 83360553be5SDaniel Jasper 83460553be5SDaniel Jasper unsigned NewIndent; 83560553be5SDaniel Jasper unsigned NewIndentLevel = State.Stack.back().IndentLevel; 83660553be5SDaniel Jasper bool AvoidBinPacking; 83760553be5SDaniel Jasper bool BreakBeforeParameter = false; 83860553be5SDaniel Jasper if (Current.is(tok::l_brace) || Current.Type == TT_ArrayInitializerLSquare) { 839114a2bc9SDaniel Jasper if (fakeRParenSpecialCase(State)) 840335ff266SDaniel Jasper consumeRParens(State, *Current.MatchingParen); 841335ff266SDaniel Jasper 842e2e0387fSAlexander Kornienko NewIndent = State.Stack.back().LastSpace; 843b8f61682SDaniel Jasper if (Current.opensBlockTypeList(Style)) { 844e2e0387fSAlexander Kornienko NewIndent += Style.IndentWidth; 8455a611397SDaniel Jasper NewIndent = std::min(State.Column + 2, NewIndent); 846e2e0387fSAlexander Kornienko ++NewIndentLevel; 847b8f61682SDaniel Jasper } else { 848b8f61682SDaniel Jasper NewIndent += Style.ContinuationIndentWidth; 8495a611397SDaniel Jasper NewIndent = std::min(State.Column + 1, NewIndent); 850e2e0387fSAlexander Kornienko } 851de0328aeSDaniel Jasper const FormatToken *NextNoComment = Current.getNextNonComment(); 85260553be5SDaniel Jasper AvoidBinPacking = Current.Type == TT_ArrayInitializerLSquare || 853b596fb2bSDaniel Jasper Current.Type == TT_DictLiteral || 854883ae9d9SDaniel Jasper Style.Language == FormatStyle::LK_Proto || 855ae8e0d8dSDaniel Jasper !Style.BinPackParameters || 856015ed028SDaniel Jasper (NextNoComment && 857015ed028SDaniel Jasper NextNoComment->Type == TT_DesignatedInitializerPeriod); 858de0328aeSDaniel Jasper } else { 8596633ab8aSDaniel Jasper NewIndent = Style.ContinuationIndentWidth + 8606633ab8aSDaniel Jasper std::max(State.Stack.back().LastSpace, 8619fe0e8daSDaniel Jasper State.Stack.back().StartOfFunctionCall); 862*18210d7dSDaniel Jasper AvoidBinPacking = 863*18210d7dSDaniel Jasper (State.Line->MustBeDeclaration && !Style.BinPackParameters) || 864*18210d7dSDaniel Jasper (!State.Line->MustBeDeclaration && !Style.BinPackArguments) || 865de0328aeSDaniel Jasper (Style.ExperimentalAutoDetectBinPacking && 866de0328aeSDaniel Jasper (Current.PackingKind == PPK_OnePerLine || 867de0328aeSDaniel Jasper (!BinPackInconclusiveFunctions && 868de0328aeSDaniel Jasper Current.PackingKind == PPK_Inconclusive))); 8691db6c386SDaniel Jasper // If this '[' opens an ObjC call, determine whether all parameters fit 8701db6c386SDaniel Jasper // into one line and put one per line if they don't. 8717f0c5171SDaniel Jasper if (Current.Type == TT_ObjCMethodExpr && Style.ColumnLimit != 0 && 8721db6c386SDaniel Jasper getLengthToMatchingParen(Current) + State.Column > 8731db6c386SDaniel Jasper getColumnLimit(State)) 8741db6c386SDaniel Jasper BreakBeforeParameter = true; 875de0328aeSDaniel Jasper } 876a41aa536SDaniel Jasper bool NoLineBreak = State.Stack.back().NoLineBreak || 877a41aa536SDaniel Jasper (Current.Type == TT_TemplateOpener && 878cc3114d8SDaniel Jasper State.Stack.back().ContainsUnwrappedBuilder); 879cc3114d8SDaniel Jasper State.Stack.push_back(ParenState(NewIndent, NewIndentLevel, 880cc3114d8SDaniel Jasper State.Stack.back().LastSpace, 881cc3114d8SDaniel Jasper AvoidBinPacking, NoLineBreak)); 8821db6c386SDaniel Jasper State.Stack.back().BreakBeforeParameter = BreakBeforeParameter; 883114a2bc9SDaniel Jasper State.Stack.back().HasMultipleNestedBlocks = Current.BlockParameterCount > 1; 884de0328aeSDaniel Jasper } 885de0328aeSDaniel Jasper 88660553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) { 88760553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 88860553be5SDaniel Jasper if (!Current.closesScope()) 88960553be5SDaniel Jasper return; 89060553be5SDaniel Jasper 891de0328aeSDaniel Jasper // If we encounter a closing ), ], } or >, we can remove a level from our 892de0328aeSDaniel Jasper // stacks. 89396df37a6SDaniel Jasper if (State.Stack.size() > 1 && 89496df37a6SDaniel Jasper (Current.isOneOf(tok::r_paren, tok::r_square) || 8959fe0e8daSDaniel Jasper (Current.is(tok::r_brace) && State.NextToken != State.Line->First) || 896335ff266SDaniel Jasper State.NextToken->Type == TT_TemplateCloser)) 897de0328aeSDaniel Jasper State.Stack.pop_back(); 898335ff266SDaniel Jasper 899de0328aeSDaniel Jasper if (Current.is(tok::r_square)) { 900de0328aeSDaniel Jasper // If this ends the array subscript expr, reset the corresponding value. 901de0328aeSDaniel Jasper const FormatToken *NextNonComment = Current.getNextNonComment(); 902de0328aeSDaniel Jasper if (NextNonComment && NextNonComment->isNot(tok::l_square)) 903de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = 0; 904de0328aeSDaniel Jasper } 90560553be5SDaniel Jasper } 906de0328aeSDaniel Jasper 90760553be5SDaniel Jasper void ContinuationIndenter::moveStateToNewBlock(LineState &State) { 90860553be5SDaniel Jasper // If we have already found more than one lambda introducers on this level, we 90960553be5SDaniel Jasper // opt out of this because similarity between the lambdas is more important. 910114a2bc9SDaniel Jasper if (fakeRParenSpecialCase(State)) 911335ff266SDaniel Jasper consumeRParens(State, *State.NextToken->MatchingParen); 912de0328aeSDaniel Jasper 91360553be5SDaniel Jasper // For some reason, ObjC blocks are indented like continuations. 91460553be5SDaniel Jasper unsigned NewIndent = State.Stack.back().LastSpace + 91560553be5SDaniel Jasper (State.NextToken->Type == TT_ObjCBlockLBrace 91660553be5SDaniel Jasper ? Style.ContinuationIndentWidth 91760553be5SDaniel Jasper : Style.IndentWidth); 91860553be5SDaniel Jasper State.Stack.push_back(ParenState( 91960553be5SDaniel Jasper NewIndent, /*NewIndentLevel=*/State.Stack.back().IndentLevel + 1, 92060553be5SDaniel Jasper State.Stack.back().LastSpace, /*AvoidBinPacking=*/true, 92160553be5SDaniel Jasper State.Stack.back().NoLineBreak)); 92260553be5SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 923de0328aeSDaniel Jasper } 924de0328aeSDaniel Jasper 925917f9e04SAlexander Kornienko unsigned ContinuationIndenter::addMultilineToken(const FormatToken &Current, 926d7b837e7SAlexander Kornienko LineState &State) { 927d7b837e7SAlexander Kornienko // Break before further function parameters on all levels. 928d7b837e7SAlexander Kornienko for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 929d7b837e7SAlexander Kornienko State.Stack[i].BreakBeforeParameter = true; 930d7b837e7SAlexander Kornienko 93139856b71SAlexander Kornienko unsigned ColumnsUsed = State.Column; 932632abb9bSAlexander Kornienko // We can only affect layout of the first and the last line, so the penalty 933632abb9bSAlexander Kornienko // for all other lines is constant, and we ignore it. 934ebb43caaSAlexander Kornienko State.Column = Current.LastLineColumnWidth; 935632abb9bSAlexander Kornienko 9369fe0e8daSDaniel Jasper if (ColumnsUsed > getColumnLimit(State)) 9379fe0e8daSDaniel Jasper return Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit(State)); 938d7b837e7SAlexander Kornienko return 0; 939d7b837e7SAlexander Kornienko } 940d7b837e7SAlexander Kornienko 941b05a81deSDaniel Jasper static bool getRawStringLiteralPrefixPostfix(StringRef Text, StringRef &Prefix, 94281e3294eSAlexander Kornienko StringRef &Postfix) { 94381e3294eSAlexander Kornienko if (Text.startswith(Prefix = "R\"") || Text.startswith(Prefix = "uR\"") || 94481e3294eSAlexander Kornienko Text.startswith(Prefix = "UR\"") || Text.startswith(Prefix = "u8R\"") || 94581e3294eSAlexander Kornienko Text.startswith(Prefix = "LR\"")) { 94681e3294eSAlexander Kornienko size_t ParenPos = Text.find('('); 94781e3294eSAlexander Kornienko if (ParenPos != StringRef::npos) { 94881e3294eSAlexander Kornienko StringRef Delimiter = 94981e3294eSAlexander Kornienko Text.substr(Prefix.size(), ParenPos - Prefix.size()); 95081e3294eSAlexander Kornienko Prefix = Text.substr(0, ParenPos + 1); 95181e3294eSAlexander Kornienko Postfix = Text.substr(Text.size() - 2 - Delimiter.size()); 95281e3294eSAlexander Kornienko return Postfix.front() == ')' && Postfix.back() == '"' && 95381e3294eSAlexander Kornienko Postfix.substr(1).startswith(Delimiter); 95481e3294eSAlexander Kornienko } 95581e3294eSAlexander Kornienko } 95681e3294eSAlexander Kornienko return false; 95781e3294eSAlexander Kornienko } 95881e3294eSAlexander Kornienko 959de0328aeSDaniel Jasper unsigned ContinuationIndenter::breakProtrudingToken(const FormatToken &Current, 960de0328aeSDaniel Jasper LineState &State, 961de0328aeSDaniel Jasper bool DryRun) { 962917f9e04SAlexander Kornienko // Don't break multi-line tokens other than block comments. Instead, just 963917f9e04SAlexander Kornienko // update the state. 964917f9e04SAlexander Kornienko if (Current.Type != TT_BlockComment && Current.IsMultiline) 965917f9e04SAlexander Kornienko return addMultilineToken(Current, State); 966917f9e04SAlexander Kornienko 9679885784dSDaniel Jasper // Don't break implicit string literals. 9689885784dSDaniel Jasper if (Current.Type == TT_ImplicitStringLiteral) 9699885784dSDaniel Jasper return 0; 9709885784dSDaniel Jasper 97104b6a081SDaniel Jasper if (!Current.isStringLiteral() && !Current.is(tok::comment)) 972f93551c8SDaniel Jasper return 0; 973f93551c8SDaniel Jasper 974b8984329SAhmed Charles std::unique_ptr<BreakableToken> Token; 97539856b71SAlexander Kornienko unsigned StartColumn = State.Column - Current.ColumnWidth; 9763abbb8a4SAlexander Kornienko unsigned ColumnLimit = getColumnLimit(State); 977de0328aeSDaniel Jasper 97804b6a081SDaniel Jasper if (Current.isStringLiteral()) { 979384b40b9SAlexander Kornienko // Don't break string literals inside preprocessor directives (except for 980384b40b9SAlexander Kornienko // #define directives, as their contents are stored in separate lines and 981384b40b9SAlexander Kornienko // are not affected by this check). 982384b40b9SAlexander Kornienko // This way we avoid breaking code with line directives and unknown 983384b40b9SAlexander Kornienko // preprocessor directives that contain long string literals. 984384b40b9SAlexander Kornienko if (State.Line->Type == LT_PreprocessorDirective) 985384b40b9SAlexander Kornienko return 0; 986de0328aeSDaniel Jasper // Exempts unterminated string literals from line breaking. The user will 987de0328aeSDaniel Jasper // likely want to terminate the string before any line breaking is done. 988de0328aeSDaniel Jasper if (Current.IsUnterminatedLiteral) 989de0328aeSDaniel Jasper return 0; 990de0328aeSDaniel Jasper 99181e3294eSAlexander Kornienko StringRef Text = Current.TokenText; 99281e3294eSAlexander Kornienko StringRef Prefix; 99381e3294eSAlexander Kornienko StringRef Postfix; 994174b0125SDaniel Jasper bool IsNSStringLiteral = false; 99581e3294eSAlexander Kornienko // FIXME: Handle whitespace between '_T', '(', '"..."', and ')'. 99681e3294eSAlexander Kornienko // FIXME: Store Prefix and Suffix (or PrefixLength and SuffixLength to 99781e3294eSAlexander Kornienko // reduce the overhead) for each FormatToken, which is a string, so that we 99881e3294eSAlexander Kornienko // don't run multiple checks here on the hot path. 999174b0125SDaniel Jasper if (Text.startswith("\"") && Current.Previous && 1000174b0125SDaniel Jasper Current.Previous->is(tok::at)) { 1001174b0125SDaniel Jasper IsNSStringLiteral = true; 1002174b0125SDaniel Jasper Prefix = "@\""; 1003174b0125SDaniel Jasper } 100481e3294eSAlexander Kornienko if ((Text.endswith(Postfix = "\"") && 1005174b0125SDaniel Jasper (IsNSStringLiteral || Text.startswith(Prefix = "\"") || 1006174b0125SDaniel Jasper Text.startswith(Prefix = "u\"") || Text.startswith(Prefix = "U\"") || 1007174b0125SDaniel Jasper Text.startswith(Prefix = "u8\"") || 100881e3294eSAlexander Kornienko Text.startswith(Prefix = "L\""))) || 100981e3294eSAlexander Kornienko (Text.startswith(Prefix = "_T(\"") && Text.endswith(Postfix = "\")")) || 101081e3294eSAlexander Kornienko getRawStringLiteralPrefixPostfix(Text, Prefix, Postfix)) { 10113c3d09c8SAlexander Kornienko Token.reset(new BreakableStringLiteral( 10123c3d09c8SAlexander Kornienko Current, State.Line->Level, StartColumn, Prefix, Postfix, 10133c3d09c8SAlexander Kornienko State.Line->InPPDirective, Encoding, Style)); 101481e3294eSAlexander Kornienko } else { 101581e3294eSAlexander Kornienko return 0; 101681e3294eSAlexander Kornienko } 1017de0328aeSDaniel Jasper } else if (Current.Type == TT_BlockComment && Current.isTrailingComment()) { 1018ce9161a5SAlexander Kornienko if (CommentPragmasRegex.match(Current.TokenText.substr(2))) 1019ce9161a5SAlexander Kornienko return 0; 1020de0328aeSDaniel Jasper Token.reset(new BreakableBlockComment( 10213c3d09c8SAlexander Kornienko Current, State.Line->Level, StartColumn, Current.OriginalColumn, 10223c3d09c8SAlexander Kornienko !Current.Previous, State.Line->InPPDirective, Encoding, Style)); 1023de0328aeSDaniel Jasper } else if (Current.Type == TT_LineComment && 10242145bc02SCraig Topper (Current.Previous == nullptr || 1025de0328aeSDaniel Jasper Current.Previous->Type != TT_ImplicitStringLiteral)) { 1026ce9161a5SAlexander Kornienko if (CommentPragmasRegex.match(Current.TokenText.substr(2))) 1027ce9161a5SAlexander Kornienko return 0; 10283c3d09c8SAlexander Kornienko Token.reset(new BreakableLineComment(Current, State.Line->Level, 10293abbb8a4SAlexander Kornienko StartColumn, /*InPPDirective=*/false, 10303c3d09c8SAlexander Kornienko Encoding, Style)); 10313abbb8a4SAlexander Kornienko // We don't insert backslashes when breaking line comments. 10323abbb8a4SAlexander Kornienko ColumnLimit = Style.ColumnLimit; 1033de0328aeSDaniel Jasper } else { 1034de0328aeSDaniel Jasper return 0; 1035de0328aeSDaniel Jasper } 10363abbb8a4SAlexander Kornienko if (Current.UnbreakableTailLength >= ColumnLimit) 1037de0328aeSDaniel Jasper return 0; 1038de0328aeSDaniel Jasper 10393abbb8a4SAlexander Kornienko unsigned RemainingSpace = ColumnLimit - Current.UnbreakableTailLength; 1040de0328aeSDaniel Jasper bool BreakInserted = false; 1041de0328aeSDaniel Jasper unsigned Penalty = 0; 1042de0328aeSDaniel Jasper unsigned RemainingTokenColumns = 0; 1043de0328aeSDaniel Jasper for (unsigned LineIndex = 0, EndIndex = Token->getLineCount(); 1044de0328aeSDaniel Jasper LineIndex != EndIndex; ++LineIndex) { 1045de0328aeSDaniel Jasper if (!DryRun) 1046de0328aeSDaniel Jasper Token->replaceWhitespaceBefore(LineIndex, Whitespaces); 1047de0328aeSDaniel Jasper unsigned TailOffset = 0; 1048de0328aeSDaniel Jasper RemainingTokenColumns = 1049de0328aeSDaniel Jasper Token->getLineLengthAfterSplit(LineIndex, TailOffset, StringRef::npos); 1050de0328aeSDaniel Jasper while (RemainingTokenColumns > RemainingSpace) { 1051de0328aeSDaniel Jasper BreakableToken::Split Split = 10523abbb8a4SAlexander Kornienko Token->getSplit(LineIndex, TailOffset, ColumnLimit); 1053de0328aeSDaniel Jasper if (Split.first == StringRef::npos) { 1054de0328aeSDaniel Jasper // The last line's penalty is handled in addNextStateToQueue(). 1055de0328aeSDaniel Jasper if (LineIndex < EndIndex - 1) 1056de0328aeSDaniel Jasper Penalty += Style.PenaltyExcessCharacter * 1057de0328aeSDaniel Jasper (RemainingTokenColumns - RemainingSpace); 1058de0328aeSDaniel Jasper break; 1059de0328aeSDaniel Jasper } 1060de0328aeSDaniel Jasper assert(Split.first != 0); 1061de0328aeSDaniel Jasper unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit( 1062de0328aeSDaniel Jasper LineIndex, TailOffset + Split.first + Split.second, StringRef::npos); 1063875395f9SAlexander Kornienko 1064875395f9SAlexander Kornienko // We can remove extra whitespace instead of breaking the line. 1065875395f9SAlexander Kornienko if (RemainingTokenColumns + 1 - Split.second <= RemainingSpace) { 1066875395f9SAlexander Kornienko RemainingTokenColumns = 0; 1067875395f9SAlexander Kornienko if (!DryRun) 1068875395f9SAlexander Kornienko Token->replaceWhitespace(LineIndex, TailOffset, Split, Whitespaces); 1069875395f9SAlexander Kornienko break; 1070875395f9SAlexander Kornienko } 1071875395f9SAlexander Kornienko 107264a42b8dSAlexander Kornienko // When breaking before a tab character, it may be moved by a few columns, 107364a42b8dSAlexander Kornienko // but will still be expanded to the next tab stop, so we don't save any 107464a42b8dSAlexander Kornienko // columns. 107564a42b8dSAlexander Kornienko if (NewRemainingTokenColumns == RemainingTokenColumns) 107664a42b8dSAlexander Kornienko break; 107764a42b8dSAlexander Kornienko 1078de0328aeSDaniel Jasper assert(NewRemainingTokenColumns < RemainingTokenColumns); 1079de0328aeSDaniel Jasper if (!DryRun) 1080de0328aeSDaniel Jasper Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces); 10812739af3bSDaniel Jasper Penalty += Current.SplitPenalty; 1082de0328aeSDaniel Jasper unsigned ColumnsUsed = 1083de0328aeSDaniel Jasper Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first); 10843abbb8a4SAlexander Kornienko if (ColumnsUsed > ColumnLimit) { 10853abbb8a4SAlexander Kornienko Penalty += Style.PenaltyExcessCharacter * (ColumnsUsed - ColumnLimit); 1086de0328aeSDaniel Jasper } 1087de0328aeSDaniel Jasper TailOffset += Split.first + Split.second; 1088de0328aeSDaniel Jasper RemainingTokenColumns = NewRemainingTokenColumns; 1089de0328aeSDaniel Jasper BreakInserted = true; 1090de0328aeSDaniel Jasper } 1091de0328aeSDaniel Jasper } 1092de0328aeSDaniel Jasper 1093de0328aeSDaniel Jasper State.Column = RemainingTokenColumns; 1094de0328aeSDaniel Jasper 1095de0328aeSDaniel Jasper if (BreakInserted) { 1096de0328aeSDaniel Jasper // If we break the token inside a parameter list, we need to break before 1097de0328aeSDaniel Jasper // the next parameter on all levels, so that the next parameter is clearly 1098de0328aeSDaniel Jasper // visible. Line comments already introduce a break. 1099de0328aeSDaniel Jasper if (Current.Type != TT_LineComment) { 1100de0328aeSDaniel Jasper for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 1101de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 1102de0328aeSDaniel Jasper } 1103de0328aeSDaniel Jasper 110404b6a081SDaniel Jasper Penalty += Current.isStringLiteral() ? Style.PenaltyBreakString 11052739af3bSDaniel Jasper : Style.PenaltyBreakComment; 11062739af3bSDaniel Jasper 1107de0328aeSDaniel Jasper State.Stack.back().LastSpace = StartColumn; 1108de0328aeSDaniel Jasper } 1109de0328aeSDaniel Jasper return Penalty; 1110de0328aeSDaniel Jasper } 1111de0328aeSDaniel Jasper 11129fe0e8daSDaniel Jasper unsigned ContinuationIndenter::getColumnLimit(const LineState &State) const { 1113de0328aeSDaniel Jasper // In preprocessor directives reserve two chars for trailing " \" 11149fe0e8daSDaniel Jasper return Style.ColumnLimit - (State.Line->InPPDirective ? 2 : 0); 1115de0328aeSDaniel Jasper } 1116de0328aeSDaniel Jasper 1117c39b56feSDaniel Jasper bool ContinuationIndenter::nextIsMultilineString(const LineState &State) { 1118f438cb76SDaniel Jasper const FormatToken &Current = *State.NextToken; 11199509f188SDaniel Jasper if (!Current.isStringLiteral() || Current.Type == TT_ImplicitStringLiteral) 1120f438cb76SDaniel Jasper return false; 1121d7b837e7SAlexander Kornienko // We never consider raw string literals "multiline" for the purpose of 1122c39b56feSDaniel Jasper // AlwaysBreakBeforeMultilineStrings implementation as they are special-cased 1123c39b56feSDaniel Jasper // (see TokenAnnotator::mustBreakBefore(). 1124d7b837e7SAlexander Kornienko if (Current.TokenText.startswith("R\"")) 1125d7b837e7SAlexander Kornienko return false; 112639856b71SAlexander Kornienko if (Current.IsMultiline) 1127d7b837e7SAlexander Kornienko return true; 1128f438cb76SDaniel Jasper if (Current.getNextNonComment() && 112904b6a081SDaniel Jasper Current.getNextNonComment()->isStringLiteral()) 1130f438cb76SDaniel Jasper return true; // Implicit concatenation. 113139856b71SAlexander Kornienko if (State.Column + Current.ColumnWidth + Current.UnbreakableTailLength > 1132f438cb76SDaniel Jasper Style.ColumnLimit) 1133f438cb76SDaniel Jasper return true; // String will be split. 1134d7b837e7SAlexander Kornienko return false; 1135f438cb76SDaniel Jasper } 1136f438cb76SDaniel Jasper 1137de0328aeSDaniel Jasper } // namespace format 1138de0328aeSDaniel Jasper } // namespace clang 1139