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) && 1118f59ae53SDaniel Jasper State.LowestLevelOnLine < State.StartOfLineLevel) 112de0328aeSDaniel Jasper return false; 1134c6e0059SDaniel Jasper if (Current.isMemberAccess() && State.Stack.back().ContainsUnwrappedBuilder) 1144c6e0059SDaniel Jasper return false; 115de0328aeSDaniel Jasper return !State.Stack.back().NoLineBreak; 116de0328aeSDaniel Jasper } 117de0328aeSDaniel Jasper 118de0328aeSDaniel Jasper bool ContinuationIndenter::mustBreak(const LineState &State) { 119de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 120de0328aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 121de0328aeSDaniel Jasper if (Current.MustBreakBefore || Current.Type == TT_InlineASMColon) 122de0328aeSDaniel Jasper return true; 1231db6c386SDaniel Jasper if (State.Stack.back().BreakBeforeClosingBrace && 1241db6c386SDaniel Jasper Current.closesBlockTypeList(Style)) 125de0328aeSDaniel Jasper return true; 126de0328aeSDaniel Jasper if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection) 127de0328aeSDaniel Jasper return true; 128ec01cd6eSDaniel Jasper if ((startsNextParameter(Current, Style) || Previous.is(tok::semi) || 129165b29e2SDaniel Jasper (Style.BreakBeforeTernaryOperators && 130165b29e2SDaniel Jasper (Current.is(tok::question) || (Current.Type == TT_ConditionalExpr && 131165b29e2SDaniel Jasper Previous.isNot(tok::question)))) || 132165b29e2SDaniel Jasper (!Style.BreakBeforeTernaryOperators && 133165b29e2SDaniel Jasper (Previous.is(tok::question) || Previous.Type == TT_ConditionalExpr))) && 134de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter && !Current.isTrailingComment() && 135de0328aeSDaniel Jasper !Current.isOneOf(tok::r_paren, tok::r_brace)) 136de0328aeSDaniel Jasper return true; 137de0328aeSDaniel Jasper if (Style.AlwaysBreakBeforeMultilineStrings && 138f438cb76SDaniel Jasper State.Column > State.Stack.back().Indent && // Breaking saves columns. 13927943058SDaniel Jasper !Previous.isOneOf(tok::kw_return, tok::lessless, tok::at) && 140c39b56feSDaniel Jasper Previous.Type != TT_InlineASMColon && nextIsMultilineString(State)) 141de0328aeSDaniel Jasper return true; 142b596fb2bSDaniel Jasper if (((Previous.Type == TT_DictLiteral && Previous.is(tok::l_brace)) || 1431db6c386SDaniel Jasper Previous.Type == TT_ArrayInitializerLSquare) && 144db8804b3SDaniel Jasper Style.ColumnLimit > 0 && 145d489dd34SDaniel Jasper getLengthToMatchingParen(Previous) + State.Column > getColumnLimit(State)) 146d489dd34SDaniel Jasper return true; 1475d2587daSDaniel Jasper if (Current.Type == TT_CtorInitializerColon && 148d74cf403SDaniel Jasper ((Style.AllowShortFunctionsOnASingleLine != FormatStyle::SFS_All) || 1495d2587daSDaniel Jasper Style.BreakConstructorInitializersBeforeComma || Style.ColumnLimit != 0)) 1505d2587daSDaniel Jasper return true; 151de0328aeSDaniel Jasper 1525d2587daSDaniel Jasper if (State.Column < getNewLineColumn(State)) 1535d2587daSDaniel Jasper return false; 154de0328aeSDaniel Jasper if (!Style.BreakBeforeBinaryOperators) { 155de0328aeSDaniel Jasper // If we need to break somewhere inside the LHS of a binary expression, we 156de0328aeSDaniel Jasper // should also break after the operator. Otherwise, the formatting would 157de0328aeSDaniel Jasper // hide the operator precedence, e.g. in: 158de0328aeSDaniel Jasper // if (aaaaaaaaaaaaaa == 159de0328aeSDaniel Jasper // bbbbbbbbbbbbbb && c) {.. 160de0328aeSDaniel Jasper // For comparisons, we only apply this rule, if the LHS is a binary 161de0328aeSDaniel Jasper // expression itself as otherwise, the line breaks seem superfluous. 162de0328aeSDaniel Jasper // We need special cases for ">>" which we have split into two ">" while 163de0328aeSDaniel Jasper // lexing in order to make template parsing easier. 164de0328aeSDaniel Jasper // 165de0328aeSDaniel Jasper // FIXME: We'll need something similar for styles that break before binary 166de0328aeSDaniel Jasper // operators. 167de0328aeSDaniel Jasper bool IsComparison = (Previous.getPrecedence() == prec::Relational || 168de0328aeSDaniel Jasper Previous.getPrecedence() == prec::Equality) && 169de0328aeSDaniel Jasper Previous.Previous && 170de0328aeSDaniel Jasper Previous.Previous->Type != TT_BinaryOperator; // For >>. 171de0328aeSDaniel Jasper bool LHSIsBinaryExpr = 172562ecd44SDaniel Jasper Previous.Previous && Previous.Previous->EndsBinaryExpression; 173de0328aeSDaniel Jasper if (Previous.Type == TT_BinaryOperator && 174de0328aeSDaniel Jasper (!IsComparison || LHSIsBinaryExpr) && 175de0328aeSDaniel Jasper Current.Type != TT_BinaryOperator && // For >>. 176c0d606a5SDaniel Jasper !Current.isTrailingComment() && !Previous.is(tok::lessless) && 177de0328aeSDaniel Jasper Previous.getPrecedence() != prec::Assignment && 178de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter) 179de0328aeSDaniel Jasper return true; 180de0328aeSDaniel Jasper } 181de0328aeSDaniel Jasper 182de0328aeSDaniel Jasper // Same as above, but for the first "<<" operator. 18386b2dfdcSAlexander Kornienko if (Current.is(tok::lessless) && Current.Type != TT_OverloadedOperator && 18486b2dfdcSAlexander Kornienko State.Stack.back().BreakBeforeParameter && 185de0328aeSDaniel Jasper State.Stack.back().FirstLessLess == 0) 186de0328aeSDaniel Jasper return true; 187de0328aeSDaniel Jasper 188de0328aeSDaniel Jasper if (Current.Type == TT_ObjCSelectorName && 189b88b25feSDaniel Jasper State.Stack.back().ObjCSelectorNameFound && 190de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter) 191de0328aeSDaniel Jasper return true; 19205cd5868SDaniel Jasper if (Previous.ClosesTemplateDeclaration && Current.NestingLevel == 0 && 193a594ba8aSAlexander Kornienko !Current.isTrailingComment()) 194de0328aeSDaniel Jasper return true; 195de0328aeSDaniel Jasper 196de0328aeSDaniel Jasper if ((Current.Type == TT_StartOfName || Current.is(tok::kw_operator)) && 1979fe0e8daSDaniel Jasper State.Line->MightBeFunctionDecl && 19805cd5868SDaniel Jasper State.Stack.back().BreakBeforeParameter && Current.NestingLevel == 0) 199de0328aeSDaniel Jasper return true; 2004c6e0059SDaniel Jasper if (startsSegmentOfBuilderTypeCall(Current) && 201f8151e9bSDaniel Jasper (State.Stack.back().CallContinuation != 0 || 202f8151e9bSDaniel Jasper (State.Stack.back().BreakBeforeParameter && 203f8151e9bSDaniel Jasper State.Stack.back().ContainsUnwrappedBuilder))) 2044c6e0059SDaniel Jasper return true; 2059697281eSDaniel Jasper 2069697281eSDaniel Jasper // The following could be precomputed as they do not depend on the state. 2079697281eSDaniel Jasper // However, as they should take effect only if the UnwrappedLine does not fit 2089697281eSDaniel Jasper // into the ColumnLimit, they are checked here in the ContinuationIndenter. 20935995679SDaniel Jasper if (Style.ColumnLimit != 0 && Previous.BlockKind == BK_Block && 21035995679SDaniel Jasper Previous.is(tok::l_brace) && !Current.isOneOf(tok::r_brace, tok::comment)) 2119697281eSDaniel Jasper return true; 2129697281eSDaniel Jasper 213de0328aeSDaniel Jasper return false; 214de0328aeSDaniel Jasper } 215de0328aeSDaniel Jasper 216de0328aeSDaniel Jasper unsigned ContinuationIndenter::addTokenToState(LineState &State, bool Newline, 2178de9ed05SDaniel Jasper bool DryRun, 2188de9ed05SDaniel Jasper unsigned ExtraSpaces) { 219de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 220de0328aeSDaniel Jasper 221819788daSManuel Klimek assert(!State.Stack.empty()); 222819788daSManuel Klimek if ((Current.Type == TT_ImplicitStringLiteral && 2232145bc02SCraig Topper (Current.Previous->Tok.getIdentifierInfo() == nullptr || 2249885784dSDaniel Jasper Current.Previous->Tok.getIdentifierInfo()->getPPKeywordID() == 2259885784dSDaniel Jasper tok::pp_not_keyword))) { 226de0328aeSDaniel Jasper // FIXME: Is this correct? 227de0328aeSDaniel Jasper int WhitespaceLength = SourceMgr.getSpellingColumnNumber( 228de0328aeSDaniel Jasper State.NextToken->WhitespaceRange.getEnd()) - 229de0328aeSDaniel Jasper SourceMgr.getSpellingColumnNumber( 230de0328aeSDaniel Jasper State.NextToken->WhitespaceRange.getBegin()); 231da353cd5SDaniel Jasper State.Column += WhitespaceLength; 232240dfda3SDaniel Jasper moveStateToNextToken(State, DryRun, /*Newline=*/false); 233de0328aeSDaniel Jasper return 0; 234de0328aeSDaniel Jasper } 235de0328aeSDaniel Jasper 2361f80396dSAlexander Kornienko unsigned Penalty = 0; 2371f80396dSAlexander Kornienko if (Newline) 2381f80396dSAlexander Kornienko Penalty = addTokenOnNewLine(State, DryRun); 2391f80396dSAlexander Kornienko else 24048437ce5SDaniel Jasper addTokenOnCurrentLine(State, DryRun, ExtraSpaces); 2411f80396dSAlexander Kornienko 2421f80396dSAlexander Kornienko return moveStateToNextToken(State, DryRun, Newline) + Penalty; 2431f80396dSAlexander Kornienko } 2441f80396dSAlexander Kornienko 24548437ce5SDaniel Jasper void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun, 2461f80396dSAlexander Kornienko unsigned ExtraSpaces) { 24771814b44SManuel Klimek FormatToken &Current = *State.NextToken; 2481f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 2491f80396dSAlexander Kornienko if (Current.is(tok::equal) && 25005cd5868SDaniel Jasper (State.Line->First->is(tok::kw_for) || Current.NestingLevel == 0) && 2511f80396dSAlexander Kornienko State.Stack.back().VariablePos == 0) { 2521f80396dSAlexander Kornienko State.Stack.back().VariablePos = State.Column; 2531f80396dSAlexander Kornienko // Move over * and & if they are bound to the variable name. 2541f80396dSAlexander Kornienko const FormatToken *Tok = &Previous; 2551f80396dSAlexander Kornienko while (Tok && State.Stack.back().VariablePos >= Tok->ColumnWidth) { 2561f80396dSAlexander Kornienko State.Stack.back().VariablePos -= Tok->ColumnWidth; 2571f80396dSAlexander Kornienko if (Tok->SpacesRequiredBefore != 0) 2581f80396dSAlexander Kornienko break; 2591f80396dSAlexander Kornienko Tok = Tok->Previous; 2601f80396dSAlexander Kornienko } 2611f80396dSAlexander Kornienko if (Previous.PartOfMultiVariableDeclStmt) 2621f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Stack.back().VariablePos; 2631f80396dSAlexander Kornienko } 2641f80396dSAlexander Kornienko 2651f80396dSAlexander Kornienko unsigned Spaces = Current.SpacesRequiredBefore + ExtraSpaces; 2661f80396dSAlexander Kornienko 2671f80396dSAlexander Kornienko if (!DryRun) 2681f80396dSAlexander Kornienko Whitespaces.replaceWhitespace(Current, /*Newlines=*/0, /*IndentLevel=*/0, 2691f80396dSAlexander Kornienko Spaces, State.Column + Spaces); 2701f80396dSAlexander Kornienko 271b88b25feSDaniel Jasper if (Current.Type == TT_ObjCSelectorName && 272b88b25feSDaniel Jasper !State.Stack.back().ObjCSelectorNameFound) { 273b88b25feSDaniel Jasper if (Current.LongestObjCSelectorName == 0) 274b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 275b88b25feSDaniel Jasper else if (State.Stack.back().Indent + Current.LongestObjCSelectorName > 2761f80396dSAlexander Kornienko State.Column + Spaces + Current.ColumnWidth) 2771f80396dSAlexander Kornienko State.Stack.back().ColonPos = 2781f80396dSAlexander Kornienko State.Stack.back().Indent + Current.LongestObjCSelectorName; 2791f80396dSAlexander Kornienko else 2801f80396dSAlexander Kornienko State.Stack.back().ColonPos = State.Column + Spaces + Current.ColumnWidth; 2811f80396dSAlexander Kornienko } 2821f80396dSAlexander Kornienko 2831f80396dSAlexander Kornienko if (Previous.opensScope() && Previous.Type != TT_ObjCMethodExpr && 2845a611397SDaniel Jasper (Current.Type != TT_LineComment || Previous.BlockKind == BK_BracedInit)) 2851f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column + Spaces; 286ec01cd6eSDaniel Jasper if (State.Stack.back().AvoidBinPacking && startsNextParameter(Current, Style)) 2871f80396dSAlexander Kornienko State.Stack.back().NoLineBreak = true; 2881f80396dSAlexander Kornienko if (startsSegmentOfBuilderTypeCall(Current)) 2891f80396dSAlexander Kornienko State.Stack.back().ContainsUnwrappedBuilder = true; 2901f80396dSAlexander Kornienko 2911f80396dSAlexander Kornienko State.Column += Spaces; 2928acf822bSDaniel Jasper if (Current.isNot(tok::comment) && Previous.is(tok::l_paren) && 2938acf822bSDaniel Jasper Previous.Previous && Previous.Previous->isOneOf(tok::kw_if, tok::kw_for)) 2941f80396dSAlexander Kornienko // Treat the condition inside an if as if it was a second function 2956633ab8aSDaniel Jasper // parameter, i.e. let nested calls have a continuation indent. 2968acf822bSDaniel Jasper State.Stack.back().LastSpace = State.Column; 297b88b25feSDaniel Jasper else if (Current.isNot(tok::comment) && 298b88b25feSDaniel Jasper (Previous.is(tok::comma) || 299b88b25feSDaniel Jasper (Previous.is(tok::colon) && Previous.Type == TT_ObjCMethodExpr))) 3001f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 3011f80396dSAlexander Kornienko else if ((Previous.Type == TT_BinaryOperator || 3021f80396dSAlexander Kornienko Previous.Type == TT_ConditionalExpr || 3031f80396dSAlexander Kornienko Previous.Type == TT_CtorInitializerColon) && 3040e61784aSDaniel Jasper ((Previous.getPrecedence() != prec::Assignment && 3050e61784aSDaniel Jasper (Previous.isNot(tok::lessless) || Previous.OperatorIndex != 0 || 3060e61784aSDaniel Jasper !Previous.LastOperator)) || 3071f80396dSAlexander Kornienko Current.StartsBinaryExpression)) 3081f80396dSAlexander Kornienko // Always indent relative to the RHS of the expression unless this is a 3091f80396dSAlexander Kornienko // simple assignment without binary expression on the RHS. Also indent 3101f80396dSAlexander Kornienko // relative to unary operators and the colons of constructor initializers. 3111f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 312f9a5e404SDaniel Jasper else if (Previous.Type == TT_InheritanceColon) { 3131f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column; 314f9a5e404SDaniel Jasper State.Stack.back().LastSpace = State.Column; 315f9a5e404SDaniel Jasper } else if (Previous.opensScope()) { 3161f80396dSAlexander Kornienko // If a function has a trailing call, indent all parameters from the 3171f80396dSAlexander Kornienko // opening parenthesis. This avoids confusing indents like: 3181f80396dSAlexander Kornienko // OuterFunction(InnerFunctionCall( // break 3191f80396dSAlexander Kornienko // ParameterToInnerFunction)) // break 3201f80396dSAlexander Kornienko // .SecondInnerFunctionCall(); 3211f80396dSAlexander Kornienko bool HasTrailingCall = false; 3221f80396dSAlexander Kornienko if (Previous.MatchingParen) { 3231f80396dSAlexander Kornienko const FormatToken *Next = Previous.MatchingParen->getNextNonComment(); 3241f80396dSAlexander Kornienko HasTrailingCall = Next && Next->isMemberAccess(); 3251f80396dSAlexander Kornienko } 3261f80396dSAlexander Kornienko if (HasTrailingCall && 3271f80396dSAlexander Kornienko State.Stack[State.Stack.size() - 2].CallContinuation == 0) 3281f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 3291f80396dSAlexander Kornienko } 3301f80396dSAlexander Kornienko } 3311f80396dSAlexander Kornienko 3321f80396dSAlexander Kornienko unsigned ContinuationIndenter::addTokenOnNewLine(LineState &State, 3331f80396dSAlexander Kornienko bool DryRun) { 33471814b44SManuel Klimek FormatToken &Current = *State.NextToken; 3351f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 3369f388d04SDaniel Jasper 3371f80396dSAlexander Kornienko // Extra penalty that needs to be added because of the way certain line 3381f80396dSAlexander Kornienko // breaks are chosen. 3391f80396dSAlexander Kornienko unsigned Penalty = 0; 3401f80396dSAlexander Kornienko 341a0407740SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 342a0407740SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 343a0407740SDaniel Jasper if (!NextNonComment) 344a0407740SDaniel Jasper NextNonComment = &Current; 34505cd5868SDaniel Jasper // The first line break on any NestingLevel causes an extra penalty in order 3468de9ed05SDaniel Jasper // prefer similar line breaks. 3478de9ed05SDaniel Jasper if (!State.Stack.back().ContainsLineBreak) 3488de9ed05SDaniel Jasper Penalty += 15; 3498de9ed05SDaniel Jasper State.Stack.back().ContainsLineBreak = true; 3508de9ed05SDaniel Jasper 3518de9ed05SDaniel Jasper Penalty += State.NextToken->SplitPenalty; 3528de9ed05SDaniel Jasper 353de0328aeSDaniel Jasper // Breaking before the first "<<" is generally not desirable if the LHS is 35448437ce5SDaniel Jasper // short. Also always add the penalty if the LHS is split over mutliple lines 3552b7556ecSDaniel Jasper // to avoid unnecessary line breaks that just work around this penalty. 356a0407740SDaniel Jasper if (NextNonComment->is(tok::lessless) && 357a0407740SDaniel Jasper State.Stack.back().FirstLessLess == 0 && 358004177eeSDaniel Jasper (State.Column <= Style.ColumnLimit / 3 || 35948437ce5SDaniel Jasper State.Stack.back().BreakBeforeParameter)) 3608de9ed05SDaniel Jasper Penalty += Style.PenaltyBreakFirstLessLess; 361de0328aeSDaniel Jasper 3629f388d04SDaniel Jasper State.Column = getNewLineColumn(State); 3639f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 3649f388d04SDaniel Jasper if (State.Stack.back().CallContinuation == 0) 365de0328aeSDaniel Jasper State.Stack.back().CallContinuation = State.Column; 366a0407740SDaniel Jasper } else if (NextNonComment->Type == TT_ObjCSelectorName) { 367b88b25feSDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 368a0407740SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) { 369b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 370b88b25feSDaniel Jasper } else { 371b302f9a0SDaniel Jasper State.Stack.back().ColonPos = 372a0407740SDaniel Jasper State.Stack.back().Indent + NextNonComment->LongestObjCSelectorName; 373b88b25feSDaniel Jasper } 3749f388d04SDaniel Jasper } else if (State.Stack.back().AlignColons && 3759f388d04SDaniel Jasper State.Stack.back().ColonPos <= NextNonComment->ColumnWidth) { 376a0407740SDaniel Jasper State.Stack.back().ColonPos = State.Column + NextNonComment->ColumnWidth; 377de0328aeSDaniel Jasper } 3781fd6f1f8SDaniel Jasper } else if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 3791fd6f1f8SDaniel Jasper (PreviousNonComment->Type == TT_ObjCMethodExpr || 3801fd6f1f8SDaniel Jasper PreviousNonComment->Type == TT_DictLiteral)) { 381b88b25feSDaniel Jasper // FIXME: This is hacky, find a better way. The problem is that in an ObjC 382b88b25feSDaniel Jasper // method expression, the block should be aligned to the line starting it, 383b88b25feSDaniel Jasper // e.g.: 384b88b25feSDaniel Jasper // [aaaaaaaaaaaaaaa aaaaaaaaa: \\ break for some reason 385b88b25feSDaniel Jasper // ^(int *i) { 386b88b25feSDaniel Jasper // // ... 387b88b25feSDaniel Jasper // }]; 38805cd5868SDaniel Jasper // Thus, we set LastSpace of the next higher NestingLevel, to which we move 389b88b25feSDaniel Jasper // when we consume all of the "}"'s FakeRParens at the "{". 3909a26e773SDaniel Jasper if (State.Stack.size() > 1) 3919f388d04SDaniel Jasper State.Stack[State.Stack.size() - 2].LastSpace = 3929f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 3939f388d04SDaniel Jasper Style.ContinuationIndentWidth; 394de0328aeSDaniel Jasper } 395de0328aeSDaniel Jasper 396de0328aeSDaniel Jasper if ((Previous.isOneOf(tok::comma, tok::semi) && 397de0328aeSDaniel Jasper !State.Stack.back().AvoidBinPacking) || 398de0328aeSDaniel Jasper Previous.Type == TT_BinaryOperator) 399de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 40005cd5868SDaniel Jasper if (Previous.Type == TT_TemplateCloser && Current.NestingLevel == 0) 401de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 402a0407740SDaniel Jasper if (NextNonComment->is(tok::question) || 403165b29e2SDaniel Jasper (PreviousNonComment && PreviousNonComment->is(tok::question))) 404165b29e2SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 405de0328aeSDaniel Jasper 406de0328aeSDaniel Jasper if (!DryRun) { 4073c3d09c8SAlexander Kornienko unsigned Newlines = 1; 408de0328aeSDaniel Jasper if (Current.is(tok::comment)) 4093c3d09c8SAlexander Kornienko Newlines = std::max(Newlines, std::min(Current.NewlinesBefore, 410de0328aeSDaniel Jasper Style.MaxEmptyLinesToKeep + 1)); 411e2e0387fSAlexander Kornienko Whitespaces.replaceWhitespace(Current, Newlines, 412e2e0387fSAlexander Kornienko State.Stack.back().IndentLevel, State.Column, 413e2e0387fSAlexander Kornienko State.Column, State.Line->InPPDirective); 414de0328aeSDaniel Jasper } 415de0328aeSDaniel Jasper 416de0328aeSDaniel Jasper if (!Current.isTrailingComment()) 417de0328aeSDaniel Jasper State.Stack.back().LastSpace = State.Column; 41805cd5868SDaniel Jasper State.StartOfLineLevel = Current.NestingLevel; 41905cd5868SDaniel Jasper State.LowestLevelOnLine = Current.NestingLevel; 420de0328aeSDaniel Jasper 421de0328aeSDaniel Jasper // Any break on this level means that the parent level has been broken 422de0328aeSDaniel Jasper // and we need to avoid bin packing there. 423b16b969dSDaniel Jasper bool JavaScriptFormat = Style.Language == FormatStyle::LK_JavaScript && 424b16b969dSDaniel Jasper Current.is(tok::r_brace) && 425b16b969dSDaniel Jasper State.Stack.size() > 1 && 426b16b969dSDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined; 427b16b969dSDaniel Jasper if (!JavaScriptFormat) { 428de0328aeSDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { 429de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 430de0328aeSDaniel Jasper } 431b16b969dSDaniel Jasper } 432b16b969dSDaniel Jasper 4339e5ede0fSDaniel Jasper if (PreviousNonComment && 4349e5ede0fSDaniel Jasper !PreviousNonComment->isOneOf(tok::comma, tok::semi) && 4359e5ede0fSDaniel Jasper PreviousNonComment->Type != TT_TemplateCloser && 4369e5ede0fSDaniel Jasper PreviousNonComment->Type != TT_BinaryOperator && 437b05a81deSDaniel Jasper Current.Type != TT_BinaryOperator && !PreviousNonComment->opensScope()) 438de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 439de0328aeSDaniel Jasper 4401db6c386SDaniel Jasper // If we break after { or the [ of an array initializer, we should also break 4411db6c386SDaniel Jasper // before the corresponding } or ]. 4421db6c386SDaniel Jasper if (Previous.is(tok::l_brace) || Previous.Type == TT_ArrayInitializerLSquare) 443de0328aeSDaniel Jasper State.Stack.back().BreakBeforeClosingBrace = true; 444de0328aeSDaniel Jasper 445de0328aeSDaniel Jasper if (State.Stack.back().AvoidBinPacking) { 446de0328aeSDaniel Jasper // If we are breaking after '(', '{', '<', this is not bin packing 4472a958321SDaniel Jasper // unless AllowAllParametersOfDeclarationOnNextLine is false or this is a 4482a958321SDaniel Jasper // dict/object literal. 449de0328aeSDaniel Jasper if (!(Previous.isOneOf(tok::l_paren, tok::l_brace) || 450de0328aeSDaniel Jasper Previous.Type == TT_BinaryOperator) || 451de0328aeSDaniel Jasper (!Style.AllowAllParametersOfDeclarationOnNextLine && 4522a958321SDaniel Jasper State.Line->MustBeDeclaration) || 4532a958321SDaniel Jasper Previous.Type == TT_DictLiteral) 454de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 455de0328aeSDaniel Jasper } 456de0328aeSDaniel Jasper 4571f80396dSAlexander Kornienko return Penalty; 458de0328aeSDaniel Jasper } 459de0328aeSDaniel Jasper 4609f388d04SDaniel Jasper unsigned ContinuationIndenter::getNewLineColumn(const LineState &State) { 4615d2587daSDaniel Jasper if (!State.NextToken || !State.NextToken->Previous) 4625d2587daSDaniel Jasper return 0; 4639f388d04SDaniel Jasper FormatToken &Current = *State.NextToken; 4649f388d04SDaniel Jasper const FormatToken &Previous = *State.NextToken->Previous; 4659f388d04SDaniel Jasper // If we are continuing an expression, we want to use the continuation indent. 4669f388d04SDaniel Jasper unsigned ContinuationIndent = 4679f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 4689f388d04SDaniel Jasper Style.ContinuationIndentWidth; 4699f388d04SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 4709f388d04SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 4719f388d04SDaniel Jasper if (!NextNonComment) 4729f388d04SDaniel Jasper NextNonComment = &Current; 473b05a81deSDaniel Jasper if (NextNonComment->is(tok::l_brace) && NextNonComment->BlockKind == BK_Block) 47405cd5868SDaniel Jasper return Current.NestingLevel == 0 ? State.FirstIndent 4759f388d04SDaniel Jasper : State.Stack.back().Indent; 4769f388d04SDaniel Jasper if (Current.isOneOf(tok::r_brace, tok::r_square)) { 477b16b969dSDaniel Jasper if (State.Stack.size() > 1 && 478b16b969dSDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined) 479b16b969dSDaniel Jasper return State.FirstIndent; 4809f388d04SDaniel Jasper if (Current.closesBlockTypeList(Style) || 4819f388d04SDaniel Jasper (Current.MatchingParen && 4829f388d04SDaniel Jasper Current.MatchingParen->BlockKind == BK_BracedInit)) 4839f388d04SDaniel Jasper return State.Stack[State.Stack.size() - 2].LastSpace; 4849f388d04SDaniel Jasper else 4859f388d04SDaniel Jasper return State.FirstIndent; 4869f388d04SDaniel Jasper } 487783bac6bSDaniel Jasper if (Current.is(tok::identifier) && Current.Next && 488783bac6bSDaniel Jasper Current.Next->Type == TT_DictLiteral) 489783bac6bSDaniel Jasper return State.Stack.back().Indent; 4909f388d04SDaniel Jasper if (NextNonComment->isStringLiteral() && State.StartOfStringLiteral != 0) 4919f388d04SDaniel Jasper return State.StartOfStringLiteral; 4929f388d04SDaniel Jasper if (NextNonComment->is(tok::lessless) && 4939f388d04SDaniel Jasper State.Stack.back().FirstLessLess != 0) 4949f388d04SDaniel Jasper return State.Stack.back().FirstLessLess; 4959f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 4969f388d04SDaniel Jasper if (State.Stack.back().CallContinuation == 0) { 4979f388d04SDaniel Jasper return ContinuationIndent; 4989f388d04SDaniel Jasper } else { 4999f388d04SDaniel Jasper return State.Stack.back().CallContinuation; 5009f388d04SDaniel Jasper } 5019f388d04SDaniel Jasper } 5029f388d04SDaniel Jasper if (State.Stack.back().QuestionColumn != 0 && 503c0d606a5SDaniel Jasper ((NextNonComment->is(tok::colon) && 504c0d606a5SDaniel Jasper NextNonComment->Type == TT_ConditionalExpr) || 5059f388d04SDaniel Jasper Previous.Type == TT_ConditionalExpr)) 5069f388d04SDaniel Jasper return State.Stack.back().QuestionColumn; 5079f388d04SDaniel Jasper if (Previous.is(tok::comma) && State.Stack.back().VariablePos != 0) 5089f388d04SDaniel Jasper return State.Stack.back().VariablePos; 5099f388d04SDaniel Jasper if ((PreviousNonComment && (PreviousNonComment->ClosesTemplateDeclaration || 5109f388d04SDaniel Jasper PreviousNonComment->Type == TT_AttributeParen)) || 5119f388d04SDaniel Jasper ((NextNonComment->Type == TT_StartOfName || 5129f388d04SDaniel Jasper NextNonComment->is(tok::kw_operator)) && 51305cd5868SDaniel Jasper Current.NestingLevel == 0 && 51405cd5868SDaniel Jasper (!Style.IndentFunctionDeclarationAfterType || 5159f388d04SDaniel Jasper State.Line->StartsDefinition))) 5169f388d04SDaniel Jasper return std::max(State.Stack.back().LastSpace, State.Stack.back().Indent); 5179f388d04SDaniel Jasper if (NextNonComment->Type == TT_ObjCSelectorName) { 5189f388d04SDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 5199f388d04SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) { 5209f388d04SDaniel Jasper return State.Stack.back().Indent; 5219f388d04SDaniel Jasper } else { 5229f388d04SDaniel Jasper return State.Stack.back().Indent + 5239f388d04SDaniel Jasper NextNonComment->LongestObjCSelectorName - 5249f388d04SDaniel Jasper NextNonComment->ColumnWidth; 5259f388d04SDaniel Jasper } 5269f388d04SDaniel Jasper } else if (!State.Stack.back().AlignColons) { 5279f388d04SDaniel Jasper return State.Stack.back().Indent; 5289f388d04SDaniel Jasper } else if (State.Stack.back().ColonPos > NextNonComment->ColumnWidth) { 5299f388d04SDaniel Jasper return State.Stack.back().ColonPos - NextNonComment->ColumnWidth; 5309f388d04SDaniel Jasper } else { 5319f388d04SDaniel Jasper return State.Stack.back().Indent; 5329f388d04SDaniel Jasper } 5339f388d04SDaniel Jasper } 5349f388d04SDaniel Jasper if (NextNonComment->Type == TT_ArraySubscriptLSquare) { 5359f388d04SDaniel Jasper if (State.Stack.back().StartOfArraySubscripts != 0) 5369f388d04SDaniel Jasper return State.Stack.back().StartOfArraySubscripts; 5379f388d04SDaniel Jasper else 5389f388d04SDaniel Jasper return ContinuationIndent; 5399f388d04SDaniel Jasper } 5409f388d04SDaniel Jasper if (NextNonComment->Type == TT_StartOfName || 5419f388d04SDaniel Jasper Previous.isOneOf(tok::coloncolon, tok::equal)) { 5429f388d04SDaniel Jasper return ContinuationIndent; 5439f388d04SDaniel Jasper } 5449f388d04SDaniel Jasper if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 5459f388d04SDaniel Jasper (PreviousNonComment->Type == TT_ObjCMethodExpr || 5469f388d04SDaniel Jasper PreviousNonComment->Type == TT_DictLiteral)) 5479f388d04SDaniel Jasper return ContinuationIndent; 5489f388d04SDaniel Jasper if (NextNonComment->Type == TT_CtorInitializerColon) 5499f388d04SDaniel Jasper return State.FirstIndent + Style.ConstructorInitializerIndentWidth; 5509f388d04SDaniel Jasper if (NextNonComment->Type == TT_CtorInitializerComma) 5519f388d04SDaniel Jasper return State.Stack.back().Indent; 5525d2587daSDaniel Jasper if (State.Stack.back().Indent == State.FirstIndent && PreviousNonComment && 5539f388d04SDaniel Jasper PreviousNonComment->isNot(tok::r_brace)) 5549f388d04SDaniel Jasper // Ensure that we fall back to the continuation indent width instead of 5559f388d04SDaniel Jasper // just flushing continuations left. 5569f388d04SDaniel Jasper return State.Stack.back().Indent + Style.ContinuationIndentWidth; 5579f388d04SDaniel Jasper return State.Stack.back().Indent; 5589f388d04SDaniel Jasper } 5599f388d04SDaniel Jasper 560de0328aeSDaniel Jasper unsigned ContinuationIndenter::moveStateToNextToken(LineState &State, 561de0328aeSDaniel Jasper bool DryRun, bool Newline) { 562de0328aeSDaniel Jasper assert(State.Stack.size()); 56360553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 564de0328aeSDaniel Jasper 565de0328aeSDaniel Jasper if (Current.Type == TT_InheritanceColon) 566de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 567c0d606a5SDaniel Jasper if (Current.is(tok::lessless) && Current.Type != TT_OverloadedOperator) { 568c0d606a5SDaniel Jasper if (State.Stack.back().FirstLessLess == 0) 569de0328aeSDaniel Jasper State.Stack.back().FirstLessLess = State.Column; 570c0d606a5SDaniel Jasper else 571c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 572c0d606a5SDaniel Jasper } 573c0d606a5SDaniel Jasper if ((Current.Type == TT_BinaryOperator && Current.isNot(tok::lessless)) || 574c0d606a5SDaniel Jasper Current.Type == TT_ConditionalExpr) 575c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 5761db6c386SDaniel Jasper if (Current.Type == TT_ArraySubscriptLSquare && 577de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts == 0) 578de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = State.Column; 579165b29e2SDaniel Jasper if ((Current.is(tok::question) && Style.BreakBeforeTernaryOperators) || 580165b29e2SDaniel Jasper (Current.getPreviousNonComment() && Current.isNot(tok::colon) && 581165b29e2SDaniel Jasper Current.getPreviousNonComment()->is(tok::question) && 582165b29e2SDaniel Jasper !Style.BreakBeforeTernaryOperators)) 583de0328aeSDaniel Jasper State.Stack.back().QuestionColumn = State.Column; 584de0328aeSDaniel Jasper if (!Current.opensScope() && !Current.closesScope()) 585de0328aeSDaniel Jasper State.LowestLevelOnLine = 58605cd5868SDaniel Jasper std::min(State.LowestLevelOnLine, Current.NestingLevel); 5874c6e0059SDaniel Jasper if (Current.isMemberAccess()) 588de0328aeSDaniel Jasper State.Stack.back().StartOfFunctionCall = 5890e61784aSDaniel Jasper Current.LastOperator ? 0 : State.Column + Current.ColumnWidth; 590b88b25feSDaniel Jasper if (Current.Type == TT_ObjCSelectorName) 591b88b25feSDaniel Jasper State.Stack.back().ObjCSelectorNameFound = true; 5923ae6f5a4SDaniel Jasper if (Current.Type == TT_LambdaLSquare) 5933ae6f5a4SDaniel Jasper ++State.Stack.back().LambdasFound; 594de0328aeSDaniel Jasper if (Current.Type == TT_CtorInitializerColon) { 595de0328aeSDaniel Jasper // Indent 2 from the column, so: 596de0328aeSDaniel Jasper // SomeClass::SomeClass() 597de0328aeSDaniel Jasper // : First(...), ... 598de0328aeSDaniel Jasper // Next(...) 599de0328aeSDaniel Jasper // ^ line up here. 600de0328aeSDaniel Jasper State.Stack.back().Indent = 601de0328aeSDaniel Jasper State.Column + (Style.BreakConstructorInitializersBeforeComma ? 0 : 2); 602de0328aeSDaniel Jasper if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine) 603de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 604de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 605de0328aeSDaniel Jasper } 606de0328aeSDaniel Jasper 607de0328aeSDaniel Jasper // In ObjC method declaration we align on the ":" of parameters, but we need 6086633ab8aSDaniel Jasper // to ensure that we indent parameters on subsequent lines by at least our 6096633ab8aSDaniel Jasper // continuation indent width. 610de0328aeSDaniel Jasper if (Current.Type == TT_ObjCMethodSpecifier) 6116633ab8aSDaniel Jasper State.Stack.back().Indent += Style.ContinuationIndentWidth; 612de0328aeSDaniel Jasper 613de0328aeSDaniel Jasper // Insert scopes created by fake parenthesis. 614de0328aeSDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 615b16b969dSDaniel Jasper 616b16b969dSDaniel Jasper // Add special behavior to support a format commonly used for JavaScript 617b16b969dSDaniel Jasper // closures: 618b16b969dSDaniel Jasper // SomeFunction(function() { 619b16b969dSDaniel Jasper // foo(); 620b16b969dSDaniel Jasper // bar(); 621b16b969dSDaniel Jasper // }, a, b, c); 622b16b969dSDaniel Jasper if (Style.Language == FormatStyle::LK_JavaScript) { 623b16b969dSDaniel Jasper if (Current.isNot(tok::comment) && Previous && Previous->is(tok::l_brace) && 624b16b969dSDaniel Jasper State.Stack.size() > 1) { 625b16b969dSDaniel Jasper if (State.Stack[State.Stack.size() - 2].JSFunctionInlined && Newline) { 626b16b969dSDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { 627b16b969dSDaniel Jasper State.Stack[i].NoLineBreak = true; 628b16b969dSDaniel Jasper } 629b16b969dSDaniel Jasper } 630b16b969dSDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined = false; 631b16b969dSDaniel Jasper } 632b16b969dSDaniel Jasper if (Current.TokenText == "function") 633b16b969dSDaniel Jasper State.Stack.back().JSFunctionInlined = !Newline; 634b16b969dSDaniel Jasper } 635b16b969dSDaniel Jasper 63660553be5SDaniel Jasper moveStatePastFakeLParens(State, Newline); 63760553be5SDaniel Jasper moveStatePastScopeOpener(State, Newline); 63860553be5SDaniel Jasper moveStatePastScopeCloser(State); 63960553be5SDaniel Jasper moveStatePastFakeRParens(State); 64060553be5SDaniel Jasper 64160553be5SDaniel Jasper if (Current.isStringLiteral() && State.StartOfStringLiteral == 0) { 64260553be5SDaniel Jasper State.StartOfStringLiteral = State.Column; 64360553be5SDaniel Jasper } else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash) && 64460553be5SDaniel Jasper !Current.isStringLiteral()) { 64560553be5SDaniel Jasper State.StartOfStringLiteral = 0; 64660553be5SDaniel Jasper } 64760553be5SDaniel Jasper 64860553be5SDaniel Jasper State.Column += Current.ColumnWidth; 64960553be5SDaniel Jasper State.NextToken = State.NextToken->Next; 65060553be5SDaniel Jasper unsigned Penalty = breakProtrudingToken(Current, State, DryRun); 65160553be5SDaniel Jasper if (State.Column > getColumnLimit(State)) { 65260553be5SDaniel Jasper unsigned ExcessCharacters = State.Column - getColumnLimit(State); 65360553be5SDaniel Jasper Penalty += Style.PenaltyExcessCharacter * ExcessCharacters; 65460553be5SDaniel Jasper } 65560553be5SDaniel Jasper 65660553be5SDaniel Jasper if (Current.Role) 65760553be5SDaniel Jasper Current.Role->formatFromToken(State, this, DryRun); 65860553be5SDaniel Jasper // If the previous has a special role, let it consume tokens as appropriate. 65960553be5SDaniel Jasper // It is necessary to start at the previous token for the only implemented 66060553be5SDaniel Jasper // role (comma separated list). That way, the decision whether or not to break 66160553be5SDaniel Jasper // after the "{" is already done and both options are tried and evaluated. 66260553be5SDaniel Jasper // FIXME: This is ugly, find a better way. 66360553be5SDaniel Jasper if (Previous && Previous->Role) 66460553be5SDaniel Jasper Penalty += Previous->Role->formatAfterToken(State, this, DryRun); 66560553be5SDaniel Jasper 66660553be5SDaniel Jasper return Penalty; 66760553be5SDaniel Jasper } 66860553be5SDaniel Jasper 66960553be5SDaniel Jasper void ContinuationIndenter::moveStatePastFakeLParens(LineState &State, 67060553be5SDaniel Jasper bool Newline) { 67160553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 67260553be5SDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 67360553be5SDaniel Jasper 674de0328aeSDaniel Jasper // Don't add extra indentation for the first fake parenthesis after 6750db806b7SDinesh Dwivedi // 'return', assignments or opening <({[. The indentation for these cases 676de0328aeSDaniel Jasper // is special cased. 677de0328aeSDaniel Jasper bool SkipFirstExtraIndent = 678eabede6dSDaniel Jasper (Previous && (Previous->opensScope() || Previous->is(tok::kw_return) || 679f48b5abcSDaniel Jasper Previous->getPrecedence() == prec::Assignment || 680f48b5abcSDaniel Jasper Previous->Type == TT_ObjCMethodExpr)); 681de0328aeSDaniel Jasper for (SmallVectorImpl<prec::Level>::const_reverse_iterator 682de0328aeSDaniel Jasper I = Current.FakeLParens.rbegin(), 683de0328aeSDaniel Jasper E = Current.FakeLParens.rend(); 684de0328aeSDaniel Jasper I != E; ++I) { 685de0328aeSDaniel Jasper ParenState NewParenState = State.Stack.back(); 686de0328aeSDaniel Jasper NewParenState.ContainsLineBreak = false; 687eabede6dSDaniel Jasper 688eabede6dSDaniel Jasper // Indent from 'LastSpace' unless this the fake parentheses encapsulating a 689eabede6dSDaniel Jasper // builder type call after 'return'. If such a call is line-wrapped, we 690eabede6dSDaniel Jasper // commonly just want to indent from the start of the line. 691eabede6dSDaniel Jasper if (!Previous || Previous->isNot(tok::kw_return) || *I > 0) 692de0328aeSDaniel Jasper NewParenState.Indent = 693de0328aeSDaniel Jasper std::max(std::max(State.Column, NewParenState.Indent), 694de0328aeSDaniel Jasper State.Stack.back().LastSpace); 695eabede6dSDaniel Jasper 6965c33265cSDaniel Jasper // Don't allow the RHS of an operator to be split over multiple lines unless 6975c33265cSDaniel Jasper // there is a line-break right after the operator. 6985c33265cSDaniel Jasper // Exclude relational operators, as there, it is always more desirable to 6995c33265cSDaniel Jasper // have the LHS 'left' of the RHS. 700c0d606a5SDaniel Jasper if (Previous && Previous->getPrecedence() > prec::Assignment && 701c0d606a5SDaniel Jasper (Previous->Type == TT_BinaryOperator || 702c0d606a5SDaniel Jasper Previous->Type == TT_ConditionalExpr) && 703c0d606a5SDaniel Jasper Previous->getPrecedence() != prec::Relational) { 704c0d606a5SDaniel Jasper bool BreakBeforeOperator = Previous->is(tok::lessless) || 705c0d606a5SDaniel Jasper (Previous->Type == TT_BinaryOperator && 706c0d606a5SDaniel Jasper Style.BreakBeforeBinaryOperators) || 707c0d606a5SDaniel Jasper (Previous->Type == TT_ConditionalExpr && 708c0d606a5SDaniel Jasper Style.BreakBeforeTernaryOperators); 709c0d606a5SDaniel Jasper if ((!Newline && !BreakBeforeOperator) || 710c0d606a5SDaniel Jasper (!State.Stack.back().LastOperatorWrapped && BreakBeforeOperator)) 7115c33265cSDaniel Jasper NewParenState.NoLineBreak = true; 712c0d606a5SDaniel Jasper } 7135c33265cSDaniel Jasper 7149fe0e8daSDaniel Jasper // Do not indent relative to the fake parentheses inserted for "." or "->". 7159fe0e8daSDaniel Jasper // This is a special case to make the following to statements consistent: 7169fe0e8daSDaniel Jasper // OuterFunction(InnerFunctionCall( // break 7179fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 7189fe0e8daSDaniel Jasper // OuterFunction(SomeObject.InnerFunctionCall( // break 7199fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 7209fe0e8daSDaniel Jasper if (*I > prec::Unknown) 7219fe0e8daSDaniel Jasper NewParenState.LastSpace = std::max(NewParenState.LastSpace, State.Column); 72296964359SDaniel Jasper NewParenState.StartOfFunctionCall = State.Column; 723de0328aeSDaniel Jasper 724de0328aeSDaniel Jasper // Always indent conditional expressions. Never indent expression where 725de0328aeSDaniel Jasper // the 'operator' is ',', ';' or an assignment (i.e. *I <= 726de0328aeSDaniel Jasper // prec::Assignment) as those have different indentation rules. Indent 727de0328aeSDaniel Jasper // other expression, unless the indentation needs to be skipped. 728de0328aeSDaniel Jasper if (*I == prec::Conditional || 729de0328aeSDaniel Jasper (!SkipFirstExtraIndent && *I > prec::Assignment && 730de0328aeSDaniel Jasper !Style.BreakBeforeBinaryOperators)) 7316633ab8aSDaniel Jasper NewParenState.Indent += Style.ContinuationIndentWidth; 7321db6c386SDaniel Jasper if ((Previous && !Previous->opensScope()) || *I > prec::Comma) 733de0328aeSDaniel Jasper NewParenState.BreakBeforeParameter = false; 734de0328aeSDaniel Jasper State.Stack.push_back(NewParenState); 735de0328aeSDaniel Jasper SkipFirstExtraIndent = false; 736de0328aeSDaniel Jasper } 73760553be5SDaniel Jasper } 738de0328aeSDaniel Jasper 739*335ff266SDaniel Jasper // Remove the fake r_parens after 'Tok'. 740*335ff266SDaniel Jasper static void consumeRParens(LineState& State, const FormatToken &Tok) { 741*335ff266SDaniel Jasper for (unsigned i = 0, e = Tok.FakeRParens; i != e; ++i) { 74260553be5SDaniel Jasper unsigned VariablePos = State.Stack.back().VariablePos; 743819788daSManuel Klimek assert(State.Stack.size() > 1); 744819788daSManuel Klimek if (State.Stack.size() == 1) { 745819788daSManuel Klimek // Do not pop the last element. 746819788daSManuel Klimek break; 747819788daSManuel Klimek } 7489fe0e8daSDaniel Jasper State.Stack.pop_back(); 74960553be5SDaniel Jasper State.Stack.back().VariablePos = VariablePos; 750819788daSManuel Klimek } 75160553be5SDaniel Jasper } 752*335ff266SDaniel Jasper 753*335ff266SDaniel Jasper // Returns whether 'Tok' opens or closes a scope requiring special handling 754*335ff266SDaniel Jasper // of the subsequent fake r_parens. 755*335ff266SDaniel Jasper // 756*335ff266SDaniel Jasper // For example, if this is an l_brace starting a nested block, we pretend (wrt. 757*335ff266SDaniel Jasper // to indentation) that we already consumed the corresponding r_brace. Thus, we 758*335ff266SDaniel Jasper // remove all ParenStates caused by fake parentheses that end at the r_brace. 759*335ff266SDaniel Jasper // The net effect of this is that we don't indent relative to the l_brace, if 760*335ff266SDaniel Jasper // the nested block is the last parameter of a function. This formats: 761*335ff266SDaniel Jasper // 762*335ff266SDaniel Jasper // SomeFunction(a, [] { 763*335ff266SDaniel Jasper // f(); // break 764*335ff266SDaniel Jasper // }); 765*335ff266SDaniel Jasper // 766*335ff266SDaniel Jasper // instead of: 767*335ff266SDaniel Jasper // SomeFunction(a, [] { 768*335ff266SDaniel Jasper // f(); // break 769*335ff266SDaniel Jasper // }); 770*335ff266SDaniel Jasper static bool fakeRParenSpecialCase(const FormatToken& Tok) { 771*335ff266SDaniel Jasper if (!Tok.MatchingParen) 772*335ff266SDaniel Jasper return false; 773*335ff266SDaniel Jasper const FormatToken *Left = &Tok; 774*335ff266SDaniel Jasper if (Tok.isOneOf(tok::r_brace, tok::r_square)) 775*335ff266SDaniel Jasper Left = Tok.MatchingParen; 776*335ff266SDaniel Jasper return Left->isOneOf(tok::l_brace, tok::l_square) && 777*335ff266SDaniel Jasper (Left->BlockKind == BK_Block || 778*335ff266SDaniel Jasper Left->Type == TT_ArrayInitializerLSquare || 779*335ff266SDaniel Jasper Left->Type == TT_DictLiteral); 780*335ff266SDaniel Jasper } 781*335ff266SDaniel Jasper 782*335ff266SDaniel Jasper void ContinuationIndenter::moveStatePastFakeRParens(LineState &State) { 783*335ff266SDaniel Jasper const FormatToken &Current = *State.NextToken; 784*335ff266SDaniel Jasper 785*335ff266SDaniel Jasper // Don't remove FakeRParens attached to r_braces that surround nested blocks 786*335ff266SDaniel Jasper // as they will have been removed early (see above). 787*335ff266SDaniel Jasper if (fakeRParenSpecialCase(Current)) 788*335ff266SDaniel Jasper return; 789*335ff266SDaniel Jasper 790*335ff266SDaniel Jasper consumeRParens(State, *State.NextToken); 79160553be5SDaniel Jasper } 79260553be5SDaniel Jasper 79360553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeOpener(LineState &State, 79460553be5SDaniel Jasper bool Newline) { 79560553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 79660553be5SDaniel Jasper if (!Current.opensScope()) 79760553be5SDaniel Jasper return; 79860553be5SDaniel Jasper 79960553be5SDaniel Jasper if (Current.MatchingParen && Current.BlockKind == BK_Block) { 80060553be5SDaniel Jasper moveStateToNewBlock(State); 80160553be5SDaniel Jasper return; 80260553be5SDaniel Jasper } 80360553be5SDaniel Jasper 80460553be5SDaniel Jasper unsigned NewIndent; 80560553be5SDaniel Jasper unsigned NewIndentLevel = State.Stack.back().IndentLevel; 80660553be5SDaniel Jasper bool AvoidBinPacking; 80760553be5SDaniel Jasper bool BreakBeforeParameter = false; 80860553be5SDaniel Jasper if (Current.is(tok::l_brace) || Current.Type == TT_ArrayInitializerLSquare) { 809*335ff266SDaniel Jasper if (fakeRParenSpecialCase(Current)) 810*335ff266SDaniel Jasper consumeRParens(State, *Current.MatchingParen); 811*335ff266SDaniel Jasper 812e2e0387fSAlexander Kornienko NewIndent = State.Stack.back().LastSpace; 813b8f61682SDaniel Jasper if (Current.opensBlockTypeList(Style)) { 814e2e0387fSAlexander Kornienko NewIndent += Style.IndentWidth; 8155a611397SDaniel Jasper NewIndent = std::min(State.Column + 2, NewIndent); 816e2e0387fSAlexander Kornienko ++NewIndentLevel; 817b8f61682SDaniel Jasper } else { 818b8f61682SDaniel Jasper NewIndent += Style.ContinuationIndentWidth; 8195a611397SDaniel Jasper NewIndent = std::min(State.Column + 1, NewIndent); 820e2e0387fSAlexander Kornienko } 821de0328aeSDaniel Jasper const FormatToken *NextNoComment = Current.getNextNonComment(); 82260553be5SDaniel Jasper AvoidBinPacking = Current.Type == TT_ArrayInitializerLSquare || 823b596fb2bSDaniel Jasper Current.Type == TT_DictLiteral || 824883ae9d9SDaniel Jasper Style.Language == FormatStyle::LK_Proto || 825ae8e0d8dSDaniel Jasper !Style.BinPackParameters || 826015ed028SDaniel Jasper (NextNoComment && 827015ed028SDaniel Jasper NextNoComment->Type == TT_DesignatedInitializerPeriod); 828de0328aeSDaniel Jasper } else { 8296633ab8aSDaniel Jasper NewIndent = Style.ContinuationIndentWidth + 8306633ab8aSDaniel Jasper std::max(State.Stack.back().LastSpace, 8319fe0e8daSDaniel Jasper State.Stack.back().StartOfFunctionCall); 832de0328aeSDaniel Jasper AvoidBinPacking = !Style.BinPackParameters || 833de0328aeSDaniel Jasper (Style.ExperimentalAutoDetectBinPacking && 834de0328aeSDaniel Jasper (Current.PackingKind == PPK_OnePerLine || 835de0328aeSDaniel Jasper (!BinPackInconclusiveFunctions && 836de0328aeSDaniel Jasper Current.PackingKind == PPK_Inconclusive))); 8371db6c386SDaniel Jasper // If this '[' opens an ObjC call, determine whether all parameters fit 8381db6c386SDaniel Jasper // into one line and put one per line if they don't. 8397f0c5171SDaniel Jasper if (Current.Type == TT_ObjCMethodExpr && Style.ColumnLimit != 0 && 8401db6c386SDaniel Jasper getLengthToMatchingParen(Current) + State.Column > 8411db6c386SDaniel Jasper getColumnLimit(State)) 8421db6c386SDaniel Jasper BreakBeforeParameter = true; 843de0328aeSDaniel Jasper } 844cc3114d8SDaniel Jasper bool NoLineBreak = State.Stack.back().NoLineBreak || 845cc3114d8SDaniel Jasper (Current.Type == TT_TemplateOpener && 846cc3114d8SDaniel Jasper State.Stack.back().ContainsUnwrappedBuilder); 847cc3114d8SDaniel Jasper State.Stack.push_back(ParenState(NewIndent, NewIndentLevel, 848cc3114d8SDaniel Jasper State.Stack.back().LastSpace, 849cc3114d8SDaniel Jasper AvoidBinPacking, NoLineBreak)); 8501db6c386SDaniel Jasper State.Stack.back().BreakBeforeParameter = BreakBeforeParameter; 851de0328aeSDaniel Jasper } 852de0328aeSDaniel Jasper 85360553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) { 85460553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 85560553be5SDaniel Jasper if (!Current.closesScope()) 85660553be5SDaniel Jasper return; 85760553be5SDaniel Jasper 858de0328aeSDaniel Jasper // If we encounter a closing ), ], } or >, we can remove a level from our 859de0328aeSDaniel Jasper // stacks. 86096df37a6SDaniel Jasper if (State.Stack.size() > 1 && 86196df37a6SDaniel Jasper (Current.isOneOf(tok::r_paren, tok::r_square) || 8629fe0e8daSDaniel Jasper (Current.is(tok::r_brace) && State.NextToken != State.Line->First) || 863*335ff266SDaniel Jasper State.NextToken->Type == TT_TemplateCloser)) 864de0328aeSDaniel Jasper State.Stack.pop_back(); 865*335ff266SDaniel Jasper 866de0328aeSDaniel Jasper if (Current.is(tok::r_square)) { 867de0328aeSDaniel Jasper // If this ends the array subscript expr, reset the corresponding value. 868de0328aeSDaniel Jasper const FormatToken *NextNonComment = Current.getNextNonComment(); 869de0328aeSDaniel Jasper if (NextNonComment && NextNonComment->isNot(tok::l_square)) 870de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = 0; 871de0328aeSDaniel Jasper } 87260553be5SDaniel Jasper } 873de0328aeSDaniel Jasper 87460553be5SDaniel Jasper void ContinuationIndenter::moveStateToNewBlock(LineState &State) { 87560553be5SDaniel Jasper // If we have already found more than one lambda introducers on this level, we 87660553be5SDaniel Jasper // opt out of this because similarity between the lambdas is more important. 877*335ff266SDaniel Jasper // FIXME: This should use fakeRParenSpecialCase() and fakeRParenSpecialCase() 878*335ff266SDaniel Jasper // Needs to include the LambdasFound check. Otherwise the corresponding 879*335ff266SDaniel Jasper // fake r_parens will never be consumed. 880*335ff266SDaniel Jasper if (State.Stack.back().LambdasFound <= 1) 881*335ff266SDaniel Jasper consumeRParens(State, *State.NextToken->MatchingParen); 882de0328aeSDaniel Jasper 88360553be5SDaniel Jasper // For some reason, ObjC blocks are indented like continuations. 88460553be5SDaniel Jasper unsigned NewIndent = State.Stack.back().LastSpace + 88560553be5SDaniel Jasper (State.NextToken->Type == TT_ObjCBlockLBrace 88660553be5SDaniel Jasper ? Style.ContinuationIndentWidth 88760553be5SDaniel Jasper : Style.IndentWidth); 88860553be5SDaniel Jasper State.Stack.push_back(ParenState( 88960553be5SDaniel Jasper NewIndent, /*NewIndentLevel=*/State.Stack.back().IndentLevel + 1, 89060553be5SDaniel Jasper State.Stack.back().LastSpace, /*AvoidBinPacking=*/true, 89160553be5SDaniel Jasper State.Stack.back().NoLineBreak)); 89260553be5SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 893de0328aeSDaniel Jasper } 894de0328aeSDaniel Jasper 895917f9e04SAlexander Kornienko unsigned ContinuationIndenter::addMultilineToken(const FormatToken &Current, 896d7b837e7SAlexander Kornienko LineState &State) { 897d7b837e7SAlexander Kornienko // Break before further function parameters on all levels. 898d7b837e7SAlexander Kornienko for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 899d7b837e7SAlexander Kornienko State.Stack[i].BreakBeforeParameter = true; 900d7b837e7SAlexander Kornienko 90139856b71SAlexander Kornienko unsigned ColumnsUsed = State.Column; 902632abb9bSAlexander Kornienko // We can only affect layout of the first and the last line, so the penalty 903632abb9bSAlexander Kornienko // for all other lines is constant, and we ignore it. 904ebb43caaSAlexander Kornienko State.Column = Current.LastLineColumnWidth; 905632abb9bSAlexander Kornienko 9069fe0e8daSDaniel Jasper if (ColumnsUsed > getColumnLimit(State)) 9079fe0e8daSDaniel Jasper return Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit(State)); 908d7b837e7SAlexander Kornienko return 0; 909d7b837e7SAlexander Kornienko } 910d7b837e7SAlexander Kornienko 911b05a81deSDaniel Jasper static bool getRawStringLiteralPrefixPostfix(StringRef Text, StringRef &Prefix, 91281e3294eSAlexander Kornienko StringRef &Postfix) { 91381e3294eSAlexander Kornienko if (Text.startswith(Prefix = "R\"") || Text.startswith(Prefix = "uR\"") || 91481e3294eSAlexander Kornienko Text.startswith(Prefix = "UR\"") || Text.startswith(Prefix = "u8R\"") || 91581e3294eSAlexander Kornienko Text.startswith(Prefix = "LR\"")) { 91681e3294eSAlexander Kornienko size_t ParenPos = Text.find('('); 91781e3294eSAlexander Kornienko if (ParenPos != StringRef::npos) { 91881e3294eSAlexander Kornienko StringRef Delimiter = 91981e3294eSAlexander Kornienko Text.substr(Prefix.size(), ParenPos - Prefix.size()); 92081e3294eSAlexander Kornienko Prefix = Text.substr(0, ParenPos + 1); 92181e3294eSAlexander Kornienko Postfix = Text.substr(Text.size() - 2 - Delimiter.size()); 92281e3294eSAlexander Kornienko return Postfix.front() == ')' && Postfix.back() == '"' && 92381e3294eSAlexander Kornienko Postfix.substr(1).startswith(Delimiter); 92481e3294eSAlexander Kornienko } 92581e3294eSAlexander Kornienko } 92681e3294eSAlexander Kornienko return false; 92781e3294eSAlexander Kornienko } 92881e3294eSAlexander Kornienko 929de0328aeSDaniel Jasper unsigned ContinuationIndenter::breakProtrudingToken(const FormatToken &Current, 930de0328aeSDaniel Jasper LineState &State, 931de0328aeSDaniel Jasper bool DryRun) { 932917f9e04SAlexander Kornienko // Don't break multi-line tokens other than block comments. Instead, just 933917f9e04SAlexander Kornienko // update the state. 934917f9e04SAlexander Kornienko if (Current.Type != TT_BlockComment && Current.IsMultiline) 935917f9e04SAlexander Kornienko return addMultilineToken(Current, State); 936917f9e04SAlexander Kornienko 9379885784dSDaniel Jasper // Don't break implicit string literals. 9389885784dSDaniel Jasper if (Current.Type == TT_ImplicitStringLiteral) 9399885784dSDaniel Jasper return 0; 9409885784dSDaniel Jasper 94104b6a081SDaniel Jasper if (!Current.isStringLiteral() && !Current.is(tok::comment)) 942f93551c8SDaniel Jasper return 0; 943f93551c8SDaniel Jasper 944b8984329SAhmed Charles std::unique_ptr<BreakableToken> Token; 94539856b71SAlexander Kornienko unsigned StartColumn = State.Column - Current.ColumnWidth; 9463abbb8a4SAlexander Kornienko unsigned ColumnLimit = getColumnLimit(State); 947de0328aeSDaniel Jasper 94804b6a081SDaniel Jasper if (Current.isStringLiteral()) { 949384b40b9SAlexander Kornienko // Don't break string literals inside preprocessor directives (except for 950384b40b9SAlexander Kornienko // #define directives, as their contents are stored in separate lines and 951384b40b9SAlexander Kornienko // are not affected by this check). 952384b40b9SAlexander Kornienko // This way we avoid breaking code with line directives and unknown 953384b40b9SAlexander Kornienko // preprocessor directives that contain long string literals. 954384b40b9SAlexander Kornienko if (State.Line->Type == LT_PreprocessorDirective) 955384b40b9SAlexander Kornienko return 0; 956de0328aeSDaniel Jasper // Exempts unterminated string literals from line breaking. The user will 957de0328aeSDaniel Jasper // likely want to terminate the string before any line breaking is done. 958de0328aeSDaniel Jasper if (Current.IsUnterminatedLiteral) 959de0328aeSDaniel Jasper return 0; 960de0328aeSDaniel Jasper 96181e3294eSAlexander Kornienko StringRef Text = Current.TokenText; 96281e3294eSAlexander Kornienko StringRef Prefix; 96381e3294eSAlexander Kornienko StringRef Postfix; 964174b0125SDaniel Jasper bool IsNSStringLiteral = false; 96581e3294eSAlexander Kornienko // FIXME: Handle whitespace between '_T', '(', '"..."', and ')'. 96681e3294eSAlexander Kornienko // FIXME: Store Prefix and Suffix (or PrefixLength and SuffixLength to 96781e3294eSAlexander Kornienko // reduce the overhead) for each FormatToken, which is a string, so that we 96881e3294eSAlexander Kornienko // don't run multiple checks here on the hot path. 969174b0125SDaniel Jasper if (Text.startswith("\"") && Current.Previous && 970174b0125SDaniel Jasper Current.Previous->is(tok::at)) { 971174b0125SDaniel Jasper IsNSStringLiteral = true; 972174b0125SDaniel Jasper Prefix = "@\""; 973174b0125SDaniel Jasper } 97481e3294eSAlexander Kornienko if ((Text.endswith(Postfix = "\"") && 975174b0125SDaniel Jasper (IsNSStringLiteral || Text.startswith(Prefix = "\"") || 976174b0125SDaniel Jasper Text.startswith(Prefix = "u\"") || Text.startswith(Prefix = "U\"") || 977174b0125SDaniel Jasper Text.startswith(Prefix = "u8\"") || 97881e3294eSAlexander Kornienko Text.startswith(Prefix = "L\""))) || 97981e3294eSAlexander Kornienko (Text.startswith(Prefix = "_T(\"") && Text.endswith(Postfix = "\")")) || 98081e3294eSAlexander Kornienko getRawStringLiteralPrefixPostfix(Text, Prefix, Postfix)) { 9813c3d09c8SAlexander Kornienko Token.reset(new BreakableStringLiteral( 9823c3d09c8SAlexander Kornienko Current, State.Line->Level, StartColumn, Prefix, Postfix, 9833c3d09c8SAlexander Kornienko State.Line->InPPDirective, Encoding, Style)); 98481e3294eSAlexander Kornienko } else { 98581e3294eSAlexander Kornienko return 0; 98681e3294eSAlexander Kornienko } 987de0328aeSDaniel Jasper } else if (Current.Type == TT_BlockComment && Current.isTrailingComment()) { 988ce9161a5SAlexander Kornienko if (CommentPragmasRegex.match(Current.TokenText.substr(2))) 989ce9161a5SAlexander Kornienko return 0; 990de0328aeSDaniel Jasper Token.reset(new BreakableBlockComment( 9913c3d09c8SAlexander Kornienko Current, State.Line->Level, StartColumn, Current.OriginalColumn, 9923c3d09c8SAlexander Kornienko !Current.Previous, State.Line->InPPDirective, Encoding, Style)); 993de0328aeSDaniel Jasper } else if (Current.Type == TT_LineComment && 9942145bc02SCraig Topper (Current.Previous == nullptr || 995de0328aeSDaniel Jasper Current.Previous->Type != TT_ImplicitStringLiteral)) { 996ce9161a5SAlexander Kornienko if (CommentPragmasRegex.match(Current.TokenText.substr(2))) 997ce9161a5SAlexander Kornienko return 0; 9983c3d09c8SAlexander Kornienko Token.reset(new BreakableLineComment(Current, State.Line->Level, 9993abbb8a4SAlexander Kornienko StartColumn, /*InPPDirective=*/false, 10003c3d09c8SAlexander Kornienko Encoding, Style)); 10013abbb8a4SAlexander Kornienko // We don't insert backslashes when breaking line comments. 10023abbb8a4SAlexander Kornienko ColumnLimit = Style.ColumnLimit; 1003de0328aeSDaniel Jasper } else { 1004de0328aeSDaniel Jasper return 0; 1005de0328aeSDaniel Jasper } 10063abbb8a4SAlexander Kornienko if (Current.UnbreakableTailLength >= ColumnLimit) 1007de0328aeSDaniel Jasper return 0; 1008de0328aeSDaniel Jasper 10093abbb8a4SAlexander Kornienko unsigned RemainingSpace = ColumnLimit - Current.UnbreakableTailLength; 1010de0328aeSDaniel Jasper bool BreakInserted = false; 1011de0328aeSDaniel Jasper unsigned Penalty = 0; 1012de0328aeSDaniel Jasper unsigned RemainingTokenColumns = 0; 1013de0328aeSDaniel Jasper for (unsigned LineIndex = 0, EndIndex = Token->getLineCount(); 1014de0328aeSDaniel Jasper LineIndex != EndIndex; ++LineIndex) { 1015de0328aeSDaniel Jasper if (!DryRun) 1016de0328aeSDaniel Jasper Token->replaceWhitespaceBefore(LineIndex, Whitespaces); 1017de0328aeSDaniel Jasper unsigned TailOffset = 0; 1018de0328aeSDaniel Jasper RemainingTokenColumns = 1019de0328aeSDaniel Jasper Token->getLineLengthAfterSplit(LineIndex, TailOffset, StringRef::npos); 1020de0328aeSDaniel Jasper while (RemainingTokenColumns > RemainingSpace) { 1021de0328aeSDaniel Jasper BreakableToken::Split Split = 10223abbb8a4SAlexander Kornienko Token->getSplit(LineIndex, TailOffset, ColumnLimit); 1023de0328aeSDaniel Jasper if (Split.first == StringRef::npos) { 1024de0328aeSDaniel Jasper // The last line's penalty is handled in addNextStateToQueue(). 1025de0328aeSDaniel Jasper if (LineIndex < EndIndex - 1) 1026de0328aeSDaniel Jasper Penalty += Style.PenaltyExcessCharacter * 1027de0328aeSDaniel Jasper (RemainingTokenColumns - RemainingSpace); 1028de0328aeSDaniel Jasper break; 1029de0328aeSDaniel Jasper } 1030de0328aeSDaniel Jasper assert(Split.first != 0); 1031de0328aeSDaniel Jasper unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit( 1032de0328aeSDaniel Jasper LineIndex, TailOffset + Split.first + Split.second, StringRef::npos); 1033875395f9SAlexander Kornienko 1034875395f9SAlexander Kornienko // We can remove extra whitespace instead of breaking the line. 1035875395f9SAlexander Kornienko if (RemainingTokenColumns + 1 - Split.second <= RemainingSpace) { 1036875395f9SAlexander Kornienko RemainingTokenColumns = 0; 1037875395f9SAlexander Kornienko if (!DryRun) 1038875395f9SAlexander Kornienko Token->replaceWhitespace(LineIndex, TailOffset, Split, Whitespaces); 1039875395f9SAlexander Kornienko break; 1040875395f9SAlexander Kornienko } 1041875395f9SAlexander Kornienko 104264a42b8dSAlexander Kornienko // When breaking before a tab character, it may be moved by a few columns, 104364a42b8dSAlexander Kornienko // but will still be expanded to the next tab stop, so we don't save any 104464a42b8dSAlexander Kornienko // columns. 104564a42b8dSAlexander Kornienko if (NewRemainingTokenColumns == RemainingTokenColumns) 104664a42b8dSAlexander Kornienko break; 104764a42b8dSAlexander Kornienko 1048de0328aeSDaniel Jasper assert(NewRemainingTokenColumns < RemainingTokenColumns); 1049de0328aeSDaniel Jasper if (!DryRun) 1050de0328aeSDaniel Jasper Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces); 10512739af3bSDaniel Jasper Penalty += Current.SplitPenalty; 1052de0328aeSDaniel Jasper unsigned ColumnsUsed = 1053de0328aeSDaniel Jasper Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first); 10543abbb8a4SAlexander Kornienko if (ColumnsUsed > ColumnLimit) { 10553abbb8a4SAlexander Kornienko Penalty += Style.PenaltyExcessCharacter * (ColumnsUsed - ColumnLimit); 1056de0328aeSDaniel Jasper } 1057de0328aeSDaniel Jasper TailOffset += Split.first + Split.second; 1058de0328aeSDaniel Jasper RemainingTokenColumns = NewRemainingTokenColumns; 1059de0328aeSDaniel Jasper BreakInserted = true; 1060de0328aeSDaniel Jasper } 1061de0328aeSDaniel Jasper } 1062de0328aeSDaniel Jasper 1063de0328aeSDaniel Jasper State.Column = RemainingTokenColumns; 1064de0328aeSDaniel Jasper 1065de0328aeSDaniel Jasper if (BreakInserted) { 1066de0328aeSDaniel Jasper // If we break the token inside a parameter list, we need to break before 1067de0328aeSDaniel Jasper // the next parameter on all levels, so that the next parameter is clearly 1068de0328aeSDaniel Jasper // visible. Line comments already introduce a break. 1069de0328aeSDaniel Jasper if (Current.Type != TT_LineComment) { 1070de0328aeSDaniel Jasper for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 1071de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 1072de0328aeSDaniel Jasper } 1073de0328aeSDaniel Jasper 107404b6a081SDaniel Jasper Penalty += Current.isStringLiteral() ? Style.PenaltyBreakString 10752739af3bSDaniel Jasper : Style.PenaltyBreakComment; 10762739af3bSDaniel Jasper 1077de0328aeSDaniel Jasper State.Stack.back().LastSpace = StartColumn; 1078de0328aeSDaniel Jasper } 1079de0328aeSDaniel Jasper return Penalty; 1080de0328aeSDaniel Jasper } 1081de0328aeSDaniel Jasper 10829fe0e8daSDaniel Jasper unsigned ContinuationIndenter::getColumnLimit(const LineState &State) const { 1083de0328aeSDaniel Jasper // In preprocessor directives reserve two chars for trailing " \" 10849fe0e8daSDaniel Jasper return Style.ColumnLimit - (State.Line->InPPDirective ? 2 : 0); 1085de0328aeSDaniel Jasper } 1086de0328aeSDaniel Jasper 1087c39b56feSDaniel Jasper bool ContinuationIndenter::nextIsMultilineString(const LineState &State) { 1088f438cb76SDaniel Jasper const FormatToken &Current = *State.NextToken; 10899509f188SDaniel Jasper if (!Current.isStringLiteral() || Current.Type == TT_ImplicitStringLiteral) 1090f438cb76SDaniel Jasper return false; 1091d7b837e7SAlexander Kornienko // We never consider raw string literals "multiline" for the purpose of 1092c39b56feSDaniel Jasper // AlwaysBreakBeforeMultilineStrings implementation as they are special-cased 1093c39b56feSDaniel Jasper // (see TokenAnnotator::mustBreakBefore(). 1094d7b837e7SAlexander Kornienko if (Current.TokenText.startswith("R\"")) 1095d7b837e7SAlexander Kornienko return false; 109639856b71SAlexander Kornienko if (Current.IsMultiline) 1097d7b837e7SAlexander Kornienko return true; 1098f438cb76SDaniel Jasper if (Current.getNextNonComment() && 109904b6a081SDaniel Jasper Current.getNextNonComment()->isStringLiteral()) 1100f438cb76SDaniel Jasper return true; // Implicit concatenation. 110139856b71SAlexander Kornienko if (State.Column + Current.ColumnWidth + Current.UnbreakableTailLength > 1102f438cb76SDaniel Jasper Style.ColumnLimit) 1103f438cb76SDaniel Jasper return true; // String will be split. 1104d7b837e7SAlexander Kornienko return false; 1105f438cb76SDaniel Jasper } 1106f438cb76SDaniel Jasper 1107de0328aeSDaniel Jasper } // namespace format 1108de0328aeSDaniel Jasper } // namespace clang 1109