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; 51a98b7b01SDaniel Jasper if (Current.is(TT_CtorInitializerComma) && 52ec01cd6eSDaniel Jasper Style.BreakConstructorInitializersBeforeComma) 53ec01cd6eSDaniel Jasper return true; 54ec01cd6eSDaniel Jasper return Previous.is(tok::comma) && !Current.isTrailingComment() && 55a98b7b01SDaniel Jasper (Previous.isNot(TT_CtorInitializerComma) || 56ec01cd6eSDaniel Jasper !Style.BreakConstructorInitializersBeforeComma); 57ec01cd6eSDaniel Jasper } 58ec01cd6eSDaniel Jasper 59de0328aeSDaniel Jasper ContinuationIndenter::ContinuationIndenter(const FormatStyle &Style, 60d0ec0d62SDaniel Jasper const AdditionalKeywords &Keywords, 61de0328aeSDaniel Jasper SourceManager &SourceMgr, 62de0328aeSDaniel Jasper WhitespaceManager &Whitespaces, 63de0328aeSDaniel Jasper encoding::Encoding Encoding, 64de0328aeSDaniel Jasper bool BinPackInconclusiveFunctions) 65d0ec0d62SDaniel Jasper : Style(Style), Keywords(Keywords), SourceMgr(SourceMgr), 66d0ec0d62SDaniel Jasper Whitespaces(Whitespaces), Encoding(Encoding), 67ce9161a5SAlexander Kornienko BinPackInconclusiveFunctions(BinPackInconclusiveFunctions), 68ce9161a5SAlexander Kornienko CommentPragmasRegex(Style.CommentPragmas) {} 69de0328aeSDaniel Jasper 709fe0e8daSDaniel Jasper LineState ContinuationIndenter::getInitialState(unsigned FirstIndent, 711c5d9df8SDaniel Jasper const AnnotatedLine *Line, 721c5d9df8SDaniel Jasper bool DryRun) { 73de0328aeSDaniel Jasper LineState State; 749fe0e8daSDaniel Jasper State.FirstIndent = FirstIndent; 75de0328aeSDaniel Jasper State.Column = FirstIndent; 769fe0e8daSDaniel Jasper State.Line = Line; 779fe0e8daSDaniel Jasper State.NextToken = Line->First; 78e2e0387fSAlexander Kornienko State.Stack.push_back(ParenState(FirstIndent, Line->Level, FirstIndent, 79de0328aeSDaniel Jasper /*AvoidBinPacking=*/false, 80de0328aeSDaniel Jasper /*NoLineBreak=*/false)); 81de0328aeSDaniel Jasper State.LineContainsContinuedForLoopSection = false; 82de0328aeSDaniel Jasper State.StartOfStringLiteral = 0; 8305cd5868SDaniel Jasper State.StartOfLineLevel = 0; 8405cd5868SDaniel Jasper State.LowestLevelOnLine = 0; 85de0328aeSDaniel Jasper State.IgnoreStackForComparison = false; 86de0328aeSDaniel Jasper 87de0328aeSDaniel Jasper // The first token has already been indented and thus consumed. 881c5d9df8SDaniel Jasper moveStateToNextToken(State, DryRun, /*Newline=*/false); 89de0328aeSDaniel Jasper return State; 90de0328aeSDaniel Jasper } 91de0328aeSDaniel Jasper 92de0328aeSDaniel Jasper bool ContinuationIndenter::canBreak(const LineState &State) { 93de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 94de0328aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 95de0328aeSDaniel Jasper assert(&Previous == Current.Previous); 96*beb03938SNico Weber if (!Current.CanBreakBefore && 97*beb03938SNico Weber !(State.Stack.back().BreakBeforeClosingBrace && 981db6c386SDaniel Jasper Current.closesBlockTypeList(Style))) 99de0328aeSDaniel Jasper return false; 100de0328aeSDaniel Jasper // The opening "{" of a braced list has to be on the same line as the first 101de0328aeSDaniel Jasper // element if it is nested in another braced init list or function call. 102de0328aeSDaniel Jasper if (!Current.MustBreakBefore && Previous.is(tok::l_brace) && 103a98b7b01SDaniel Jasper Previous.isNot(TT_DictLiteral) && Previous.BlockKind == BK_BracedInit && 104b05a81deSDaniel Jasper Previous.Previous && 105de0328aeSDaniel Jasper Previous.Previous->isOneOf(tok::l_brace, tok::l_paren, tok::comma)) 106de0328aeSDaniel Jasper return false; 107de0328aeSDaniel Jasper // This prevents breaks like: 108de0328aeSDaniel Jasper // ... 109de0328aeSDaniel Jasper // SomeParameter, OtherParameter).DoSomething( 110de0328aeSDaniel Jasper // ... 111de0328aeSDaniel Jasper // As they hide "DoSomething" and are generally bad for readability. 1128f59ae53SDaniel Jasper if (Previous.opensScope() && Previous.isNot(tok::l_brace) && 113fcfac10cSDaniel Jasper State.LowestLevelOnLine < State.StartOfLineLevel && 114fcfac10cSDaniel Jasper State.LowestLevelOnLine < Current.NestingLevel) 115de0328aeSDaniel Jasper return false; 1164c6e0059SDaniel Jasper if (Current.isMemberAccess() && State.Stack.back().ContainsUnwrappedBuilder) 1174c6e0059SDaniel Jasper return false; 118114a2bc9SDaniel Jasper 119114a2bc9SDaniel Jasper // Don't create a 'hanging' indent if there are multiple blocks in a single 120114a2bc9SDaniel Jasper // statement. 1214b444495SDaniel Jasper if (Previous.is(tok::l_brace) && State.Stack.size() > 1 && 1224b444495SDaniel Jasper State.Stack[State.Stack.size() - 2].NestedBlockInlined && 123114a2bc9SDaniel Jasper State.Stack[State.Stack.size() - 2].HasMultipleNestedBlocks) 124114a2bc9SDaniel Jasper return false; 125114a2bc9SDaniel Jasper 126e068ac77SDaniel Jasper // Don't break after very short return types (e.g. "void") as that is often 127e068ac77SDaniel Jasper // unexpected. 128a98b7b01SDaniel Jasper if (Current.is(TT_FunctionDeclarationName) && 129e068ac77SDaniel Jasper !Style.AlwaysBreakAfterDefinitionReturnType && State.Column < 6) 130e068ac77SDaniel Jasper return false; 131e068ac77SDaniel Jasper 132de0328aeSDaniel Jasper return !State.Stack.back().NoLineBreak; 133de0328aeSDaniel Jasper } 134de0328aeSDaniel Jasper 135de0328aeSDaniel Jasper bool ContinuationIndenter::mustBreak(const LineState &State) { 136de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 137de0328aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 138a98b7b01SDaniel Jasper if (Current.MustBreakBefore || Current.is(TT_InlineASMColon)) 139de0328aeSDaniel Jasper return true; 1401db6c386SDaniel Jasper if (State.Stack.back().BreakBeforeClosingBrace && 1411db6c386SDaniel Jasper Current.closesBlockTypeList(Style)) 142de0328aeSDaniel Jasper return true; 143de0328aeSDaniel Jasper if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection) 144de0328aeSDaniel Jasper return true; 145ec01cd6eSDaniel Jasper if ((startsNextParameter(Current, Style) || Previous.is(tok::semi) || 146165b29e2SDaniel Jasper (Style.BreakBeforeTernaryOperators && 147a98b7b01SDaniel Jasper (Current.is(tok::question) || 148a98b7b01SDaniel Jasper (Current.is(TT_ConditionalExpr) && Previous.isNot(tok::question)))) || 149165b29e2SDaniel Jasper (!Style.BreakBeforeTernaryOperators && 150a98b7b01SDaniel Jasper (Previous.is(tok::question) || Previous.is(TT_ConditionalExpr)))) && 151de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter && !Current.isTrailingComment() && 152de0328aeSDaniel Jasper !Current.isOneOf(tok::r_paren, tok::r_brace)) 153de0328aeSDaniel Jasper return true; 154de0328aeSDaniel Jasper if (Style.AlwaysBreakBeforeMultilineStrings && 155f438cb76SDaniel Jasper State.Column > State.Stack.back().Indent && // Breaking saves columns. 15627943058SDaniel Jasper !Previous.isOneOf(tok::kw_return, tok::lessless, tok::at) && 157a98b7b01SDaniel Jasper !Previous.isOneOf(TT_InlineASMColon, TT_ConditionalExpr) && 158a98b7b01SDaniel Jasper nextIsMultilineString(State)) 159de0328aeSDaniel Jasper return true; 160a98b7b01SDaniel Jasper if (((Previous.is(TT_DictLiteral) && Previous.is(tok::l_brace)) || 161a98b7b01SDaniel Jasper Previous.is(TT_ArrayInitializerLSquare)) && 162db8804b3SDaniel Jasper Style.ColumnLimit > 0 && 163d489dd34SDaniel Jasper getLengthToMatchingParen(Previous) + State.Column > getColumnLimit(State)) 164d489dd34SDaniel Jasper return true; 165a98b7b01SDaniel Jasper if (Current.is(TT_CtorInitializerColon) && 166d74cf403SDaniel Jasper ((Style.AllowShortFunctionsOnASingleLine != FormatStyle::SFS_All) || 1675d2587daSDaniel Jasper Style.BreakConstructorInitializersBeforeComma || Style.ColumnLimit != 0)) 1685d2587daSDaniel Jasper return true; 169de0328aeSDaniel Jasper 1705d2587daSDaniel Jasper if (State.Column < getNewLineColumn(State)) 1715d2587daSDaniel Jasper return false; 1728c6e9ef6SDaniel Jasper if (Style.BreakBeforeBinaryOperators == FormatStyle::BOS_None) { 173de0328aeSDaniel Jasper // If we need to break somewhere inside the LHS of a binary expression, we 174de0328aeSDaniel Jasper // should also break after the operator. Otherwise, the formatting would 175de0328aeSDaniel Jasper // hide the operator precedence, e.g. in: 176de0328aeSDaniel Jasper // if (aaaaaaaaaaaaaa == 177de0328aeSDaniel Jasper // bbbbbbbbbbbbbb && c) {.. 178de0328aeSDaniel Jasper // For comparisons, we only apply this rule, if the LHS is a binary 179de0328aeSDaniel Jasper // expression itself as otherwise, the line breaks seem superfluous. 180de0328aeSDaniel Jasper // We need special cases for ">>" which we have split into two ">" while 181de0328aeSDaniel Jasper // lexing in order to make template parsing easier. 182de0328aeSDaniel Jasper bool IsComparison = (Previous.getPrecedence() == prec::Relational || 183de0328aeSDaniel Jasper Previous.getPrecedence() == prec::Equality) && 184de0328aeSDaniel Jasper Previous.Previous && 185a98b7b01SDaniel Jasper Previous.Previous->isNot(TT_BinaryOperator); // For >>. 186de0328aeSDaniel Jasper bool LHSIsBinaryExpr = 187562ecd44SDaniel Jasper Previous.Previous && Previous.Previous->EndsBinaryExpression; 188a98b7b01SDaniel Jasper if (Previous.is(TT_BinaryOperator) && (!IsComparison || LHSIsBinaryExpr) && 189a98b7b01SDaniel Jasper Current.isNot(TT_BinaryOperator) && // For >>. 190c0d606a5SDaniel Jasper !Current.isTrailingComment() && !Previous.is(tok::lessless) && 191de0328aeSDaniel Jasper Previous.getPrecedence() != prec::Assignment && 192de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter) 193de0328aeSDaniel Jasper return true; 1943219e43cSDaniel Jasper } else { 1953219e43cSDaniel Jasper if (Current.is(TT_BinaryOperator) && Previous.EndsBinaryExpression && 1963219e43cSDaniel Jasper State.Stack.back().BreakBeforeParameter) 1973219e43cSDaniel Jasper return true; 198de0328aeSDaniel Jasper } 199de0328aeSDaniel Jasper 200de0328aeSDaniel Jasper // Same as above, but for the first "<<" operator. 201a98b7b01SDaniel Jasper if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator) && 20286b2dfdcSAlexander Kornienko State.Stack.back().BreakBeforeParameter && 203de0328aeSDaniel Jasper State.Stack.back().FirstLessLess == 0) 204de0328aeSDaniel Jasper return true; 205de0328aeSDaniel Jasper 206a98b7b01SDaniel Jasper if (Current.is(TT_SelectorName) && State.Stack.back().ObjCSelectorNameFound && 207de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter) 208de0328aeSDaniel Jasper return true; 209211e1329SDaniel Jasper if (Current.NestingLevel == 0 && !Current.isTrailingComment()) { 210211e1329SDaniel Jasper if (Previous.ClosesTemplateDeclaration) 211de0328aeSDaniel Jasper return true; 212*beb03938SNico Weber if (Previous.is(TT_LeadingJavaAnnotation) && Current.isNot(tok::l_paren) && 213*beb03938SNico Weber Current.isNot(TT_LeadingJavaAnnotation)) 214211e1329SDaniel Jasper return true; 215211e1329SDaniel Jasper } 216de0328aeSDaniel Jasper 2174355e7f0SDaniel Jasper // If the return type spans multiple lines, wrap before the function name. 218a98b7b01SDaniel Jasper if (Current.isOneOf(TT_FunctionDeclarationName, tok::kw_operator) && 2194355e7f0SDaniel Jasper State.Stack.back().BreakBeforeParameter) 220de0328aeSDaniel Jasper return true; 2214355e7f0SDaniel Jasper 2224c6e0059SDaniel Jasper if (startsSegmentOfBuilderTypeCall(Current) && 223f8151e9bSDaniel Jasper (State.Stack.back().CallContinuation != 0 || 224f8151e9bSDaniel Jasper (State.Stack.back().BreakBeforeParameter && 225f8151e9bSDaniel Jasper State.Stack.back().ContainsUnwrappedBuilder))) 2264c6e0059SDaniel Jasper return true; 2279697281eSDaniel Jasper 2289697281eSDaniel Jasper // The following could be precomputed as they do not depend on the state. 2299697281eSDaniel Jasper // However, as they should take effect only if the UnwrappedLine does not fit 2309697281eSDaniel Jasper // into the ColumnLimit, they are checked here in the ContinuationIndenter. 23135995679SDaniel Jasper if (Style.ColumnLimit != 0 && Previous.BlockKind == BK_Block && 23235995679SDaniel Jasper Previous.is(tok::l_brace) && !Current.isOneOf(tok::r_brace, tok::comment)) 2339697281eSDaniel Jasper return true; 2349697281eSDaniel Jasper 235de0328aeSDaniel Jasper return false; 236de0328aeSDaniel Jasper } 237de0328aeSDaniel Jasper 238de0328aeSDaniel Jasper unsigned ContinuationIndenter::addTokenToState(LineState &State, bool Newline, 2398de9ed05SDaniel Jasper bool DryRun, 2408de9ed05SDaniel Jasper unsigned ExtraSpaces) { 241de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 242de0328aeSDaniel Jasper 243819788daSManuel Klimek assert(!State.Stack.empty()); 244a98b7b01SDaniel Jasper if ((Current.is(TT_ImplicitStringLiteral) && 2452145bc02SCraig Topper (Current.Previous->Tok.getIdentifierInfo() == nullptr || 2469885784dSDaniel Jasper Current.Previous->Tok.getIdentifierInfo()->getPPKeywordID() == 2479885784dSDaniel Jasper tok::pp_not_keyword))) { 248de0328aeSDaniel Jasper // FIXME: Is this correct? 249de0328aeSDaniel Jasper int WhitespaceLength = SourceMgr.getSpellingColumnNumber( 250de0328aeSDaniel Jasper State.NextToken->WhitespaceRange.getEnd()) - 251de0328aeSDaniel Jasper SourceMgr.getSpellingColumnNumber( 252de0328aeSDaniel Jasper State.NextToken->WhitespaceRange.getBegin()); 253da353cd5SDaniel Jasper State.Column += WhitespaceLength; 254240dfda3SDaniel Jasper moveStateToNextToken(State, DryRun, /*Newline=*/false); 255de0328aeSDaniel Jasper return 0; 256de0328aeSDaniel Jasper } 257de0328aeSDaniel Jasper 2581f80396dSAlexander Kornienko unsigned Penalty = 0; 2591f80396dSAlexander Kornienko if (Newline) 2601f80396dSAlexander Kornienko Penalty = addTokenOnNewLine(State, DryRun); 2611f80396dSAlexander Kornienko else 26248437ce5SDaniel Jasper addTokenOnCurrentLine(State, DryRun, ExtraSpaces); 2631f80396dSAlexander Kornienko 2641f80396dSAlexander Kornienko return moveStateToNextToken(State, DryRun, Newline) + Penalty; 2651f80396dSAlexander Kornienko } 2661f80396dSAlexander Kornienko 26748437ce5SDaniel Jasper void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun, 2681f80396dSAlexander Kornienko unsigned ExtraSpaces) { 26971814b44SManuel Klimek FormatToken &Current = *State.NextToken; 2701f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 2711f80396dSAlexander Kornienko if (Current.is(tok::equal) && 27205cd5868SDaniel Jasper (State.Line->First->is(tok::kw_for) || Current.NestingLevel == 0) && 2731f80396dSAlexander Kornienko State.Stack.back().VariablePos == 0) { 2741f80396dSAlexander Kornienko State.Stack.back().VariablePos = State.Column; 2751f80396dSAlexander Kornienko // Move over * and & if they are bound to the variable name. 2761f80396dSAlexander Kornienko const FormatToken *Tok = &Previous; 2771f80396dSAlexander Kornienko while (Tok && State.Stack.back().VariablePos >= Tok->ColumnWidth) { 2781f80396dSAlexander Kornienko State.Stack.back().VariablePos -= Tok->ColumnWidth; 2791f80396dSAlexander Kornienko if (Tok->SpacesRequiredBefore != 0) 2801f80396dSAlexander Kornienko break; 2811f80396dSAlexander Kornienko Tok = Tok->Previous; 2821f80396dSAlexander Kornienko } 2831f80396dSAlexander Kornienko if (Previous.PartOfMultiVariableDeclStmt) 2841f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Stack.back().VariablePos; 2851f80396dSAlexander Kornienko } 2861f80396dSAlexander Kornienko 2871f80396dSAlexander Kornienko unsigned Spaces = Current.SpacesRequiredBefore + ExtraSpaces; 2881f80396dSAlexander Kornienko 2891f80396dSAlexander Kornienko if (!DryRun) 2901f80396dSAlexander Kornienko Whitespaces.replaceWhitespace(Current, /*Newlines=*/0, /*IndentLevel=*/0, 2911f80396dSAlexander Kornienko Spaces, State.Column + Spaces); 2921f80396dSAlexander Kornienko 293a98b7b01SDaniel Jasper if (Current.is(TT_SelectorName) && 294b88b25feSDaniel Jasper !State.Stack.back().ObjCSelectorNameFound) { 295b88b25feSDaniel Jasper if (Current.LongestObjCSelectorName == 0) 296b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 297b88b25feSDaniel Jasper else if (State.Stack.back().Indent + Current.LongestObjCSelectorName > 2981f80396dSAlexander Kornienko State.Column + Spaces + Current.ColumnWidth) 2991f80396dSAlexander Kornienko State.Stack.back().ColonPos = 3001f80396dSAlexander Kornienko State.Stack.back().Indent + Current.LongestObjCSelectorName; 3011f80396dSAlexander Kornienko else 3021f80396dSAlexander Kornienko State.Stack.back().ColonPos = State.Column + Spaces + Current.ColumnWidth; 3031f80396dSAlexander Kornienko } 3041f80396dSAlexander Kornienko 305a98b7b01SDaniel Jasper if (Style.AlignAfterOpenBracket && Previous.opensScope() && 306a98b7b01SDaniel Jasper Previous.isNot(TT_ObjCMethodExpr) && 307a98b7b01SDaniel Jasper (Current.isNot(TT_LineComment) || Previous.BlockKind == BK_BracedInit)) 3081f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column + Spaces; 309ec01cd6eSDaniel Jasper if (State.Stack.back().AvoidBinPacking && startsNextParameter(Current, Style)) 3101f80396dSAlexander Kornienko State.Stack.back().NoLineBreak = true; 3111f80396dSAlexander Kornienko if (startsSegmentOfBuilderTypeCall(Current)) 3121f80396dSAlexander Kornienko State.Stack.back().ContainsUnwrappedBuilder = true; 3131f80396dSAlexander Kornienko 314d6f17d83SDaniel Jasper if (Current.isMemberAccess() && Previous.is(tok::r_paren) && 315d6f17d83SDaniel Jasper (Previous.MatchingParen && 316d6f17d83SDaniel Jasper (Previous.TotalLength - Previous.MatchingParen->TotalLength > 10))) { 317d6f17d83SDaniel Jasper // If there is a function call with long parameters, break before trailing 318d6f17d83SDaniel Jasper // calls. This prevents things like: 319d6f17d83SDaniel Jasper // EXPECT_CALL(SomeLongParameter).Times( 320d6f17d83SDaniel Jasper // 2); 321d6f17d83SDaniel Jasper // We don't want to do this for short parameters as they can just be 322d6f17d83SDaniel Jasper // indexes. 323d6f17d83SDaniel Jasper State.Stack.back().NoLineBreak = true; 324d6f17d83SDaniel Jasper } 325d6f17d83SDaniel Jasper 3261f80396dSAlexander Kornienko State.Column += Spaces; 3278acf822bSDaniel Jasper if (Current.isNot(tok::comment) && Previous.is(tok::l_paren) && 32811a0ac66SDaniel Jasper Previous.Previous && 32911a0ac66SDaniel Jasper Previous.Previous->isOneOf(tok::kw_if, tok::kw_for)) { 3301f80396dSAlexander Kornienko // Treat the condition inside an if as if it was a second function 3316633ab8aSDaniel Jasper // parameter, i.e. let nested calls have a continuation indent. 3328acf822bSDaniel Jasper State.Stack.back().LastSpace = State.Column; 33311a0ac66SDaniel Jasper State.Stack.back().NestedBlockIndent = State.Column; 33411a0ac66SDaniel Jasper } else if (!Current.isOneOf(tok::comment, tok::caret) && 335b88b25feSDaniel Jasper (Previous.is(tok::comma) || 33611a0ac66SDaniel Jasper (Previous.is(tok::colon) && Previous.is(TT_ObjCMethodExpr)))) { 3371f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 33811a0ac66SDaniel Jasper } else if ((Previous.isOneOf(TT_BinaryOperator, TT_ConditionalExpr, 339a98b7b01SDaniel Jasper TT_CtorInitializerColon)) && 3400e61784aSDaniel Jasper ((Previous.getPrecedence() != prec::Assignment && 3410e61784aSDaniel Jasper (Previous.isNot(tok::lessless) || Previous.OperatorIndex != 0 || 3420e61784aSDaniel Jasper !Previous.LastOperator)) || 34311a0ac66SDaniel Jasper Current.StartsBinaryExpression)) { 3441f80396dSAlexander Kornienko // Always indent relative to the RHS of the expression unless this is a 3451f80396dSAlexander Kornienko // simple assignment without binary expression on the RHS. Also indent 3461f80396dSAlexander Kornienko // relative to unary operators and the colons of constructor initializers. 3471f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 34811a0ac66SDaniel Jasper } else if (Previous.is(TT_InheritanceColon)) { 3491f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column; 350f9a5e404SDaniel Jasper State.Stack.back().LastSpace = State.Column; 351f9a5e404SDaniel Jasper } else if (Previous.opensScope()) { 3521f80396dSAlexander Kornienko // If a function has a trailing call, indent all parameters from the 3531f80396dSAlexander Kornienko // opening parenthesis. This avoids confusing indents like: 3541f80396dSAlexander Kornienko // OuterFunction(InnerFunctionCall( // break 3551f80396dSAlexander Kornienko // ParameterToInnerFunction)) // break 3561f80396dSAlexander Kornienko // .SecondInnerFunctionCall(); 3571f80396dSAlexander Kornienko bool HasTrailingCall = false; 3581f80396dSAlexander Kornienko if (Previous.MatchingParen) { 3591f80396dSAlexander Kornienko const FormatToken *Next = Previous.MatchingParen->getNextNonComment(); 3601f80396dSAlexander Kornienko HasTrailingCall = Next && Next->isMemberAccess(); 3611f80396dSAlexander Kornienko } 3621f80396dSAlexander Kornienko if (HasTrailingCall && 3631f80396dSAlexander Kornienko State.Stack[State.Stack.size() - 2].CallContinuation == 0) 3641f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 3651f80396dSAlexander Kornienko } 3661f80396dSAlexander Kornienko } 3671f80396dSAlexander Kornienko 3681f80396dSAlexander Kornienko unsigned ContinuationIndenter::addTokenOnNewLine(LineState &State, 3691f80396dSAlexander Kornienko bool DryRun) { 37071814b44SManuel Klimek FormatToken &Current = *State.NextToken; 3711f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 3729f388d04SDaniel Jasper 3731f80396dSAlexander Kornienko // Extra penalty that needs to be added because of the way certain line 3741f80396dSAlexander Kornienko // breaks are chosen. 3751f80396dSAlexander Kornienko unsigned Penalty = 0; 3761f80396dSAlexander Kornienko 377a0407740SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 378a0407740SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 379a0407740SDaniel Jasper if (!NextNonComment) 380a0407740SDaniel Jasper NextNonComment = &Current; 38105cd5868SDaniel Jasper // The first line break on any NestingLevel causes an extra penalty in order 3828de9ed05SDaniel Jasper // prefer similar line breaks. 3838de9ed05SDaniel Jasper if (!State.Stack.back().ContainsLineBreak) 3848de9ed05SDaniel Jasper Penalty += 15; 3858de9ed05SDaniel Jasper State.Stack.back().ContainsLineBreak = true; 3868de9ed05SDaniel Jasper 3878de9ed05SDaniel Jasper Penalty += State.NextToken->SplitPenalty; 3888de9ed05SDaniel Jasper 389de0328aeSDaniel Jasper // Breaking before the first "<<" is generally not desirable if the LHS is 39048437ce5SDaniel Jasper // short. Also always add the penalty if the LHS is split over mutliple lines 3912b7556ecSDaniel Jasper // to avoid unnecessary line breaks that just work around this penalty. 392a0407740SDaniel Jasper if (NextNonComment->is(tok::lessless) && 393a0407740SDaniel Jasper State.Stack.back().FirstLessLess == 0 && 394004177eeSDaniel Jasper (State.Column <= Style.ColumnLimit / 3 || 39548437ce5SDaniel Jasper State.Stack.back().BreakBeforeParameter)) 3968de9ed05SDaniel Jasper Penalty += Style.PenaltyBreakFirstLessLess; 397de0328aeSDaniel Jasper 3989f388d04SDaniel Jasper State.Column = getNewLineColumn(State); 39911a0ac66SDaniel Jasper State.Stack.back().NestedBlockIndent = State.Column; 4009f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 4019f388d04SDaniel Jasper if (State.Stack.back().CallContinuation == 0) 402de0328aeSDaniel Jasper State.Stack.back().CallContinuation = State.Column; 403a98b7b01SDaniel Jasper } else if (NextNonComment->is(TT_SelectorName)) { 404b88b25feSDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 405a0407740SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) { 406b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 407b88b25feSDaniel Jasper } else { 408b302f9a0SDaniel Jasper State.Stack.back().ColonPos = 409a0407740SDaniel Jasper State.Stack.back().Indent + NextNonComment->LongestObjCSelectorName; 410b88b25feSDaniel Jasper } 4119f388d04SDaniel Jasper } else if (State.Stack.back().AlignColons && 4129f388d04SDaniel Jasper State.Stack.back().ColonPos <= NextNonComment->ColumnWidth) { 413a0407740SDaniel Jasper State.Stack.back().ColonPos = State.Column + NextNonComment->ColumnWidth; 414de0328aeSDaniel Jasper } 4151fd6f1f8SDaniel Jasper } else if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 416a98b7b01SDaniel Jasper PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral)) { 417b88b25feSDaniel Jasper // FIXME: This is hacky, find a better way. The problem is that in an ObjC 418b88b25feSDaniel Jasper // method expression, the block should be aligned to the line starting it, 419b88b25feSDaniel Jasper // e.g.: 420b88b25feSDaniel Jasper // [aaaaaaaaaaaaaaa aaaaaaaaa: \\ break for some reason 421b88b25feSDaniel Jasper // ^(int *i) { 422b88b25feSDaniel Jasper // // ... 423b88b25feSDaniel Jasper // }]; 42405cd5868SDaniel Jasper // Thus, we set LastSpace of the next higher NestingLevel, to which we move 425b88b25feSDaniel Jasper // when we consume all of the "}"'s FakeRParens at the "{". 4269a26e773SDaniel Jasper if (State.Stack.size() > 1) 4279f388d04SDaniel Jasper State.Stack[State.Stack.size() - 2].LastSpace = 4289f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 4299f388d04SDaniel Jasper Style.ContinuationIndentWidth; 430de0328aeSDaniel Jasper } 431de0328aeSDaniel Jasper 432de0328aeSDaniel Jasper if ((Previous.isOneOf(tok::comma, tok::semi) && 433de0328aeSDaniel Jasper !State.Stack.back().AvoidBinPacking) || 434a98b7b01SDaniel Jasper Previous.is(TT_BinaryOperator)) 435de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 436a98b7b01SDaniel Jasper if (Previous.isOneOf(TT_TemplateCloser, TT_JavaAnnotation) && 43739af6cd5SDaniel Jasper Current.NestingLevel == 0) 438de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 439a0407740SDaniel Jasper if (NextNonComment->is(tok::question) || 440165b29e2SDaniel Jasper (PreviousNonComment && PreviousNonComment->is(tok::question))) 441165b29e2SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 442de0328aeSDaniel Jasper 443de0328aeSDaniel Jasper if (!DryRun) { 444a69ca9beSDaniel Jasper unsigned Newlines = std::max( 445a69ca9beSDaniel Jasper 1u, std::min(Current.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1)); 446e2e0387fSAlexander Kornienko Whitespaces.replaceWhitespace(Current, Newlines, 447e2e0387fSAlexander Kornienko State.Stack.back().IndentLevel, State.Column, 448e2e0387fSAlexander Kornienko State.Column, State.Line->InPPDirective); 449de0328aeSDaniel Jasper } 450de0328aeSDaniel Jasper 451de0328aeSDaniel Jasper if (!Current.isTrailingComment()) 452de0328aeSDaniel Jasper State.Stack.back().LastSpace = State.Column; 45305cd5868SDaniel Jasper State.StartOfLineLevel = Current.NestingLevel; 45405cd5868SDaniel Jasper State.LowestLevelOnLine = Current.NestingLevel; 455de0328aeSDaniel Jasper 456de0328aeSDaniel Jasper // Any break on this level means that the parent level has been broken 457de0328aeSDaniel Jasper // and we need to avoid bin packing there. 4584b444495SDaniel Jasper bool NestedBlockSpecialCase = 4594b444495SDaniel Jasper Current.is(tok::r_brace) && State.Stack.size() > 1 && 4604b444495SDaniel Jasper State.Stack[State.Stack.size() - 2].NestedBlockInlined; 4614b444495SDaniel Jasper if (!NestedBlockSpecialCase) { 462de0328aeSDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { 463de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 464de0328aeSDaniel Jasper } 465b16b969dSDaniel Jasper } 466b16b969dSDaniel Jasper 4679e5ede0fSDaniel Jasper if (PreviousNonComment && 4689e5ede0fSDaniel Jasper !PreviousNonComment->isOneOf(tok::comma, tok::semi) && 469a98b7b01SDaniel Jasper (PreviousNonComment->isNot(TT_TemplateCloser) || 4706c0ee17bSDaniel Jasper Current.NestingLevel != 0) && 471a98b7b01SDaniel Jasper !PreviousNonComment->isOneOf(TT_BinaryOperator, TT_JavaAnnotation, 472a98b7b01SDaniel Jasper TT_LeadingJavaAnnotation) && 473a98b7b01SDaniel Jasper Current.isNot(TT_BinaryOperator) && !PreviousNonComment->opensScope()) 474de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 475de0328aeSDaniel Jasper 4761db6c386SDaniel Jasper // If we break after { or the [ of an array initializer, we should also break 4771db6c386SDaniel Jasper // before the corresponding } or ]. 47890818057SDaniel Jasper if (PreviousNonComment && 479a98b7b01SDaniel Jasper (PreviousNonComment->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare))) 480de0328aeSDaniel Jasper State.Stack.back().BreakBeforeClosingBrace = true; 481de0328aeSDaniel Jasper 482de0328aeSDaniel Jasper if (State.Stack.back().AvoidBinPacking) { 483de0328aeSDaniel Jasper // If we are breaking after '(', '{', '<', this is not bin packing 4842a958321SDaniel Jasper // unless AllowAllParametersOfDeclarationOnNextLine is false or this is a 4852a958321SDaniel Jasper // dict/object literal. 486a98b7b01SDaniel Jasper if (!Previous.isOneOf(tok::l_paren, tok::l_brace, TT_BinaryOperator) || 487de0328aeSDaniel Jasper (!Style.AllowAllParametersOfDeclarationOnNextLine && 4882a958321SDaniel Jasper State.Line->MustBeDeclaration) || 489a98b7b01SDaniel Jasper Previous.is(TT_DictLiteral)) 490de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 491de0328aeSDaniel Jasper } 492de0328aeSDaniel Jasper 4931f80396dSAlexander Kornienko return Penalty; 494de0328aeSDaniel Jasper } 495de0328aeSDaniel Jasper 4969f388d04SDaniel Jasper unsigned ContinuationIndenter::getNewLineColumn(const LineState &State) { 4975d2587daSDaniel Jasper if (!State.NextToken || !State.NextToken->Previous) 4985d2587daSDaniel Jasper return 0; 4999f388d04SDaniel Jasper FormatToken &Current = *State.NextToken; 5004281c5aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 5019f388d04SDaniel Jasper // If we are continuing an expression, we want to use the continuation indent. 5029f388d04SDaniel Jasper unsigned ContinuationIndent = 5039f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 5049f388d04SDaniel Jasper Style.ContinuationIndentWidth; 5059f388d04SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 5069f388d04SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 5079f388d04SDaniel Jasper if (!NextNonComment) 5089f388d04SDaniel Jasper NextNonComment = &Current; 50950b4bd7cSDaniel Jasper 51050b4bd7cSDaniel Jasper // Java specific bits. 511d0ec0d62SDaniel Jasper if (Style.Language == FormatStyle::LK_Java && 512d0ec0d62SDaniel Jasper Current.isOneOf(Keywords.kw_implements, Keywords.kw_extends)) 51350b4bd7cSDaniel Jasper return std::max(State.Stack.back().LastSpace, 51450b4bd7cSDaniel Jasper State.Stack.back().Indent + Style.ContinuationIndentWidth); 51550b4bd7cSDaniel Jasper 516b05a81deSDaniel Jasper if (NextNonComment->is(tok::l_brace) && NextNonComment->BlockKind == BK_Block) 51705cd5868SDaniel Jasper return Current.NestingLevel == 0 ? State.FirstIndent 5189f388d04SDaniel Jasper : State.Stack.back().Indent; 5199f388d04SDaniel Jasper if (Current.isOneOf(tok::r_brace, tok::r_square)) { 52011a0ac66SDaniel Jasper if (Current.closesBlockTypeList(Style)) 52111a0ac66SDaniel Jasper return State.Stack[State.Stack.size() - 2].NestedBlockIndent; 52211a0ac66SDaniel Jasper if (Current.MatchingParen && 52311a0ac66SDaniel Jasper Current.MatchingParen->BlockKind == BK_BracedInit) 5249f388d04SDaniel Jasper return State.Stack[State.Stack.size() - 2].LastSpace; 5259f388d04SDaniel Jasper return State.FirstIndent; 5269f388d04SDaniel Jasper } 527783bac6bSDaniel Jasper if (Current.is(tok::identifier) && Current.Next && 528a98b7b01SDaniel Jasper Current.Next->is(TT_DictLiteral)) 529783bac6bSDaniel Jasper return State.Stack.back().Indent; 5309f388d04SDaniel Jasper if (NextNonComment->isStringLiteral() && State.StartOfStringLiteral != 0) 5319f388d04SDaniel Jasper return State.StartOfStringLiteral; 5329f388d04SDaniel Jasper if (NextNonComment->is(tok::lessless) && 5339f388d04SDaniel Jasper State.Stack.back().FirstLessLess != 0) 5349f388d04SDaniel Jasper return State.Stack.back().FirstLessLess; 5359f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 53624a14777SDaniel Jasper if (State.Stack.back().CallContinuation == 0) 5379f388d04SDaniel Jasper return ContinuationIndent; 5389f388d04SDaniel Jasper return State.Stack.back().CallContinuation; 5399f388d04SDaniel Jasper } 5409f388d04SDaniel Jasper if (State.Stack.back().QuestionColumn != 0 && 541c0d606a5SDaniel Jasper ((NextNonComment->is(tok::colon) && 542a98b7b01SDaniel Jasper NextNonComment->is(TT_ConditionalExpr)) || 543a98b7b01SDaniel Jasper Previous.is(TT_ConditionalExpr))) 5449f388d04SDaniel Jasper return State.Stack.back().QuestionColumn; 5459f388d04SDaniel Jasper if (Previous.is(tok::comma) && State.Stack.back().VariablePos != 0) 5469f388d04SDaniel Jasper return State.Stack.back().VariablePos; 547e9ab42dfSDaniel Jasper if ((PreviousNonComment && 548e9ab42dfSDaniel Jasper (PreviousNonComment->ClosesTemplateDeclaration || 549a98b7b01SDaniel Jasper PreviousNonComment->isOneOf(TT_AttributeParen, TT_JavaAnnotation, 550a98b7b01SDaniel Jasper TT_LeadingJavaAnnotation))) || 551c75e1effSDaniel Jasper (!Style.IndentWrappedFunctionNames && 552a98b7b01SDaniel Jasper NextNonComment->isOneOf(tok::kw_operator, TT_FunctionDeclarationName))) 5539f388d04SDaniel Jasper return std::max(State.Stack.back().LastSpace, State.Stack.back().Indent); 554a98b7b01SDaniel Jasper if (NextNonComment->is(TT_SelectorName)) { 5559f388d04SDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 55624a14777SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) 5579f388d04SDaniel Jasper return State.Stack.back().Indent; 5589f388d04SDaniel Jasper return State.Stack.back().Indent + 5599f388d04SDaniel Jasper NextNonComment->LongestObjCSelectorName - 5609f388d04SDaniel Jasper NextNonComment->ColumnWidth; 5619f388d04SDaniel Jasper } 56224a14777SDaniel Jasper if (!State.Stack.back().AlignColons) 5639f388d04SDaniel Jasper return State.Stack.back().Indent; 56424a14777SDaniel Jasper if (State.Stack.back().ColonPos > NextNonComment->ColumnWidth) 5659f388d04SDaniel Jasper return State.Stack.back().ColonPos - NextNonComment->ColumnWidth; 5669f388d04SDaniel Jasper return State.Stack.back().Indent; 5679f388d04SDaniel Jasper } 568a98b7b01SDaniel Jasper if (NextNonComment->is(TT_ArraySubscriptLSquare)) { 5699f388d04SDaniel Jasper if (State.Stack.back().StartOfArraySubscripts != 0) 5709f388d04SDaniel Jasper return State.Stack.back().StartOfArraySubscripts; 5719f388d04SDaniel Jasper return ContinuationIndent; 5729f388d04SDaniel Jasper } 573a98b7b01SDaniel Jasper if (NextNonComment->is(TT_StartOfName) || 5749f388d04SDaniel Jasper Previous.isOneOf(tok::coloncolon, tok::equal)) { 5759f388d04SDaniel Jasper return ContinuationIndent; 5769f388d04SDaniel Jasper } 5779f388d04SDaniel Jasper if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 578a98b7b01SDaniel Jasper PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral)) 5799f388d04SDaniel Jasper return ContinuationIndent; 580a98b7b01SDaniel Jasper if (NextNonComment->is(TT_CtorInitializerColon)) 5819f388d04SDaniel Jasper return State.FirstIndent + Style.ConstructorInitializerIndentWidth; 582a98b7b01SDaniel Jasper if (NextNonComment->is(TT_CtorInitializerComma)) 5839f388d04SDaniel Jasper return State.Stack.back().Indent; 584316ab38eSDaniel Jasper if (Previous.is(tok::r_paren) && !Current.isBinaryOperator() && 585119ff533SDaniel Jasper !Current.isOneOf(tok::colon, tok::comment)) 586316ab38eSDaniel Jasper return ContinuationIndent; 5875d2587daSDaniel Jasper if (State.Stack.back().Indent == State.FirstIndent && PreviousNonComment && 5889f388d04SDaniel Jasper PreviousNonComment->isNot(tok::r_brace)) 5899f388d04SDaniel Jasper // Ensure that we fall back to the continuation indent width instead of 5909f388d04SDaniel Jasper // just flushing continuations left. 5919f388d04SDaniel Jasper return State.Stack.back().Indent + Style.ContinuationIndentWidth; 5929f388d04SDaniel Jasper return State.Stack.back().Indent; 5939f388d04SDaniel Jasper } 5949f388d04SDaniel Jasper 595de0328aeSDaniel Jasper unsigned ContinuationIndenter::moveStateToNextToken(LineState &State, 596de0328aeSDaniel Jasper bool DryRun, bool Newline) { 597de0328aeSDaniel Jasper assert(State.Stack.size()); 59860553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 599de0328aeSDaniel Jasper 600a98b7b01SDaniel Jasper if (Current.is(TT_InheritanceColon)) 601de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 602a98b7b01SDaniel Jasper if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator)) { 603c0d606a5SDaniel Jasper if (State.Stack.back().FirstLessLess == 0) 604de0328aeSDaniel Jasper State.Stack.back().FirstLessLess = State.Column; 605c0d606a5SDaniel Jasper else 606c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 607c0d606a5SDaniel Jasper } 608a98b7b01SDaniel Jasper if ((Current.is(TT_BinaryOperator) && Current.isNot(tok::lessless)) || 609a98b7b01SDaniel Jasper Current.is(TT_ConditionalExpr)) 610c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 611a98b7b01SDaniel Jasper if (Current.is(TT_ArraySubscriptLSquare) && 612de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts == 0) 613de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = State.Column; 614165b29e2SDaniel Jasper if ((Current.is(tok::question) && Style.BreakBeforeTernaryOperators) || 615165b29e2SDaniel Jasper (Current.getPreviousNonComment() && Current.isNot(tok::colon) && 616165b29e2SDaniel Jasper Current.getPreviousNonComment()->is(tok::question) && 617165b29e2SDaniel Jasper !Style.BreakBeforeTernaryOperators)) 618de0328aeSDaniel Jasper State.Stack.back().QuestionColumn = State.Column; 619de0328aeSDaniel Jasper if (!Current.opensScope() && !Current.closesScope()) 620de0328aeSDaniel Jasper State.LowestLevelOnLine = 62105cd5868SDaniel Jasper std::min(State.LowestLevelOnLine, Current.NestingLevel); 6224c6e0059SDaniel Jasper if (Current.isMemberAccess()) 623de0328aeSDaniel Jasper State.Stack.back().StartOfFunctionCall = 6240e61784aSDaniel Jasper Current.LastOperator ? 0 : State.Column + Current.ColumnWidth; 625a98b7b01SDaniel Jasper if (Current.is(TT_SelectorName)) 626b88b25feSDaniel Jasper State.Stack.back().ObjCSelectorNameFound = true; 627a98b7b01SDaniel Jasper if (Current.is(TT_CtorInitializerColon)) { 628de0328aeSDaniel Jasper // Indent 2 from the column, so: 629de0328aeSDaniel Jasper // SomeClass::SomeClass() 630de0328aeSDaniel Jasper // : First(...), ... 631de0328aeSDaniel Jasper // Next(...) 632de0328aeSDaniel Jasper // ^ line up here. 633de0328aeSDaniel Jasper State.Stack.back().Indent = 634de0328aeSDaniel Jasper State.Column + (Style.BreakConstructorInitializersBeforeComma ? 0 : 2); 635de0328aeSDaniel Jasper if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine) 636de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 637de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 638de0328aeSDaniel Jasper } 639de0328aeSDaniel Jasper 640de0328aeSDaniel Jasper // In ObjC method declaration we align on the ":" of parameters, but we need 6416633ab8aSDaniel Jasper // to ensure that we indent parameters on subsequent lines by at least our 6426633ab8aSDaniel Jasper // continuation indent width. 643a98b7b01SDaniel Jasper if (Current.is(TT_ObjCMethodSpecifier)) 6446633ab8aSDaniel Jasper State.Stack.back().Indent += Style.ContinuationIndentWidth; 645de0328aeSDaniel Jasper 646de0328aeSDaniel Jasper // Insert scopes created by fake parenthesis. 647de0328aeSDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 648b16b969dSDaniel Jasper 649b16b969dSDaniel Jasper // Add special behavior to support a format commonly used for JavaScript 650b16b969dSDaniel Jasper // closures: 651b16b969dSDaniel Jasper // SomeFunction(function() { 652b16b969dSDaniel Jasper // foo(); 653b16b969dSDaniel Jasper // bar(); 654b16b969dSDaniel Jasper // }, a, b, c); 655b16b969dSDaniel Jasper if (Current.isNot(tok::comment) && Previous && Previous->is(tok::l_brace) && 656b16b969dSDaniel Jasper State.Stack.size() > 1) { 6574b444495SDaniel Jasper if (State.Stack[State.Stack.size() - 2].NestedBlockInlined && Newline) { 658b16b969dSDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { 659b16b969dSDaniel Jasper State.Stack[i].NoLineBreak = true; 660b16b969dSDaniel Jasper } 661b16b969dSDaniel Jasper } 6624b444495SDaniel Jasper State.Stack[State.Stack.size() - 2].NestedBlockInlined = false; 663b16b969dSDaniel Jasper } 6644b444495SDaniel Jasper if (Previous && (Previous->isOneOf(tok::l_paren, tok::comma, tok::colon) || 6654b444495SDaniel Jasper Previous->isOneOf(TT_BinaryOperator, TT_ConditionalExpr)) && 6664b444495SDaniel Jasper !Previous->isOneOf(TT_DictLiteral, TT_ObjCMethodExpr)) { 6674b444495SDaniel Jasper State.Stack.back().NestedBlockInlined = 6684b444495SDaniel Jasper !Newline && 66911a0ac66SDaniel Jasper (Previous->isNot(tok::l_paren) || Previous->ParameterCount > 1); 670b16b969dSDaniel Jasper } 671b16b969dSDaniel Jasper 67260553be5SDaniel Jasper moveStatePastFakeLParens(State, Newline); 67360553be5SDaniel Jasper moveStatePastScopeOpener(State, Newline); 67460553be5SDaniel Jasper moveStatePastScopeCloser(State); 67560553be5SDaniel Jasper moveStatePastFakeRParens(State); 67660553be5SDaniel Jasper 67760553be5SDaniel Jasper if (Current.isStringLiteral() && State.StartOfStringLiteral == 0) { 67860553be5SDaniel Jasper State.StartOfStringLiteral = State.Column; 67960553be5SDaniel Jasper } else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash) && 68060553be5SDaniel Jasper !Current.isStringLiteral()) { 68160553be5SDaniel Jasper State.StartOfStringLiteral = 0; 68260553be5SDaniel Jasper } 68360553be5SDaniel Jasper 68460553be5SDaniel Jasper State.Column += Current.ColumnWidth; 68560553be5SDaniel Jasper State.NextToken = State.NextToken->Next; 68660553be5SDaniel Jasper unsigned Penalty = breakProtrudingToken(Current, State, DryRun); 68760553be5SDaniel Jasper if (State.Column > getColumnLimit(State)) { 68860553be5SDaniel Jasper unsigned ExcessCharacters = State.Column - getColumnLimit(State); 68960553be5SDaniel Jasper Penalty += Style.PenaltyExcessCharacter * ExcessCharacters; 69060553be5SDaniel Jasper } 69160553be5SDaniel Jasper 69260553be5SDaniel Jasper if (Current.Role) 69360553be5SDaniel Jasper Current.Role->formatFromToken(State, this, DryRun); 69460553be5SDaniel Jasper // If the previous has a special role, let it consume tokens as appropriate. 69560553be5SDaniel Jasper // It is necessary to start at the previous token for the only implemented 69660553be5SDaniel Jasper // role (comma separated list). That way, the decision whether or not to break 69760553be5SDaniel Jasper // after the "{" is already done and both options are tried and evaluated. 69860553be5SDaniel Jasper // FIXME: This is ugly, find a better way. 69960553be5SDaniel Jasper if (Previous && Previous->Role) 70060553be5SDaniel Jasper Penalty += Previous->Role->formatAfterToken(State, this, DryRun); 70160553be5SDaniel Jasper 70260553be5SDaniel Jasper return Penalty; 70360553be5SDaniel Jasper } 70460553be5SDaniel Jasper 70560553be5SDaniel Jasper void ContinuationIndenter::moveStatePastFakeLParens(LineState &State, 70660553be5SDaniel Jasper bool Newline) { 70760553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 70860553be5SDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 70960553be5SDaniel Jasper 710de0328aeSDaniel Jasper // Don't add extra indentation for the first fake parenthesis after 7110db806b7SDinesh Dwivedi // 'return', assignments or opening <({[. The indentation for these cases 712de0328aeSDaniel Jasper // is special cased. 713de0328aeSDaniel Jasper bool SkipFirstExtraIndent = 714eabede6dSDaniel Jasper (Previous && (Previous->opensScope() || Previous->is(tok::kw_return) || 7153219e43cSDaniel Jasper (Previous->getPrecedence() == prec::Assignment && 7163219e43cSDaniel Jasper Style.AlignOperands) || 717a98b7b01SDaniel Jasper Previous->is(TT_ObjCMethodExpr))); 718de0328aeSDaniel Jasper for (SmallVectorImpl<prec::Level>::const_reverse_iterator 719de0328aeSDaniel Jasper I = Current.FakeLParens.rbegin(), 720de0328aeSDaniel Jasper E = Current.FakeLParens.rend(); 721de0328aeSDaniel Jasper I != E; ++I) { 722de0328aeSDaniel Jasper ParenState NewParenState = State.Stack.back(); 723de0328aeSDaniel Jasper NewParenState.ContainsLineBreak = false; 724eabede6dSDaniel Jasper 7253aa9a6a1SDaniel Jasper // Indent from 'LastSpace' unless these are fake parentheses encapsulating 7263aa9a6a1SDaniel Jasper // a builder type call after 'return' or, if the alignment after opening 7273aa9a6a1SDaniel Jasper // brackets is disabled. 7284281c5aeSDaniel Jasper if (!Current.isTrailingComment() && 7293219e43cSDaniel Jasper (Style.AlignOperands || *I < prec::Assignment) && 7306cab6784SDaniel Jasper (!Previous || Previous->isNot(tok::kw_return) || 7316cab6784SDaniel Jasper (Style.Language != FormatStyle::LK_Java && *I > 0)) && 7323aa9a6a1SDaniel Jasper (Style.AlignAfterOpenBracket || *I != prec::Comma || 7333aa9a6a1SDaniel Jasper Current.NestingLevel == 0)) 734de0328aeSDaniel Jasper NewParenState.Indent = 735de0328aeSDaniel Jasper std::max(std::max(State.Column, NewParenState.Indent), 736de0328aeSDaniel Jasper State.Stack.back().LastSpace); 737eabede6dSDaniel Jasper 7385c33265cSDaniel Jasper // Don't allow the RHS of an operator to be split over multiple lines unless 7395c33265cSDaniel Jasper // there is a line-break right after the operator. 7405c33265cSDaniel Jasper // Exclude relational operators, as there, it is always more desirable to 7415c33265cSDaniel Jasper // have the LHS 'left' of the RHS. 742c0d606a5SDaniel Jasper if (Previous && Previous->getPrecedence() > prec::Assignment && 743a98b7b01SDaniel Jasper Previous->isOneOf(TT_BinaryOperator, TT_ConditionalExpr) && 744c0d606a5SDaniel Jasper Previous->getPrecedence() != prec::Relational) { 7458c6e9ef6SDaniel Jasper bool BreakBeforeOperator = 7468c6e9ef6SDaniel Jasper Previous->is(tok::lessless) || 747a98b7b01SDaniel Jasper (Previous->is(TT_BinaryOperator) && 7488c6e9ef6SDaniel Jasper Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None) || 749a98b7b01SDaniel Jasper (Previous->is(TT_ConditionalExpr) && 750c0d606a5SDaniel Jasper Style.BreakBeforeTernaryOperators); 751c0d606a5SDaniel Jasper if ((!Newline && !BreakBeforeOperator) || 752c0d606a5SDaniel Jasper (!State.Stack.back().LastOperatorWrapped && BreakBeforeOperator)) 7535c33265cSDaniel Jasper NewParenState.NoLineBreak = true; 754c0d606a5SDaniel Jasper } 7555c33265cSDaniel Jasper 7569fe0e8daSDaniel Jasper // Do not indent relative to the fake parentheses inserted for "." or "->". 7579fe0e8daSDaniel Jasper // This is a special case to make the following to statements consistent: 7589fe0e8daSDaniel Jasper // OuterFunction(InnerFunctionCall( // break 7599fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 7609fe0e8daSDaniel Jasper // OuterFunction(SomeObject.InnerFunctionCall( // break 7619fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 7629fe0e8daSDaniel Jasper if (*I > prec::Unknown) 7639fe0e8daSDaniel Jasper NewParenState.LastSpace = std::max(NewParenState.LastSpace, State.Column); 764a536df4bSDaniel Jasper if (*I != prec::Conditional) 76596964359SDaniel Jasper NewParenState.StartOfFunctionCall = State.Column; 766de0328aeSDaniel Jasper 767de0328aeSDaniel Jasper // Always indent conditional expressions. Never indent expression where 768de0328aeSDaniel Jasper // the 'operator' is ',', ';' or an assignment (i.e. *I <= 769de0328aeSDaniel Jasper // prec::Assignment) as those have different indentation rules. Indent 770de0328aeSDaniel Jasper // other expression, unless the indentation needs to be skipped. 771de0328aeSDaniel Jasper if (*I == prec::Conditional || 772de0328aeSDaniel Jasper (!SkipFirstExtraIndent && *I > prec::Assignment && 7738c6e9ef6SDaniel Jasper !Current.isTrailingComment())) 7746633ab8aSDaniel Jasper NewParenState.Indent += Style.ContinuationIndentWidth; 7751db6c386SDaniel Jasper if ((Previous && !Previous->opensScope()) || *I > prec::Comma) 776de0328aeSDaniel Jasper NewParenState.BreakBeforeParameter = false; 777de0328aeSDaniel Jasper State.Stack.push_back(NewParenState); 778de0328aeSDaniel Jasper SkipFirstExtraIndent = false; 779de0328aeSDaniel Jasper } 78060553be5SDaniel Jasper } 781de0328aeSDaniel Jasper 78211a0ac66SDaniel Jasper void ContinuationIndenter::moveStatePastFakeRParens(LineState &State) { 78311a0ac66SDaniel Jasper for (unsigned i = 0, e = State.NextToken->FakeRParens; i != e; ++i) { 78460553be5SDaniel Jasper unsigned VariablePos = State.Stack.back().VariablePos; 785819788daSManuel Klimek assert(State.Stack.size() > 1); 786819788daSManuel Klimek if (State.Stack.size() == 1) { 787819788daSManuel Klimek // Do not pop the last element. 788819788daSManuel Klimek break; 789819788daSManuel Klimek } 7909fe0e8daSDaniel Jasper State.Stack.pop_back(); 79160553be5SDaniel Jasper State.Stack.back().VariablePos = VariablePos; 792819788daSManuel Klimek } 79360553be5SDaniel Jasper } 794335ff266SDaniel Jasper 79560553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeOpener(LineState &State, 79660553be5SDaniel Jasper bool Newline) { 79760553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 79860553be5SDaniel Jasper if (!Current.opensScope()) 79960553be5SDaniel Jasper return; 80060553be5SDaniel Jasper 80160553be5SDaniel Jasper if (Current.MatchingParen && Current.BlockKind == BK_Block) { 80260553be5SDaniel Jasper moveStateToNewBlock(State); 80360553be5SDaniel Jasper return; 80460553be5SDaniel Jasper } 80560553be5SDaniel Jasper 80660553be5SDaniel Jasper unsigned NewIndent; 80760553be5SDaniel Jasper unsigned NewIndentLevel = State.Stack.back().IndentLevel; 80860553be5SDaniel Jasper bool AvoidBinPacking; 80960553be5SDaniel Jasper bool BreakBeforeParameter = false; 810a98b7b01SDaniel Jasper if (Current.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare)) { 811b8f61682SDaniel Jasper if (Current.opensBlockTypeList(Style)) { 81211a0ac66SDaniel Jasper NewIndent = State.Stack.back().NestedBlockIndent + Style.IndentWidth; 8135a611397SDaniel Jasper NewIndent = std::min(State.Column + 2, NewIndent); 814e2e0387fSAlexander Kornienko ++NewIndentLevel; 815b8f61682SDaniel Jasper } else { 81611a0ac66SDaniel Jasper NewIndent = State.Stack.back().LastSpace + Style.ContinuationIndentWidth; 8175a611397SDaniel Jasper NewIndent = std::min(State.Column + 1, NewIndent); 818e2e0387fSAlexander Kornienko } 819de0328aeSDaniel Jasper const FormatToken *NextNoComment = Current.getNextNonComment(); 820a98b7b01SDaniel Jasper AvoidBinPacking = 821a98b7b01SDaniel Jasper Current.isOneOf(TT_ArrayInitializerLSquare, TT_DictLiteral) || 822a98b7b01SDaniel Jasper Style.Language == FormatStyle::LK_Proto || !Style.BinPackParameters || 823a98b7b01SDaniel Jasper (NextNoComment && NextNoComment->is(TT_DesignatedInitializerPeriod)); 824de0328aeSDaniel Jasper } else { 8256633ab8aSDaniel Jasper NewIndent = Style.ContinuationIndentWidth + 8266633ab8aSDaniel Jasper std::max(State.Stack.back().LastSpace, 8279fe0e8daSDaniel Jasper State.Stack.back().StartOfFunctionCall); 82818210d7dSDaniel Jasper AvoidBinPacking = 82918210d7dSDaniel Jasper (State.Line->MustBeDeclaration && !Style.BinPackParameters) || 83018210d7dSDaniel Jasper (!State.Line->MustBeDeclaration && !Style.BinPackArguments) || 831de0328aeSDaniel Jasper (Style.ExperimentalAutoDetectBinPacking && 832de0328aeSDaniel Jasper (Current.PackingKind == PPK_OnePerLine || 833de0328aeSDaniel Jasper (!BinPackInconclusiveFunctions && 834de0328aeSDaniel Jasper Current.PackingKind == PPK_Inconclusive))); 8351db6c386SDaniel Jasper // If this '[' opens an ObjC call, determine whether all parameters fit 8361db6c386SDaniel Jasper // into one line and put one per line if they don't. 837a98b7b01SDaniel Jasper if (Current.is(TT_ObjCMethodExpr) && Style.ColumnLimit != 0 && 8381db6c386SDaniel Jasper getLengthToMatchingParen(Current) + State.Column > 8391db6c386SDaniel Jasper getColumnLimit(State)) 8401db6c386SDaniel Jasper BreakBeforeParameter = true; 841de0328aeSDaniel Jasper } 842a41aa536SDaniel Jasper bool NoLineBreak = State.Stack.back().NoLineBreak || 843a98b7b01SDaniel Jasper (Current.is(TT_TemplateOpener) && 844cc3114d8SDaniel Jasper State.Stack.back().ContainsUnwrappedBuilder); 84511a0ac66SDaniel Jasper unsigned NestedBlockIndent = State.Stack.back().NestedBlockIndent; 846cc3114d8SDaniel Jasper State.Stack.push_back(ParenState(NewIndent, NewIndentLevel, 847cc3114d8SDaniel Jasper State.Stack.back().LastSpace, 848cc3114d8SDaniel Jasper AvoidBinPacking, NoLineBreak)); 84911a0ac66SDaniel Jasper State.Stack.back().NestedBlockIndent = NestedBlockIndent; 8501db6c386SDaniel Jasper State.Stack.back().BreakBeforeParameter = BreakBeforeParameter; 851114a2bc9SDaniel Jasper State.Stack.back().HasMultipleNestedBlocks = Current.BlockParameterCount > 1; 852de0328aeSDaniel Jasper } 853de0328aeSDaniel Jasper 85460553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) { 85560553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 85660553be5SDaniel Jasper if (!Current.closesScope()) 85760553be5SDaniel Jasper return; 85860553be5SDaniel Jasper 859de0328aeSDaniel Jasper // If we encounter a closing ), ], } or >, we can remove a level from our 860de0328aeSDaniel Jasper // stacks. 86196df37a6SDaniel Jasper if (State.Stack.size() > 1 && 86296df37a6SDaniel Jasper (Current.isOneOf(tok::r_paren, tok::r_square) || 8639fe0e8daSDaniel Jasper (Current.is(tok::r_brace) && State.NextToken != State.Line->First) || 864a98b7b01SDaniel Jasper State.NextToken->is(TT_TemplateCloser))) 865de0328aeSDaniel Jasper State.Stack.pop_back(); 866335ff266SDaniel Jasper 867de0328aeSDaniel Jasper if (Current.is(tok::r_square)) { 868de0328aeSDaniel Jasper // If this ends the array subscript expr, reset the corresponding value. 869de0328aeSDaniel Jasper const FormatToken *NextNonComment = Current.getNextNonComment(); 870de0328aeSDaniel Jasper if (NextNonComment && NextNonComment->isNot(tok::l_square)) 871de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = 0; 872de0328aeSDaniel Jasper } 87360553be5SDaniel Jasper } 874de0328aeSDaniel Jasper 87560553be5SDaniel Jasper void ContinuationIndenter::moveStateToNewBlock(LineState &State) { 87611a0ac66SDaniel Jasper unsigned NestedBlockIndent = State.Stack.back().NestedBlockIndent; 87750d634b3SDaniel Jasper // ObjC block sometimes follow special indentation rules. 878a98b7b01SDaniel Jasper unsigned NewIndent = 87911a0ac66SDaniel Jasper NestedBlockIndent + (State.NextToken->is(TT_ObjCBlockLBrace) 88050d634b3SDaniel Jasper ? Style.ObjCBlockIndentWidth 88160553be5SDaniel Jasper : Style.IndentWidth); 88260553be5SDaniel Jasper State.Stack.push_back(ParenState( 88360553be5SDaniel Jasper NewIndent, /*NewIndentLevel=*/State.Stack.back().IndentLevel + 1, 88460553be5SDaniel Jasper State.Stack.back().LastSpace, /*AvoidBinPacking=*/true, 88560553be5SDaniel Jasper State.Stack.back().NoLineBreak)); 88611a0ac66SDaniel Jasper State.Stack.back().NestedBlockIndent = NestedBlockIndent; 88760553be5SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 888de0328aeSDaniel Jasper } 889de0328aeSDaniel Jasper 890917f9e04SAlexander Kornienko unsigned ContinuationIndenter::addMultilineToken(const FormatToken &Current, 891d7b837e7SAlexander Kornienko LineState &State) { 892d7b837e7SAlexander Kornienko // Break before further function parameters on all levels. 893d7b837e7SAlexander Kornienko for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 894d7b837e7SAlexander Kornienko State.Stack[i].BreakBeforeParameter = true; 895d7b837e7SAlexander Kornienko 89639856b71SAlexander Kornienko unsigned ColumnsUsed = State.Column; 897632abb9bSAlexander Kornienko // We can only affect layout of the first and the last line, so the penalty 898632abb9bSAlexander Kornienko // for all other lines is constant, and we ignore it. 899ebb43caaSAlexander Kornienko State.Column = Current.LastLineColumnWidth; 900632abb9bSAlexander Kornienko 9019fe0e8daSDaniel Jasper if (ColumnsUsed > getColumnLimit(State)) 9029fe0e8daSDaniel Jasper return Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit(State)); 903d7b837e7SAlexander Kornienko return 0; 904d7b837e7SAlexander Kornienko } 905d7b837e7SAlexander Kornienko 906de0328aeSDaniel Jasper unsigned ContinuationIndenter::breakProtrudingToken(const FormatToken &Current, 907de0328aeSDaniel Jasper LineState &State, 908de0328aeSDaniel Jasper bool DryRun) { 909917f9e04SAlexander Kornienko // Don't break multi-line tokens other than block comments. Instead, just 910917f9e04SAlexander Kornienko // update the state. 911a98b7b01SDaniel Jasper if (Current.isNot(TT_BlockComment) && Current.IsMultiline) 912917f9e04SAlexander Kornienko return addMultilineToken(Current, State); 913917f9e04SAlexander Kornienko 914616de864SDaniel Jasper // Don't break implicit string literals or import statements. 915a98b7b01SDaniel Jasper if (Current.is(TT_ImplicitStringLiteral) || 916616de864SDaniel Jasper State.Line->Type == LT_ImportStatement) 9179885784dSDaniel Jasper return 0; 9189885784dSDaniel Jasper 91904b6a081SDaniel Jasper if (!Current.isStringLiteral() && !Current.is(tok::comment)) 920f93551c8SDaniel Jasper return 0; 921f93551c8SDaniel Jasper 922b8984329SAhmed Charles std::unique_ptr<BreakableToken> Token; 92339856b71SAlexander Kornienko unsigned StartColumn = State.Column - Current.ColumnWidth; 9243abbb8a4SAlexander Kornienko unsigned ColumnLimit = getColumnLimit(State); 925de0328aeSDaniel Jasper 92604b6a081SDaniel Jasper if (Current.isStringLiteral()) { 927428f0b14SDaniel Jasper // FIXME: String literal breaking is currently disabled for Java and JS, as 928428f0b14SDaniel Jasper // it requires strings to be merged using "+" which we don't support. 929428f0b14SDaniel Jasper if (Style.Language == FormatStyle::LK_Java || 930428f0b14SDaniel Jasper Style.Language == FormatStyle::LK_JavaScript) 931428f0b14SDaniel Jasper return 0; 932428f0b14SDaniel Jasper 933384b40b9SAlexander Kornienko // Don't break string literals inside preprocessor directives (except for 934384b40b9SAlexander Kornienko // #define directives, as their contents are stored in separate lines and 935384b40b9SAlexander Kornienko // are not affected by this check). 936384b40b9SAlexander Kornienko // This way we avoid breaking code with line directives and unknown 937384b40b9SAlexander Kornienko // preprocessor directives that contain long string literals. 938384b40b9SAlexander Kornienko if (State.Line->Type == LT_PreprocessorDirective) 939384b40b9SAlexander Kornienko return 0; 940de0328aeSDaniel Jasper // Exempts unterminated string literals from line breaking. The user will 941de0328aeSDaniel Jasper // likely want to terminate the string before any line breaking is done. 942de0328aeSDaniel Jasper if (Current.IsUnterminatedLiteral) 943de0328aeSDaniel Jasper return 0; 944de0328aeSDaniel Jasper 94581e3294eSAlexander Kornienko StringRef Text = Current.TokenText; 94681e3294eSAlexander Kornienko StringRef Prefix; 94781e3294eSAlexander Kornienko StringRef Postfix; 948174b0125SDaniel Jasper bool IsNSStringLiteral = false; 94981e3294eSAlexander Kornienko // FIXME: Handle whitespace between '_T', '(', '"..."', and ')'. 95081e3294eSAlexander Kornienko // FIXME: Store Prefix and Suffix (or PrefixLength and SuffixLength to 95181e3294eSAlexander Kornienko // reduce the overhead) for each FormatToken, which is a string, so that we 95281e3294eSAlexander Kornienko // don't run multiple checks here on the hot path. 953174b0125SDaniel Jasper if (Text.startswith("\"") && Current.Previous && 954174b0125SDaniel Jasper Current.Previous->is(tok::at)) { 955174b0125SDaniel Jasper IsNSStringLiteral = true; 956174b0125SDaniel Jasper Prefix = "@\""; 957174b0125SDaniel Jasper } 95881e3294eSAlexander Kornienko if ((Text.endswith(Postfix = "\"") && 959174b0125SDaniel Jasper (IsNSStringLiteral || Text.startswith(Prefix = "\"") || 960174b0125SDaniel Jasper Text.startswith(Prefix = "u\"") || Text.startswith(Prefix = "U\"") || 961174b0125SDaniel Jasper Text.startswith(Prefix = "u8\"") || 96281e3294eSAlexander Kornienko Text.startswith(Prefix = "L\""))) || 963732b6bd4SAlexander Kornienko (Text.startswith(Prefix = "_T(\"") && Text.endswith(Postfix = "\")"))) { 9643c3d09c8SAlexander Kornienko Token.reset(new BreakableStringLiteral( 9653c3d09c8SAlexander Kornienko Current, State.Line->Level, StartColumn, Prefix, Postfix, 9663c3d09c8SAlexander Kornienko State.Line->InPPDirective, Encoding, Style)); 96781e3294eSAlexander Kornienko } else { 96881e3294eSAlexander Kornienko return 0; 96981e3294eSAlexander Kornienko } 970a98b7b01SDaniel Jasper } else if (Current.is(TT_BlockComment) && Current.isTrailingComment()) { 971ce9161a5SAlexander Kornienko if (CommentPragmasRegex.match(Current.TokenText.substr(2))) 972ce9161a5SAlexander Kornienko return 0; 973de0328aeSDaniel Jasper Token.reset(new BreakableBlockComment( 9743c3d09c8SAlexander Kornienko Current, State.Line->Level, StartColumn, Current.OriginalColumn, 9753c3d09c8SAlexander Kornienko !Current.Previous, State.Line->InPPDirective, Encoding, Style)); 976a98b7b01SDaniel Jasper } else if (Current.is(TT_LineComment) && 9772145bc02SCraig Topper (Current.Previous == nullptr || 978a98b7b01SDaniel Jasper Current.Previous->isNot(TT_ImplicitStringLiteral))) { 979ce9161a5SAlexander Kornienko if (CommentPragmasRegex.match(Current.TokenText.substr(2))) 980ce9161a5SAlexander Kornienko return 0; 9813c3d09c8SAlexander Kornienko Token.reset(new BreakableLineComment(Current, State.Line->Level, 9823abbb8a4SAlexander Kornienko StartColumn, /*InPPDirective=*/false, 9833c3d09c8SAlexander Kornienko Encoding, Style)); 9843abbb8a4SAlexander Kornienko // We don't insert backslashes when breaking line comments. 9853abbb8a4SAlexander Kornienko ColumnLimit = Style.ColumnLimit; 986de0328aeSDaniel Jasper } else { 987de0328aeSDaniel Jasper return 0; 988de0328aeSDaniel Jasper } 9893abbb8a4SAlexander Kornienko if (Current.UnbreakableTailLength >= ColumnLimit) 990de0328aeSDaniel Jasper return 0; 991de0328aeSDaniel Jasper 9923abbb8a4SAlexander Kornienko unsigned RemainingSpace = ColumnLimit - Current.UnbreakableTailLength; 993de0328aeSDaniel Jasper bool BreakInserted = false; 994de0328aeSDaniel Jasper unsigned Penalty = 0; 995de0328aeSDaniel Jasper unsigned RemainingTokenColumns = 0; 996de0328aeSDaniel Jasper for (unsigned LineIndex = 0, EndIndex = Token->getLineCount(); 997de0328aeSDaniel Jasper LineIndex != EndIndex; ++LineIndex) { 998de0328aeSDaniel Jasper if (!DryRun) 999de0328aeSDaniel Jasper Token->replaceWhitespaceBefore(LineIndex, Whitespaces); 1000de0328aeSDaniel Jasper unsigned TailOffset = 0; 1001de0328aeSDaniel Jasper RemainingTokenColumns = 1002de0328aeSDaniel Jasper Token->getLineLengthAfterSplit(LineIndex, TailOffset, StringRef::npos); 1003de0328aeSDaniel Jasper while (RemainingTokenColumns > RemainingSpace) { 1004de0328aeSDaniel Jasper BreakableToken::Split Split = 10053abbb8a4SAlexander Kornienko Token->getSplit(LineIndex, TailOffset, ColumnLimit); 1006de0328aeSDaniel Jasper if (Split.first == StringRef::npos) { 1007de0328aeSDaniel Jasper // The last line's penalty is handled in addNextStateToQueue(). 1008de0328aeSDaniel Jasper if (LineIndex < EndIndex - 1) 1009de0328aeSDaniel Jasper Penalty += Style.PenaltyExcessCharacter * 1010de0328aeSDaniel Jasper (RemainingTokenColumns - RemainingSpace); 1011de0328aeSDaniel Jasper break; 1012de0328aeSDaniel Jasper } 1013de0328aeSDaniel Jasper assert(Split.first != 0); 1014de0328aeSDaniel Jasper unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit( 1015de0328aeSDaniel Jasper LineIndex, TailOffset + Split.first + Split.second, StringRef::npos); 1016875395f9SAlexander Kornienko 1017875395f9SAlexander Kornienko // We can remove extra whitespace instead of breaking the line. 1018875395f9SAlexander Kornienko if (RemainingTokenColumns + 1 - Split.second <= RemainingSpace) { 1019875395f9SAlexander Kornienko RemainingTokenColumns = 0; 1020875395f9SAlexander Kornienko if (!DryRun) 1021875395f9SAlexander Kornienko Token->replaceWhitespace(LineIndex, TailOffset, Split, Whitespaces); 1022875395f9SAlexander Kornienko break; 1023875395f9SAlexander Kornienko } 1024875395f9SAlexander Kornienko 102564a42b8dSAlexander Kornienko // When breaking before a tab character, it may be moved by a few columns, 102664a42b8dSAlexander Kornienko // but will still be expanded to the next tab stop, so we don't save any 102764a42b8dSAlexander Kornienko // columns. 102864a42b8dSAlexander Kornienko if (NewRemainingTokenColumns == RemainingTokenColumns) 102964a42b8dSAlexander Kornienko break; 103064a42b8dSAlexander Kornienko 1031de0328aeSDaniel Jasper assert(NewRemainingTokenColumns < RemainingTokenColumns); 1032de0328aeSDaniel Jasper if (!DryRun) 1033de0328aeSDaniel Jasper Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces); 10342739af3bSDaniel Jasper Penalty += Current.SplitPenalty; 1035de0328aeSDaniel Jasper unsigned ColumnsUsed = 1036de0328aeSDaniel Jasper Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first); 10373abbb8a4SAlexander Kornienko if (ColumnsUsed > ColumnLimit) { 10383abbb8a4SAlexander Kornienko Penalty += Style.PenaltyExcessCharacter * (ColumnsUsed - ColumnLimit); 1039de0328aeSDaniel Jasper } 1040de0328aeSDaniel Jasper TailOffset += Split.first + Split.second; 1041de0328aeSDaniel Jasper RemainingTokenColumns = NewRemainingTokenColumns; 1042de0328aeSDaniel Jasper BreakInserted = true; 1043de0328aeSDaniel Jasper } 1044de0328aeSDaniel Jasper } 1045de0328aeSDaniel Jasper 1046de0328aeSDaniel Jasper State.Column = RemainingTokenColumns; 1047de0328aeSDaniel Jasper 1048de0328aeSDaniel Jasper if (BreakInserted) { 1049de0328aeSDaniel Jasper // If we break the token inside a parameter list, we need to break before 1050de0328aeSDaniel Jasper // the next parameter on all levels, so that the next parameter is clearly 1051de0328aeSDaniel Jasper // visible. Line comments already introduce a break. 1052a98b7b01SDaniel Jasper if (Current.isNot(TT_LineComment)) { 1053de0328aeSDaniel Jasper for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 1054de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 1055de0328aeSDaniel Jasper } 1056de0328aeSDaniel Jasper 105704b6a081SDaniel Jasper Penalty += Current.isStringLiteral() ? Style.PenaltyBreakString 10582739af3bSDaniel Jasper : Style.PenaltyBreakComment; 10592739af3bSDaniel Jasper 1060de0328aeSDaniel Jasper State.Stack.back().LastSpace = StartColumn; 1061de0328aeSDaniel Jasper } 1062de0328aeSDaniel Jasper return Penalty; 1063de0328aeSDaniel Jasper } 1064de0328aeSDaniel Jasper 10659fe0e8daSDaniel Jasper unsigned ContinuationIndenter::getColumnLimit(const LineState &State) const { 1066de0328aeSDaniel Jasper // In preprocessor directives reserve two chars for trailing " \" 10679fe0e8daSDaniel Jasper return Style.ColumnLimit - (State.Line->InPPDirective ? 2 : 0); 1068de0328aeSDaniel Jasper } 1069de0328aeSDaniel Jasper 1070c39b56feSDaniel Jasper bool ContinuationIndenter::nextIsMultilineString(const LineState &State) { 1071f438cb76SDaniel Jasper const FormatToken &Current = *State.NextToken; 1072a98b7b01SDaniel Jasper if (!Current.isStringLiteral() || Current.is(TT_ImplicitStringLiteral)) 1073f438cb76SDaniel Jasper return false; 1074d7b837e7SAlexander Kornienko // We never consider raw string literals "multiline" for the purpose of 1075c39b56feSDaniel Jasper // AlwaysBreakBeforeMultilineStrings implementation as they are special-cased 1076c39b56feSDaniel Jasper // (see TokenAnnotator::mustBreakBefore(). 1077d7b837e7SAlexander Kornienko if (Current.TokenText.startswith("R\"")) 1078d7b837e7SAlexander Kornienko return false; 107939856b71SAlexander Kornienko if (Current.IsMultiline) 1080d7b837e7SAlexander Kornienko return true; 1081f438cb76SDaniel Jasper if (Current.getNextNonComment() && 108204b6a081SDaniel Jasper Current.getNextNonComment()->isStringLiteral()) 1083f438cb76SDaniel Jasper return true; // Implicit concatenation. 108439856b71SAlexander Kornienko if (State.Column + Current.ColumnWidth + Current.UnbreakableTailLength > 1085f438cb76SDaniel Jasper Style.ColumnLimit) 1086f438cb76SDaniel Jasper return true; // String will be split. 1087d7b837e7SAlexander Kornienko return false; 1088f438cb76SDaniel Jasper } 1089f438cb76SDaniel Jasper 1090de0328aeSDaniel Jasper } // namespace format 1091de0328aeSDaniel Jasper } // namespace clang 1092