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; 115114a2bc9SDaniel Jasper 116114a2bc9SDaniel Jasper // Don't create a 'hanging' indent if there are multiple blocks in a single 117114a2bc9SDaniel Jasper // statement. 118114a2bc9SDaniel Jasper if (Style.Language == FormatStyle::LK_JavaScript && 119114a2bc9SDaniel Jasper Previous.is(tok::l_brace) && State.Stack.size() > 1 && 120114a2bc9SDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined && 121114a2bc9SDaniel Jasper State.Stack[State.Stack.size() - 2].HasMultipleNestedBlocks) 122114a2bc9SDaniel Jasper return false; 123114a2bc9SDaniel Jasper 124de0328aeSDaniel Jasper return !State.Stack.back().NoLineBreak; 125de0328aeSDaniel Jasper } 126de0328aeSDaniel Jasper 127de0328aeSDaniel Jasper bool ContinuationIndenter::mustBreak(const LineState &State) { 128de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 129de0328aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 130de0328aeSDaniel Jasper if (Current.MustBreakBefore || Current.Type == TT_InlineASMColon) 131de0328aeSDaniel Jasper return true; 1321db6c386SDaniel Jasper if (State.Stack.back().BreakBeforeClosingBrace && 1331db6c386SDaniel Jasper Current.closesBlockTypeList(Style)) 134de0328aeSDaniel Jasper return true; 135de0328aeSDaniel Jasper if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection) 136de0328aeSDaniel Jasper return true; 137ec01cd6eSDaniel Jasper if ((startsNextParameter(Current, Style) || Previous.is(tok::semi) || 138165b29e2SDaniel Jasper (Style.BreakBeforeTernaryOperators && 139165b29e2SDaniel Jasper (Current.is(tok::question) || (Current.Type == TT_ConditionalExpr && 140165b29e2SDaniel Jasper Previous.isNot(tok::question)))) || 141165b29e2SDaniel Jasper (!Style.BreakBeforeTernaryOperators && 142165b29e2SDaniel Jasper (Previous.is(tok::question) || Previous.Type == TT_ConditionalExpr))) && 143de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter && !Current.isTrailingComment() && 144de0328aeSDaniel Jasper !Current.isOneOf(tok::r_paren, tok::r_brace)) 145de0328aeSDaniel Jasper return true; 146de0328aeSDaniel Jasper if (Style.AlwaysBreakBeforeMultilineStrings && 147f438cb76SDaniel Jasper State.Column > State.Stack.back().Indent && // Breaking saves columns. 14827943058SDaniel Jasper !Previous.isOneOf(tok::kw_return, tok::lessless, tok::at) && 1493251fff0SDaniel Jasper Previous.Type != TT_InlineASMColon && 1503251fff0SDaniel Jasper Previous.Type != TT_ConditionalExpr && nextIsMultilineString(State)) 151de0328aeSDaniel Jasper return true; 152b596fb2bSDaniel Jasper if (((Previous.Type == TT_DictLiteral && Previous.is(tok::l_brace)) || 1531db6c386SDaniel Jasper Previous.Type == TT_ArrayInitializerLSquare) && 154db8804b3SDaniel Jasper Style.ColumnLimit > 0 && 155d489dd34SDaniel Jasper getLengthToMatchingParen(Previous) + State.Column > getColumnLimit(State)) 156d489dd34SDaniel Jasper return true; 1575d2587daSDaniel Jasper if (Current.Type == TT_CtorInitializerColon && 158d74cf403SDaniel Jasper ((Style.AllowShortFunctionsOnASingleLine != FormatStyle::SFS_All) || 1595d2587daSDaniel Jasper Style.BreakConstructorInitializersBeforeComma || Style.ColumnLimit != 0)) 1605d2587daSDaniel Jasper return true; 161de0328aeSDaniel Jasper 1625d2587daSDaniel Jasper if (State.Column < getNewLineColumn(State)) 1635d2587daSDaniel Jasper return false; 164de0328aeSDaniel Jasper if (!Style.BreakBeforeBinaryOperators) { 165de0328aeSDaniel Jasper // If we need to break somewhere inside the LHS of a binary expression, we 166de0328aeSDaniel Jasper // should also break after the operator. Otherwise, the formatting would 167de0328aeSDaniel Jasper // hide the operator precedence, e.g. in: 168de0328aeSDaniel Jasper // if (aaaaaaaaaaaaaa == 169de0328aeSDaniel Jasper // bbbbbbbbbbbbbb && c) {.. 170de0328aeSDaniel Jasper // For comparisons, we only apply this rule, if the LHS is a binary 171de0328aeSDaniel Jasper // expression itself as otherwise, the line breaks seem superfluous. 172de0328aeSDaniel Jasper // We need special cases for ">>" which we have split into two ">" while 173de0328aeSDaniel Jasper // lexing in order to make template parsing easier. 174de0328aeSDaniel Jasper // 175de0328aeSDaniel Jasper // FIXME: We'll need something similar for styles that break before binary 176de0328aeSDaniel Jasper // operators. 177de0328aeSDaniel Jasper bool IsComparison = (Previous.getPrecedence() == prec::Relational || 178de0328aeSDaniel Jasper Previous.getPrecedence() == prec::Equality) && 179de0328aeSDaniel Jasper Previous.Previous && 180de0328aeSDaniel Jasper Previous.Previous->Type != TT_BinaryOperator; // For >>. 181de0328aeSDaniel Jasper bool LHSIsBinaryExpr = 182562ecd44SDaniel Jasper Previous.Previous && Previous.Previous->EndsBinaryExpression; 183de0328aeSDaniel Jasper if (Previous.Type == TT_BinaryOperator && 184de0328aeSDaniel Jasper (!IsComparison || LHSIsBinaryExpr) && 185de0328aeSDaniel Jasper Current.Type != TT_BinaryOperator && // For >>. 186c0d606a5SDaniel Jasper !Current.isTrailingComment() && !Previous.is(tok::lessless) && 187de0328aeSDaniel Jasper Previous.getPrecedence() != prec::Assignment && 188de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter) 189de0328aeSDaniel Jasper return true; 190de0328aeSDaniel Jasper } 191de0328aeSDaniel Jasper 192de0328aeSDaniel Jasper // Same as above, but for the first "<<" operator. 19386b2dfdcSAlexander Kornienko if (Current.is(tok::lessless) && Current.Type != TT_OverloadedOperator && 19486b2dfdcSAlexander Kornienko State.Stack.back().BreakBeforeParameter && 195de0328aeSDaniel Jasper State.Stack.back().FirstLessLess == 0) 196de0328aeSDaniel Jasper return true; 197de0328aeSDaniel Jasper 19817062ff5SDaniel Jasper if (Current.Type == TT_SelectorName && 199b88b25feSDaniel Jasper State.Stack.back().ObjCSelectorNameFound && 200de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter) 201de0328aeSDaniel Jasper return true; 20205cd5868SDaniel Jasper if (Previous.ClosesTemplateDeclaration && Current.NestingLevel == 0 && 203a594ba8aSAlexander Kornienko !Current.isTrailingComment()) 204de0328aeSDaniel Jasper return true; 205de0328aeSDaniel Jasper 206*4355e7f0SDaniel Jasper // If the return type spans multiple lines, wrap before the function name. 207*4355e7f0SDaniel Jasper if ((Current.Type == TT_FunctionDeclarationName || 208*4355e7f0SDaniel Jasper Current.is(tok::kw_operator)) && 209*4355e7f0SDaniel Jasper State.Stack.back().BreakBeforeParameter) 210de0328aeSDaniel Jasper return true; 211*4355e7f0SDaniel Jasper 2124c6e0059SDaniel Jasper if (startsSegmentOfBuilderTypeCall(Current) && 213f8151e9bSDaniel Jasper (State.Stack.back().CallContinuation != 0 || 214f8151e9bSDaniel Jasper (State.Stack.back().BreakBeforeParameter && 215f8151e9bSDaniel Jasper State.Stack.back().ContainsUnwrappedBuilder))) 2164c6e0059SDaniel Jasper return true; 2179697281eSDaniel Jasper 2189697281eSDaniel Jasper // The following could be precomputed as they do not depend on the state. 2199697281eSDaniel Jasper // However, as they should take effect only if the UnwrappedLine does not fit 2209697281eSDaniel Jasper // into the ColumnLimit, they are checked here in the ContinuationIndenter. 22135995679SDaniel Jasper if (Style.ColumnLimit != 0 && Previous.BlockKind == BK_Block && 22235995679SDaniel Jasper Previous.is(tok::l_brace) && !Current.isOneOf(tok::r_brace, tok::comment)) 2239697281eSDaniel Jasper return true; 2249697281eSDaniel Jasper 225de0328aeSDaniel Jasper return false; 226de0328aeSDaniel Jasper } 227de0328aeSDaniel Jasper 228de0328aeSDaniel Jasper unsigned ContinuationIndenter::addTokenToState(LineState &State, bool Newline, 2298de9ed05SDaniel Jasper bool DryRun, 2308de9ed05SDaniel Jasper unsigned ExtraSpaces) { 231de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 232de0328aeSDaniel Jasper 233819788daSManuel Klimek assert(!State.Stack.empty()); 234819788daSManuel Klimek if ((Current.Type == TT_ImplicitStringLiteral && 2352145bc02SCraig Topper (Current.Previous->Tok.getIdentifierInfo() == nullptr || 2369885784dSDaniel Jasper Current.Previous->Tok.getIdentifierInfo()->getPPKeywordID() == 2379885784dSDaniel Jasper tok::pp_not_keyword))) { 238de0328aeSDaniel Jasper // FIXME: Is this correct? 239de0328aeSDaniel Jasper int WhitespaceLength = SourceMgr.getSpellingColumnNumber( 240de0328aeSDaniel Jasper State.NextToken->WhitespaceRange.getEnd()) - 241de0328aeSDaniel Jasper SourceMgr.getSpellingColumnNumber( 242de0328aeSDaniel Jasper State.NextToken->WhitespaceRange.getBegin()); 243da353cd5SDaniel Jasper State.Column += WhitespaceLength; 244240dfda3SDaniel Jasper moveStateToNextToken(State, DryRun, /*Newline=*/false); 245de0328aeSDaniel Jasper return 0; 246de0328aeSDaniel Jasper } 247de0328aeSDaniel Jasper 2481f80396dSAlexander Kornienko unsigned Penalty = 0; 2491f80396dSAlexander Kornienko if (Newline) 2501f80396dSAlexander Kornienko Penalty = addTokenOnNewLine(State, DryRun); 2511f80396dSAlexander Kornienko else 25248437ce5SDaniel Jasper addTokenOnCurrentLine(State, DryRun, ExtraSpaces); 2531f80396dSAlexander Kornienko 2541f80396dSAlexander Kornienko return moveStateToNextToken(State, DryRun, Newline) + Penalty; 2551f80396dSAlexander Kornienko } 2561f80396dSAlexander Kornienko 25748437ce5SDaniel Jasper void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun, 2581f80396dSAlexander Kornienko unsigned ExtraSpaces) { 25971814b44SManuel Klimek FormatToken &Current = *State.NextToken; 2601f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 2611f80396dSAlexander Kornienko if (Current.is(tok::equal) && 26205cd5868SDaniel Jasper (State.Line->First->is(tok::kw_for) || Current.NestingLevel == 0) && 2631f80396dSAlexander Kornienko State.Stack.back().VariablePos == 0) { 2641f80396dSAlexander Kornienko State.Stack.back().VariablePos = State.Column; 2651f80396dSAlexander Kornienko // Move over * and & if they are bound to the variable name. 2661f80396dSAlexander Kornienko const FormatToken *Tok = &Previous; 2671f80396dSAlexander Kornienko while (Tok && State.Stack.back().VariablePos >= Tok->ColumnWidth) { 2681f80396dSAlexander Kornienko State.Stack.back().VariablePos -= Tok->ColumnWidth; 2691f80396dSAlexander Kornienko if (Tok->SpacesRequiredBefore != 0) 2701f80396dSAlexander Kornienko break; 2711f80396dSAlexander Kornienko Tok = Tok->Previous; 2721f80396dSAlexander Kornienko } 2731f80396dSAlexander Kornienko if (Previous.PartOfMultiVariableDeclStmt) 2741f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Stack.back().VariablePos; 2751f80396dSAlexander Kornienko } 2761f80396dSAlexander Kornienko 2771f80396dSAlexander Kornienko unsigned Spaces = Current.SpacesRequiredBefore + ExtraSpaces; 2781f80396dSAlexander Kornienko 2791f80396dSAlexander Kornienko if (!DryRun) 2801f80396dSAlexander Kornienko Whitespaces.replaceWhitespace(Current, /*Newlines=*/0, /*IndentLevel=*/0, 2811f80396dSAlexander Kornienko Spaces, State.Column + Spaces); 2821f80396dSAlexander Kornienko 28317062ff5SDaniel Jasper if (Current.Type == TT_SelectorName && 284b88b25feSDaniel Jasper !State.Stack.back().ObjCSelectorNameFound) { 285b88b25feSDaniel Jasper if (Current.LongestObjCSelectorName == 0) 286b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 287b88b25feSDaniel Jasper else if (State.Stack.back().Indent + Current.LongestObjCSelectorName > 2881f80396dSAlexander Kornienko State.Column + Spaces + Current.ColumnWidth) 2891f80396dSAlexander Kornienko State.Stack.back().ColonPos = 2901f80396dSAlexander Kornienko State.Stack.back().Indent + Current.LongestObjCSelectorName; 2911f80396dSAlexander Kornienko else 2921f80396dSAlexander Kornienko State.Stack.back().ColonPos = State.Column + Spaces + Current.ColumnWidth; 2931f80396dSAlexander Kornienko } 2941f80396dSAlexander Kornienko 2951f80396dSAlexander Kornienko if (Previous.opensScope() && Previous.Type != TT_ObjCMethodExpr && 2965a611397SDaniel Jasper (Current.Type != TT_LineComment || Previous.BlockKind == BK_BracedInit)) 2971f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column + Spaces; 298ec01cd6eSDaniel Jasper if (State.Stack.back().AvoidBinPacking && startsNextParameter(Current, Style)) 2991f80396dSAlexander Kornienko State.Stack.back().NoLineBreak = true; 3001f80396dSAlexander Kornienko if (startsSegmentOfBuilderTypeCall(Current)) 3011f80396dSAlexander Kornienko State.Stack.back().ContainsUnwrappedBuilder = true; 3021f80396dSAlexander Kornienko 3031f80396dSAlexander Kornienko State.Column += Spaces; 3048acf822bSDaniel Jasper if (Current.isNot(tok::comment) && Previous.is(tok::l_paren) && 3058acf822bSDaniel Jasper Previous.Previous && Previous.Previous->isOneOf(tok::kw_if, tok::kw_for)) 3061f80396dSAlexander Kornienko // Treat the condition inside an if as if it was a second function 3076633ab8aSDaniel Jasper // parameter, i.e. let nested calls have a continuation indent. 3088acf822bSDaniel Jasper State.Stack.back().LastSpace = State.Column; 309114a2bc9SDaniel Jasper else if (!Current.isOneOf(tok::comment, tok::caret) && 310b88b25feSDaniel Jasper (Previous.is(tok::comma) || 311b88b25feSDaniel Jasper (Previous.is(tok::colon) && Previous.Type == TT_ObjCMethodExpr))) 3121f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 3131f80396dSAlexander Kornienko else if ((Previous.Type == TT_BinaryOperator || 3141f80396dSAlexander Kornienko Previous.Type == TT_ConditionalExpr || 3151f80396dSAlexander Kornienko Previous.Type == TT_CtorInitializerColon) && 3160e61784aSDaniel Jasper ((Previous.getPrecedence() != prec::Assignment && 3170e61784aSDaniel Jasper (Previous.isNot(tok::lessless) || Previous.OperatorIndex != 0 || 3180e61784aSDaniel Jasper !Previous.LastOperator)) || 3191f80396dSAlexander Kornienko Current.StartsBinaryExpression)) 3201f80396dSAlexander Kornienko // Always indent relative to the RHS of the expression unless this is a 3211f80396dSAlexander Kornienko // simple assignment without binary expression on the RHS. Also indent 3221f80396dSAlexander Kornienko // relative to unary operators and the colons of constructor initializers. 3231f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 324f9a5e404SDaniel Jasper else if (Previous.Type == TT_InheritanceColon) { 3251f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column; 326f9a5e404SDaniel Jasper State.Stack.back().LastSpace = State.Column; 327f9a5e404SDaniel Jasper } else if (Previous.opensScope()) { 3281f80396dSAlexander Kornienko // If a function has a trailing call, indent all parameters from the 3291f80396dSAlexander Kornienko // opening parenthesis. This avoids confusing indents like: 3301f80396dSAlexander Kornienko // OuterFunction(InnerFunctionCall( // break 3311f80396dSAlexander Kornienko // ParameterToInnerFunction)) // break 3321f80396dSAlexander Kornienko // .SecondInnerFunctionCall(); 3331f80396dSAlexander Kornienko bool HasTrailingCall = false; 3341f80396dSAlexander Kornienko if (Previous.MatchingParen) { 3351f80396dSAlexander Kornienko const FormatToken *Next = Previous.MatchingParen->getNextNonComment(); 3361f80396dSAlexander Kornienko HasTrailingCall = Next && Next->isMemberAccess(); 3371f80396dSAlexander Kornienko } 3381f80396dSAlexander Kornienko if (HasTrailingCall && 3391f80396dSAlexander Kornienko State.Stack[State.Stack.size() - 2].CallContinuation == 0) 3401f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 3411f80396dSAlexander Kornienko } 3421f80396dSAlexander Kornienko } 3431f80396dSAlexander Kornienko 3441f80396dSAlexander Kornienko unsigned ContinuationIndenter::addTokenOnNewLine(LineState &State, 3451f80396dSAlexander Kornienko bool DryRun) { 34671814b44SManuel Klimek FormatToken &Current = *State.NextToken; 3471f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 3489f388d04SDaniel Jasper 3491f80396dSAlexander Kornienko // Extra penalty that needs to be added because of the way certain line 3501f80396dSAlexander Kornienko // breaks are chosen. 3511f80396dSAlexander Kornienko unsigned Penalty = 0; 3521f80396dSAlexander Kornienko 353a0407740SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 354a0407740SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 355a0407740SDaniel Jasper if (!NextNonComment) 356a0407740SDaniel Jasper NextNonComment = &Current; 35705cd5868SDaniel Jasper // The first line break on any NestingLevel causes an extra penalty in order 3588de9ed05SDaniel Jasper // prefer similar line breaks. 3598de9ed05SDaniel Jasper if (!State.Stack.back().ContainsLineBreak) 3608de9ed05SDaniel Jasper Penalty += 15; 3618de9ed05SDaniel Jasper State.Stack.back().ContainsLineBreak = true; 3628de9ed05SDaniel Jasper 3638de9ed05SDaniel Jasper Penalty += State.NextToken->SplitPenalty; 3648de9ed05SDaniel Jasper 365de0328aeSDaniel Jasper // Breaking before the first "<<" is generally not desirable if the LHS is 36648437ce5SDaniel Jasper // short. Also always add the penalty if the LHS is split over mutliple lines 3672b7556ecSDaniel Jasper // to avoid unnecessary line breaks that just work around this penalty. 368a0407740SDaniel Jasper if (NextNonComment->is(tok::lessless) && 369a0407740SDaniel Jasper State.Stack.back().FirstLessLess == 0 && 370004177eeSDaniel Jasper (State.Column <= Style.ColumnLimit / 3 || 37148437ce5SDaniel Jasper State.Stack.back().BreakBeforeParameter)) 3728de9ed05SDaniel Jasper Penalty += Style.PenaltyBreakFirstLessLess; 373de0328aeSDaniel Jasper 3749f388d04SDaniel Jasper State.Column = getNewLineColumn(State); 3759f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 3769f388d04SDaniel Jasper if (State.Stack.back().CallContinuation == 0) 377de0328aeSDaniel Jasper State.Stack.back().CallContinuation = State.Column; 37817062ff5SDaniel Jasper } else if (NextNonComment->Type == TT_SelectorName) { 379b88b25feSDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 380a0407740SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) { 381b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 382b88b25feSDaniel Jasper } else { 383b302f9a0SDaniel Jasper State.Stack.back().ColonPos = 384a0407740SDaniel Jasper State.Stack.back().Indent + NextNonComment->LongestObjCSelectorName; 385b88b25feSDaniel Jasper } 3869f388d04SDaniel Jasper } else if (State.Stack.back().AlignColons && 3879f388d04SDaniel Jasper State.Stack.back().ColonPos <= NextNonComment->ColumnWidth) { 388a0407740SDaniel Jasper State.Stack.back().ColonPos = State.Column + NextNonComment->ColumnWidth; 389de0328aeSDaniel Jasper } 3901fd6f1f8SDaniel Jasper } else if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 3911fd6f1f8SDaniel Jasper (PreviousNonComment->Type == TT_ObjCMethodExpr || 3921fd6f1f8SDaniel Jasper PreviousNonComment->Type == TT_DictLiteral)) { 393b88b25feSDaniel Jasper // FIXME: This is hacky, find a better way. The problem is that in an ObjC 394b88b25feSDaniel Jasper // method expression, the block should be aligned to the line starting it, 395b88b25feSDaniel Jasper // e.g.: 396b88b25feSDaniel Jasper // [aaaaaaaaaaaaaaa aaaaaaaaa: \\ break for some reason 397b88b25feSDaniel Jasper // ^(int *i) { 398b88b25feSDaniel Jasper // // ... 399b88b25feSDaniel Jasper // }]; 40005cd5868SDaniel Jasper // Thus, we set LastSpace of the next higher NestingLevel, to which we move 401b88b25feSDaniel Jasper // when we consume all of the "}"'s FakeRParens at the "{". 4029a26e773SDaniel Jasper if (State.Stack.size() > 1) 4039f388d04SDaniel Jasper State.Stack[State.Stack.size() - 2].LastSpace = 4049f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 4059f388d04SDaniel Jasper Style.ContinuationIndentWidth; 406de0328aeSDaniel Jasper } 407de0328aeSDaniel Jasper 408de0328aeSDaniel Jasper if ((Previous.isOneOf(tok::comma, tok::semi) && 409de0328aeSDaniel Jasper !State.Stack.back().AvoidBinPacking) || 410de0328aeSDaniel Jasper Previous.Type == TT_BinaryOperator) 411de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 41205cd5868SDaniel Jasper if (Previous.Type == TT_TemplateCloser && Current.NestingLevel == 0) 413de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 414a0407740SDaniel Jasper if (NextNonComment->is(tok::question) || 415165b29e2SDaniel Jasper (PreviousNonComment && PreviousNonComment->is(tok::question))) 416165b29e2SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 417de0328aeSDaniel Jasper 418de0328aeSDaniel Jasper if (!DryRun) { 419a69ca9beSDaniel Jasper unsigned Newlines = std::max( 420a69ca9beSDaniel Jasper 1u, std::min(Current.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1)); 421e2e0387fSAlexander Kornienko Whitespaces.replaceWhitespace(Current, Newlines, 422e2e0387fSAlexander Kornienko State.Stack.back().IndentLevel, State.Column, 423e2e0387fSAlexander Kornienko State.Column, State.Line->InPPDirective); 424de0328aeSDaniel Jasper } 425de0328aeSDaniel Jasper 426de0328aeSDaniel Jasper if (!Current.isTrailingComment()) 427de0328aeSDaniel Jasper State.Stack.back().LastSpace = State.Column; 42805cd5868SDaniel Jasper State.StartOfLineLevel = Current.NestingLevel; 42905cd5868SDaniel Jasper State.LowestLevelOnLine = Current.NestingLevel; 430de0328aeSDaniel Jasper 431de0328aeSDaniel Jasper // Any break on this level means that the parent level has been broken 432de0328aeSDaniel Jasper // and we need to avoid bin packing there. 433b16b969dSDaniel Jasper bool JavaScriptFormat = Style.Language == FormatStyle::LK_JavaScript && 434b16b969dSDaniel Jasper Current.is(tok::r_brace) && 435b16b969dSDaniel Jasper State.Stack.size() > 1 && 436b16b969dSDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined; 437b16b969dSDaniel Jasper if (!JavaScriptFormat) { 438de0328aeSDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { 439de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 440de0328aeSDaniel Jasper } 441b16b969dSDaniel Jasper } 442b16b969dSDaniel Jasper 4439e5ede0fSDaniel Jasper if (PreviousNonComment && 4449e5ede0fSDaniel Jasper !PreviousNonComment->isOneOf(tok::comma, tok::semi) && 4459e5ede0fSDaniel Jasper PreviousNonComment->Type != TT_TemplateCloser && 4469e5ede0fSDaniel Jasper PreviousNonComment->Type != TT_BinaryOperator && 447b05a81deSDaniel Jasper Current.Type != TT_BinaryOperator && !PreviousNonComment->opensScope()) 448de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 449de0328aeSDaniel Jasper 4501db6c386SDaniel Jasper // If we break after { or the [ of an array initializer, we should also break 4511db6c386SDaniel Jasper // before the corresponding } or ]. 45290818057SDaniel Jasper if (PreviousNonComment && 45390818057SDaniel Jasper (PreviousNonComment->is(tok::l_brace) || 45490818057SDaniel Jasper PreviousNonComment->Type == TT_ArrayInitializerLSquare)) 455de0328aeSDaniel Jasper State.Stack.back().BreakBeforeClosingBrace = true; 456de0328aeSDaniel Jasper 457de0328aeSDaniel Jasper if (State.Stack.back().AvoidBinPacking) { 458de0328aeSDaniel Jasper // If we are breaking after '(', '{', '<', this is not bin packing 4592a958321SDaniel Jasper // unless AllowAllParametersOfDeclarationOnNextLine is false or this is a 4602a958321SDaniel Jasper // dict/object literal. 461de0328aeSDaniel Jasper if (!(Previous.isOneOf(tok::l_paren, tok::l_brace) || 462de0328aeSDaniel Jasper Previous.Type == TT_BinaryOperator) || 463de0328aeSDaniel Jasper (!Style.AllowAllParametersOfDeclarationOnNextLine && 4642a958321SDaniel Jasper State.Line->MustBeDeclaration) || 4652a958321SDaniel Jasper Previous.Type == TT_DictLiteral) 466de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 467de0328aeSDaniel Jasper } 468de0328aeSDaniel Jasper 4691f80396dSAlexander Kornienko return Penalty; 470de0328aeSDaniel Jasper } 471de0328aeSDaniel Jasper 4729f388d04SDaniel Jasper unsigned ContinuationIndenter::getNewLineColumn(const LineState &State) { 4735d2587daSDaniel Jasper if (!State.NextToken || !State.NextToken->Previous) 4745d2587daSDaniel Jasper return 0; 4759f388d04SDaniel Jasper FormatToken &Current = *State.NextToken; 4769f388d04SDaniel Jasper const FormatToken &Previous = *State.NextToken->Previous; 4779f388d04SDaniel Jasper // If we are continuing an expression, we want to use the continuation indent. 4789f388d04SDaniel Jasper unsigned ContinuationIndent = 4799f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 4809f388d04SDaniel Jasper Style.ContinuationIndentWidth; 4819f388d04SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 4829f388d04SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 4839f388d04SDaniel Jasper if (!NextNonComment) 4849f388d04SDaniel Jasper NextNonComment = &Current; 485b05a81deSDaniel Jasper if (NextNonComment->is(tok::l_brace) && NextNonComment->BlockKind == BK_Block) 48605cd5868SDaniel Jasper return Current.NestingLevel == 0 ? State.FirstIndent 4879f388d04SDaniel Jasper : State.Stack.back().Indent; 4889f388d04SDaniel Jasper if (Current.isOneOf(tok::r_brace, tok::r_square)) { 489b16b969dSDaniel Jasper if (State.Stack.size() > 1 && 490b16b969dSDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined) 491b16b969dSDaniel Jasper return State.FirstIndent; 4929f388d04SDaniel Jasper if (Current.closesBlockTypeList(Style) || 4939f388d04SDaniel Jasper (Current.MatchingParen && 4949f388d04SDaniel Jasper Current.MatchingParen->BlockKind == BK_BracedInit)) 4959f388d04SDaniel Jasper return State.Stack[State.Stack.size() - 2].LastSpace; 4969f388d04SDaniel Jasper else 4979f388d04SDaniel Jasper return State.FirstIndent; 4989f388d04SDaniel Jasper } 499783bac6bSDaniel Jasper if (Current.is(tok::identifier) && Current.Next && 500783bac6bSDaniel Jasper Current.Next->Type == TT_DictLiteral) 501783bac6bSDaniel Jasper return State.Stack.back().Indent; 5029f388d04SDaniel Jasper if (NextNonComment->isStringLiteral() && State.StartOfStringLiteral != 0) 5039f388d04SDaniel Jasper return State.StartOfStringLiteral; 5049f388d04SDaniel Jasper if (NextNonComment->is(tok::lessless) && 5059f388d04SDaniel Jasper State.Stack.back().FirstLessLess != 0) 5069f388d04SDaniel Jasper return State.Stack.back().FirstLessLess; 5079f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 5089f388d04SDaniel Jasper if (State.Stack.back().CallContinuation == 0) { 5099f388d04SDaniel Jasper return ContinuationIndent; 5109f388d04SDaniel Jasper } else { 5119f388d04SDaniel Jasper return State.Stack.back().CallContinuation; 5129f388d04SDaniel Jasper } 5139f388d04SDaniel Jasper } 5149f388d04SDaniel Jasper if (State.Stack.back().QuestionColumn != 0 && 515c0d606a5SDaniel Jasper ((NextNonComment->is(tok::colon) && 516c0d606a5SDaniel Jasper NextNonComment->Type == TT_ConditionalExpr) || 5179f388d04SDaniel Jasper Previous.Type == TT_ConditionalExpr)) 5189f388d04SDaniel Jasper return State.Stack.back().QuestionColumn; 5199f388d04SDaniel Jasper if (Previous.is(tok::comma) && State.Stack.back().VariablePos != 0) 5209f388d04SDaniel Jasper return State.Stack.back().VariablePos; 5219f388d04SDaniel Jasper if ((PreviousNonComment && (PreviousNonComment->ClosesTemplateDeclaration || 5229f388d04SDaniel Jasper PreviousNonComment->Type == TT_AttributeParen)) || 523*4355e7f0SDaniel Jasper NextNonComment->is(tok::kw_operator) || 524*4355e7f0SDaniel Jasper NextNonComment->Type == TT_FunctionDeclarationName) 5259f388d04SDaniel Jasper return std::max(State.Stack.back().LastSpace, State.Stack.back().Indent); 52617062ff5SDaniel Jasper if (NextNonComment->Type == TT_SelectorName) { 5279f388d04SDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 5289f388d04SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) { 5299f388d04SDaniel Jasper return State.Stack.back().Indent; 5309f388d04SDaniel Jasper } else { 5319f388d04SDaniel Jasper return State.Stack.back().Indent + 5329f388d04SDaniel Jasper NextNonComment->LongestObjCSelectorName - 5339f388d04SDaniel Jasper NextNonComment->ColumnWidth; 5349f388d04SDaniel Jasper } 5359f388d04SDaniel Jasper } else if (!State.Stack.back().AlignColons) { 5369f388d04SDaniel Jasper return State.Stack.back().Indent; 5379f388d04SDaniel Jasper } else if (State.Stack.back().ColonPos > NextNonComment->ColumnWidth) { 5389f388d04SDaniel Jasper return State.Stack.back().ColonPos - NextNonComment->ColumnWidth; 5399f388d04SDaniel Jasper } else { 5409f388d04SDaniel Jasper return State.Stack.back().Indent; 5419f388d04SDaniel Jasper } 5429f388d04SDaniel Jasper } 5439f388d04SDaniel Jasper if (NextNonComment->Type == TT_ArraySubscriptLSquare) { 5449f388d04SDaniel Jasper if (State.Stack.back().StartOfArraySubscripts != 0) 5459f388d04SDaniel Jasper return State.Stack.back().StartOfArraySubscripts; 5469f388d04SDaniel Jasper else 5479f388d04SDaniel Jasper return ContinuationIndent; 5489f388d04SDaniel Jasper } 5499f388d04SDaniel Jasper if (NextNonComment->Type == TT_StartOfName || 5509f388d04SDaniel Jasper Previous.isOneOf(tok::coloncolon, tok::equal)) { 5519f388d04SDaniel Jasper return ContinuationIndent; 5529f388d04SDaniel Jasper } 5539f388d04SDaniel Jasper if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 5549f388d04SDaniel Jasper (PreviousNonComment->Type == TT_ObjCMethodExpr || 5559f388d04SDaniel Jasper PreviousNonComment->Type == TT_DictLiteral)) 5569f388d04SDaniel Jasper return ContinuationIndent; 5579f388d04SDaniel Jasper if (NextNonComment->Type == TT_CtorInitializerColon) 5589f388d04SDaniel Jasper return State.FirstIndent + Style.ConstructorInitializerIndentWidth; 5599f388d04SDaniel Jasper if (NextNonComment->Type == TT_CtorInitializerComma) 5609f388d04SDaniel Jasper return State.Stack.back().Indent; 5615d2587daSDaniel Jasper if (State.Stack.back().Indent == State.FirstIndent && PreviousNonComment && 5629f388d04SDaniel Jasper PreviousNonComment->isNot(tok::r_brace)) 5639f388d04SDaniel Jasper // Ensure that we fall back to the continuation indent width instead of 5649f388d04SDaniel Jasper // just flushing continuations left. 5659f388d04SDaniel Jasper return State.Stack.back().Indent + Style.ContinuationIndentWidth; 5669f388d04SDaniel Jasper return State.Stack.back().Indent; 5679f388d04SDaniel Jasper } 5689f388d04SDaniel Jasper 569de0328aeSDaniel Jasper unsigned ContinuationIndenter::moveStateToNextToken(LineState &State, 570de0328aeSDaniel Jasper bool DryRun, bool Newline) { 571de0328aeSDaniel Jasper assert(State.Stack.size()); 57260553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 573de0328aeSDaniel Jasper 574de0328aeSDaniel Jasper if (Current.Type == TT_InheritanceColon) 575de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 576c0d606a5SDaniel Jasper if (Current.is(tok::lessless) && Current.Type != TT_OverloadedOperator) { 577c0d606a5SDaniel Jasper if (State.Stack.back().FirstLessLess == 0) 578de0328aeSDaniel Jasper State.Stack.back().FirstLessLess = State.Column; 579c0d606a5SDaniel Jasper else 580c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 581c0d606a5SDaniel Jasper } 582c0d606a5SDaniel Jasper if ((Current.Type == TT_BinaryOperator && Current.isNot(tok::lessless)) || 583c0d606a5SDaniel Jasper Current.Type == TT_ConditionalExpr) 584c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 5851db6c386SDaniel Jasper if (Current.Type == TT_ArraySubscriptLSquare && 586de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts == 0) 587de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = State.Column; 588165b29e2SDaniel Jasper if ((Current.is(tok::question) && Style.BreakBeforeTernaryOperators) || 589165b29e2SDaniel Jasper (Current.getPreviousNonComment() && Current.isNot(tok::colon) && 590165b29e2SDaniel Jasper Current.getPreviousNonComment()->is(tok::question) && 591165b29e2SDaniel Jasper !Style.BreakBeforeTernaryOperators)) 592de0328aeSDaniel Jasper State.Stack.back().QuestionColumn = State.Column; 593de0328aeSDaniel Jasper if (!Current.opensScope() && !Current.closesScope()) 594de0328aeSDaniel Jasper State.LowestLevelOnLine = 59505cd5868SDaniel Jasper std::min(State.LowestLevelOnLine, Current.NestingLevel); 5964c6e0059SDaniel Jasper if (Current.isMemberAccess()) 597de0328aeSDaniel Jasper State.Stack.back().StartOfFunctionCall = 5980e61784aSDaniel Jasper Current.LastOperator ? 0 : State.Column + Current.ColumnWidth; 59917062ff5SDaniel Jasper if (Current.Type == TT_SelectorName) 600b88b25feSDaniel Jasper State.Stack.back().ObjCSelectorNameFound = true; 601de0328aeSDaniel Jasper if (Current.Type == TT_CtorInitializerColon) { 602de0328aeSDaniel Jasper // Indent 2 from the column, so: 603de0328aeSDaniel Jasper // SomeClass::SomeClass() 604de0328aeSDaniel Jasper // : First(...), ... 605de0328aeSDaniel Jasper // Next(...) 606de0328aeSDaniel Jasper // ^ line up here. 607de0328aeSDaniel Jasper State.Stack.back().Indent = 608de0328aeSDaniel Jasper State.Column + (Style.BreakConstructorInitializersBeforeComma ? 0 : 2); 609de0328aeSDaniel Jasper if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine) 610de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 611de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 612de0328aeSDaniel Jasper } 613de0328aeSDaniel Jasper 614de0328aeSDaniel Jasper // In ObjC method declaration we align on the ":" of parameters, but we need 6156633ab8aSDaniel Jasper // to ensure that we indent parameters on subsequent lines by at least our 6166633ab8aSDaniel Jasper // continuation indent width. 617de0328aeSDaniel Jasper if (Current.Type == TT_ObjCMethodSpecifier) 6186633ab8aSDaniel Jasper State.Stack.back().Indent += Style.ContinuationIndentWidth; 619de0328aeSDaniel Jasper 620de0328aeSDaniel Jasper // Insert scopes created by fake parenthesis. 621de0328aeSDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 622b16b969dSDaniel Jasper 623b16b969dSDaniel Jasper // Add special behavior to support a format commonly used for JavaScript 624b16b969dSDaniel Jasper // closures: 625b16b969dSDaniel Jasper // SomeFunction(function() { 626b16b969dSDaniel Jasper // foo(); 627b16b969dSDaniel Jasper // bar(); 628b16b969dSDaniel Jasper // }, a, b, c); 629b16b969dSDaniel Jasper if (Style.Language == FormatStyle::LK_JavaScript) { 630b16b969dSDaniel Jasper if (Current.isNot(tok::comment) && Previous && Previous->is(tok::l_brace) && 631b16b969dSDaniel Jasper State.Stack.size() > 1) { 632b16b969dSDaniel Jasper if (State.Stack[State.Stack.size() - 2].JSFunctionInlined && Newline) { 633b16b969dSDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { 634b16b969dSDaniel Jasper State.Stack[i].NoLineBreak = true; 635b16b969dSDaniel Jasper } 636b16b969dSDaniel Jasper } 637b16b969dSDaniel Jasper State.Stack[State.Stack.size() - 2].JSFunctionInlined = false; 638b16b969dSDaniel Jasper } 639b16b969dSDaniel Jasper if (Current.TokenText == "function") 640b16b969dSDaniel Jasper State.Stack.back().JSFunctionInlined = !Newline; 641b16b969dSDaniel Jasper } 642b16b969dSDaniel Jasper 64360553be5SDaniel Jasper moveStatePastFakeLParens(State, Newline); 64460553be5SDaniel Jasper moveStatePastScopeOpener(State, Newline); 64560553be5SDaniel Jasper moveStatePastScopeCloser(State); 64660553be5SDaniel Jasper moveStatePastFakeRParens(State); 64760553be5SDaniel Jasper 64860553be5SDaniel Jasper if (Current.isStringLiteral() && State.StartOfStringLiteral == 0) { 64960553be5SDaniel Jasper State.StartOfStringLiteral = State.Column; 65060553be5SDaniel Jasper } else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash) && 65160553be5SDaniel Jasper !Current.isStringLiteral()) { 65260553be5SDaniel Jasper State.StartOfStringLiteral = 0; 65360553be5SDaniel Jasper } 65460553be5SDaniel Jasper 65560553be5SDaniel Jasper State.Column += Current.ColumnWidth; 65660553be5SDaniel Jasper State.NextToken = State.NextToken->Next; 65760553be5SDaniel Jasper unsigned Penalty = breakProtrudingToken(Current, State, DryRun); 65860553be5SDaniel Jasper if (State.Column > getColumnLimit(State)) { 65960553be5SDaniel Jasper unsigned ExcessCharacters = State.Column - getColumnLimit(State); 66060553be5SDaniel Jasper Penalty += Style.PenaltyExcessCharacter * ExcessCharacters; 66160553be5SDaniel Jasper } 66260553be5SDaniel Jasper 66360553be5SDaniel Jasper if (Current.Role) 66460553be5SDaniel Jasper Current.Role->formatFromToken(State, this, DryRun); 66560553be5SDaniel Jasper // If the previous has a special role, let it consume tokens as appropriate. 66660553be5SDaniel Jasper // It is necessary to start at the previous token for the only implemented 66760553be5SDaniel Jasper // role (comma separated list). That way, the decision whether or not to break 66860553be5SDaniel Jasper // after the "{" is already done and both options are tried and evaluated. 66960553be5SDaniel Jasper // FIXME: This is ugly, find a better way. 67060553be5SDaniel Jasper if (Previous && Previous->Role) 67160553be5SDaniel Jasper Penalty += Previous->Role->formatAfterToken(State, this, DryRun); 67260553be5SDaniel Jasper 67360553be5SDaniel Jasper return Penalty; 67460553be5SDaniel Jasper } 67560553be5SDaniel Jasper 67660553be5SDaniel Jasper void ContinuationIndenter::moveStatePastFakeLParens(LineState &State, 67760553be5SDaniel Jasper bool Newline) { 67860553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 67960553be5SDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 68060553be5SDaniel Jasper 681de0328aeSDaniel Jasper // Don't add extra indentation for the first fake parenthesis after 6820db806b7SDinesh Dwivedi // 'return', assignments or opening <({[. The indentation for these cases 683de0328aeSDaniel Jasper // is special cased. 684de0328aeSDaniel Jasper bool SkipFirstExtraIndent = 685eabede6dSDaniel Jasper (Previous && (Previous->opensScope() || Previous->is(tok::kw_return) || 686f48b5abcSDaniel Jasper Previous->getPrecedence() == prec::Assignment || 687f48b5abcSDaniel Jasper Previous->Type == TT_ObjCMethodExpr)); 688de0328aeSDaniel Jasper for (SmallVectorImpl<prec::Level>::const_reverse_iterator 689de0328aeSDaniel Jasper I = Current.FakeLParens.rbegin(), 690de0328aeSDaniel Jasper E = Current.FakeLParens.rend(); 691de0328aeSDaniel Jasper I != E; ++I) { 692de0328aeSDaniel Jasper ParenState NewParenState = State.Stack.back(); 693de0328aeSDaniel Jasper NewParenState.ContainsLineBreak = false; 694eabede6dSDaniel Jasper 695eabede6dSDaniel Jasper // Indent from 'LastSpace' unless this the fake parentheses encapsulating a 696eabede6dSDaniel Jasper // builder type call after 'return'. If such a call is line-wrapped, we 697eabede6dSDaniel Jasper // commonly just want to indent from the start of the line. 698eabede6dSDaniel Jasper if (!Previous || Previous->isNot(tok::kw_return) || *I > 0) 699de0328aeSDaniel Jasper NewParenState.Indent = 700de0328aeSDaniel Jasper std::max(std::max(State.Column, NewParenState.Indent), 701de0328aeSDaniel Jasper State.Stack.back().LastSpace); 702eabede6dSDaniel Jasper 7035c33265cSDaniel Jasper // Don't allow the RHS of an operator to be split over multiple lines unless 7045c33265cSDaniel Jasper // there is a line-break right after the operator. 7055c33265cSDaniel Jasper // Exclude relational operators, as there, it is always more desirable to 7065c33265cSDaniel Jasper // have the LHS 'left' of the RHS. 707c0d606a5SDaniel Jasper if (Previous && Previous->getPrecedence() > prec::Assignment && 708c0d606a5SDaniel Jasper (Previous->Type == TT_BinaryOperator || 709c0d606a5SDaniel Jasper Previous->Type == TT_ConditionalExpr) && 710c0d606a5SDaniel Jasper Previous->getPrecedence() != prec::Relational) { 711c0d606a5SDaniel Jasper bool BreakBeforeOperator = Previous->is(tok::lessless) || 712c0d606a5SDaniel Jasper (Previous->Type == TT_BinaryOperator && 713c0d606a5SDaniel Jasper Style.BreakBeforeBinaryOperators) || 714c0d606a5SDaniel Jasper (Previous->Type == TT_ConditionalExpr && 715c0d606a5SDaniel Jasper Style.BreakBeforeTernaryOperators); 716c0d606a5SDaniel Jasper if ((!Newline && !BreakBeforeOperator) || 717c0d606a5SDaniel Jasper (!State.Stack.back().LastOperatorWrapped && BreakBeforeOperator)) 7185c33265cSDaniel Jasper NewParenState.NoLineBreak = true; 719c0d606a5SDaniel Jasper } 7205c33265cSDaniel Jasper 7219fe0e8daSDaniel Jasper // Do not indent relative to the fake parentheses inserted for "." or "->". 7229fe0e8daSDaniel Jasper // This is a special case to make the following to statements consistent: 7239fe0e8daSDaniel Jasper // OuterFunction(InnerFunctionCall( // break 7249fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 7259fe0e8daSDaniel Jasper // OuterFunction(SomeObject.InnerFunctionCall( // break 7269fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 7279fe0e8daSDaniel Jasper if (*I > prec::Unknown) 7289fe0e8daSDaniel Jasper NewParenState.LastSpace = std::max(NewParenState.LastSpace, State.Column); 72996964359SDaniel Jasper NewParenState.StartOfFunctionCall = State.Column; 730de0328aeSDaniel Jasper 731de0328aeSDaniel Jasper // Always indent conditional expressions. Never indent expression where 732de0328aeSDaniel Jasper // the 'operator' is ',', ';' or an assignment (i.e. *I <= 733de0328aeSDaniel Jasper // prec::Assignment) as those have different indentation rules. Indent 734de0328aeSDaniel Jasper // other expression, unless the indentation needs to be skipped. 735de0328aeSDaniel Jasper if (*I == prec::Conditional || 736de0328aeSDaniel Jasper (!SkipFirstExtraIndent && *I > prec::Assignment && 737de0328aeSDaniel Jasper !Style.BreakBeforeBinaryOperators)) 7386633ab8aSDaniel Jasper NewParenState.Indent += Style.ContinuationIndentWidth; 7391db6c386SDaniel Jasper if ((Previous && !Previous->opensScope()) || *I > prec::Comma) 740de0328aeSDaniel Jasper NewParenState.BreakBeforeParameter = false; 741de0328aeSDaniel Jasper State.Stack.push_back(NewParenState); 742de0328aeSDaniel Jasper SkipFirstExtraIndent = false; 743de0328aeSDaniel Jasper } 74460553be5SDaniel Jasper } 745de0328aeSDaniel Jasper 746335ff266SDaniel Jasper // Remove the fake r_parens after 'Tok'. 747335ff266SDaniel Jasper static void consumeRParens(LineState& State, const FormatToken &Tok) { 748335ff266SDaniel Jasper for (unsigned i = 0, e = Tok.FakeRParens; i != e; ++i) { 74960553be5SDaniel Jasper unsigned VariablePos = State.Stack.back().VariablePos; 750819788daSManuel Klimek assert(State.Stack.size() > 1); 751819788daSManuel Klimek if (State.Stack.size() == 1) { 752819788daSManuel Klimek // Do not pop the last element. 753819788daSManuel Klimek break; 754819788daSManuel Klimek } 7559fe0e8daSDaniel Jasper State.Stack.pop_back(); 75660553be5SDaniel Jasper State.Stack.back().VariablePos = VariablePos; 757819788daSManuel Klimek } 75860553be5SDaniel Jasper } 759335ff266SDaniel Jasper 760335ff266SDaniel Jasper // Returns whether 'Tok' opens or closes a scope requiring special handling 761335ff266SDaniel Jasper // of the subsequent fake r_parens. 762335ff266SDaniel Jasper // 763335ff266SDaniel Jasper // For example, if this is an l_brace starting a nested block, we pretend (wrt. 764335ff266SDaniel Jasper // to indentation) that we already consumed the corresponding r_brace. Thus, we 765335ff266SDaniel Jasper // remove all ParenStates caused by fake parentheses that end at the r_brace. 766335ff266SDaniel Jasper // The net effect of this is that we don't indent relative to the l_brace, if 767335ff266SDaniel Jasper // the nested block is the last parameter of a function. This formats: 768335ff266SDaniel Jasper // 769335ff266SDaniel Jasper // SomeFunction(a, [] { 770335ff266SDaniel Jasper // f(); // break 771335ff266SDaniel Jasper // }); 772335ff266SDaniel Jasper // 773335ff266SDaniel Jasper // instead of: 774335ff266SDaniel Jasper // SomeFunction(a, [] { 775335ff266SDaniel Jasper // f(); // break 776335ff266SDaniel Jasper // }); 777114a2bc9SDaniel Jasper static bool fakeRParenSpecialCase(const LineState &State) { 778114a2bc9SDaniel Jasper const FormatToken &Tok = *State.NextToken; 779335ff266SDaniel Jasper if (!Tok.MatchingParen) 780335ff266SDaniel Jasper return false; 781335ff266SDaniel Jasper const FormatToken *Left = &Tok; 782335ff266SDaniel Jasper if (Tok.isOneOf(tok::r_brace, tok::r_square)) 783335ff266SDaniel Jasper Left = Tok.MatchingParen; 784114a2bc9SDaniel Jasper return !State.Stack.back().HasMultipleNestedBlocks && 785114a2bc9SDaniel Jasper Left->isOneOf(tok::l_brace, tok::l_square) && 786335ff266SDaniel Jasper (Left->BlockKind == BK_Block || 787335ff266SDaniel Jasper Left->Type == TT_ArrayInitializerLSquare || 788335ff266SDaniel Jasper Left->Type == TT_DictLiteral); 789335ff266SDaniel Jasper } 790335ff266SDaniel Jasper 791335ff266SDaniel Jasper void ContinuationIndenter::moveStatePastFakeRParens(LineState &State) { 792335ff266SDaniel Jasper // Don't remove FakeRParens attached to r_braces that surround nested blocks 793335ff266SDaniel Jasper // as they will have been removed early (see above). 794114a2bc9SDaniel Jasper if (fakeRParenSpecialCase(State)) 795335ff266SDaniel Jasper return; 796335ff266SDaniel Jasper 797335ff266SDaniel Jasper consumeRParens(State, *State.NextToken); 79860553be5SDaniel Jasper } 79960553be5SDaniel Jasper 80060553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeOpener(LineState &State, 80160553be5SDaniel Jasper bool Newline) { 80260553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 80360553be5SDaniel Jasper if (!Current.opensScope()) 80460553be5SDaniel Jasper return; 80560553be5SDaniel Jasper 80660553be5SDaniel Jasper if (Current.MatchingParen && Current.BlockKind == BK_Block) { 80760553be5SDaniel Jasper moveStateToNewBlock(State); 80860553be5SDaniel Jasper return; 80960553be5SDaniel Jasper } 81060553be5SDaniel Jasper 81160553be5SDaniel Jasper unsigned NewIndent; 81260553be5SDaniel Jasper unsigned NewIndentLevel = State.Stack.back().IndentLevel; 81360553be5SDaniel Jasper bool AvoidBinPacking; 81460553be5SDaniel Jasper bool BreakBeforeParameter = false; 81560553be5SDaniel Jasper if (Current.is(tok::l_brace) || Current.Type == TT_ArrayInitializerLSquare) { 816114a2bc9SDaniel Jasper if (fakeRParenSpecialCase(State)) 817335ff266SDaniel Jasper consumeRParens(State, *Current.MatchingParen); 818335ff266SDaniel Jasper 819e2e0387fSAlexander Kornienko NewIndent = State.Stack.back().LastSpace; 820b8f61682SDaniel Jasper if (Current.opensBlockTypeList(Style)) { 821e2e0387fSAlexander Kornienko NewIndent += Style.IndentWidth; 8225a611397SDaniel Jasper NewIndent = std::min(State.Column + 2, NewIndent); 823e2e0387fSAlexander Kornienko ++NewIndentLevel; 824b8f61682SDaniel Jasper } else { 825b8f61682SDaniel Jasper NewIndent += Style.ContinuationIndentWidth; 8265a611397SDaniel Jasper NewIndent = std::min(State.Column + 1, NewIndent); 827e2e0387fSAlexander Kornienko } 828de0328aeSDaniel Jasper const FormatToken *NextNoComment = Current.getNextNonComment(); 82960553be5SDaniel Jasper AvoidBinPacking = Current.Type == TT_ArrayInitializerLSquare || 830b596fb2bSDaniel Jasper Current.Type == TT_DictLiteral || 831883ae9d9SDaniel Jasper Style.Language == FormatStyle::LK_Proto || 832ae8e0d8dSDaniel Jasper !Style.BinPackParameters || 833015ed028SDaniel Jasper (NextNoComment && 834015ed028SDaniel Jasper NextNoComment->Type == TT_DesignatedInitializerPeriod); 835de0328aeSDaniel Jasper } else { 8366633ab8aSDaniel Jasper NewIndent = Style.ContinuationIndentWidth + 8376633ab8aSDaniel Jasper std::max(State.Stack.back().LastSpace, 8389fe0e8daSDaniel Jasper State.Stack.back().StartOfFunctionCall); 839de0328aeSDaniel Jasper AvoidBinPacking = !Style.BinPackParameters || 840de0328aeSDaniel Jasper (Style.ExperimentalAutoDetectBinPacking && 841de0328aeSDaniel Jasper (Current.PackingKind == PPK_OnePerLine || 842de0328aeSDaniel Jasper (!BinPackInconclusiveFunctions && 843de0328aeSDaniel Jasper Current.PackingKind == PPK_Inconclusive))); 8441db6c386SDaniel Jasper // If this '[' opens an ObjC call, determine whether all parameters fit 8451db6c386SDaniel Jasper // into one line and put one per line if they don't. 8467f0c5171SDaniel Jasper if (Current.Type == TT_ObjCMethodExpr && Style.ColumnLimit != 0 && 8471db6c386SDaniel Jasper getLengthToMatchingParen(Current) + State.Column > 8481db6c386SDaniel Jasper getColumnLimit(State)) 8491db6c386SDaniel Jasper BreakBeforeParameter = true; 850de0328aeSDaniel Jasper } 851cc3114d8SDaniel Jasper bool NoLineBreak = State.Stack.back().NoLineBreak || 852cc3114d8SDaniel Jasper (Current.Type == TT_TemplateOpener && 853cc3114d8SDaniel Jasper State.Stack.back().ContainsUnwrappedBuilder); 854cc3114d8SDaniel Jasper State.Stack.push_back(ParenState(NewIndent, NewIndentLevel, 855cc3114d8SDaniel Jasper State.Stack.back().LastSpace, 856cc3114d8SDaniel Jasper AvoidBinPacking, NoLineBreak)); 8571db6c386SDaniel Jasper State.Stack.back().BreakBeforeParameter = BreakBeforeParameter; 858114a2bc9SDaniel Jasper State.Stack.back().HasMultipleNestedBlocks = Current.BlockParameterCount > 1; 859de0328aeSDaniel Jasper } 860de0328aeSDaniel Jasper 86160553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) { 86260553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 86360553be5SDaniel Jasper if (!Current.closesScope()) 86460553be5SDaniel Jasper return; 86560553be5SDaniel Jasper 866de0328aeSDaniel Jasper // If we encounter a closing ), ], } or >, we can remove a level from our 867de0328aeSDaniel Jasper // stacks. 86896df37a6SDaniel Jasper if (State.Stack.size() > 1 && 86996df37a6SDaniel Jasper (Current.isOneOf(tok::r_paren, tok::r_square) || 8709fe0e8daSDaniel Jasper (Current.is(tok::r_brace) && State.NextToken != State.Line->First) || 871335ff266SDaniel Jasper State.NextToken->Type == TT_TemplateCloser)) 872de0328aeSDaniel Jasper State.Stack.pop_back(); 873335ff266SDaniel Jasper 874de0328aeSDaniel Jasper if (Current.is(tok::r_square)) { 875de0328aeSDaniel Jasper // If this ends the array subscript expr, reset the corresponding value. 876de0328aeSDaniel Jasper const FormatToken *NextNonComment = Current.getNextNonComment(); 877de0328aeSDaniel Jasper if (NextNonComment && NextNonComment->isNot(tok::l_square)) 878de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = 0; 879de0328aeSDaniel Jasper } 88060553be5SDaniel Jasper } 881de0328aeSDaniel Jasper 88260553be5SDaniel Jasper void ContinuationIndenter::moveStateToNewBlock(LineState &State) { 88360553be5SDaniel Jasper // If we have already found more than one lambda introducers on this level, we 88460553be5SDaniel Jasper // opt out of this because similarity between the lambdas is more important. 885114a2bc9SDaniel Jasper if (fakeRParenSpecialCase(State)) 886335ff266SDaniel Jasper consumeRParens(State, *State.NextToken->MatchingParen); 887de0328aeSDaniel Jasper 88860553be5SDaniel Jasper // For some reason, ObjC blocks are indented like continuations. 88960553be5SDaniel Jasper unsigned NewIndent = State.Stack.back().LastSpace + 89060553be5SDaniel Jasper (State.NextToken->Type == TT_ObjCBlockLBrace 89160553be5SDaniel Jasper ? Style.ContinuationIndentWidth 89260553be5SDaniel Jasper : Style.IndentWidth); 89360553be5SDaniel Jasper State.Stack.push_back(ParenState( 89460553be5SDaniel Jasper NewIndent, /*NewIndentLevel=*/State.Stack.back().IndentLevel + 1, 89560553be5SDaniel Jasper State.Stack.back().LastSpace, /*AvoidBinPacking=*/true, 89660553be5SDaniel Jasper State.Stack.back().NoLineBreak)); 89760553be5SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 898de0328aeSDaniel Jasper } 899de0328aeSDaniel Jasper 900917f9e04SAlexander Kornienko unsigned ContinuationIndenter::addMultilineToken(const FormatToken &Current, 901d7b837e7SAlexander Kornienko LineState &State) { 902d7b837e7SAlexander Kornienko // Break before further function parameters on all levels. 903d7b837e7SAlexander Kornienko for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 904d7b837e7SAlexander Kornienko State.Stack[i].BreakBeforeParameter = true; 905d7b837e7SAlexander Kornienko 90639856b71SAlexander Kornienko unsigned ColumnsUsed = State.Column; 907632abb9bSAlexander Kornienko // We can only affect layout of the first and the last line, so the penalty 908632abb9bSAlexander Kornienko // for all other lines is constant, and we ignore it. 909ebb43caaSAlexander Kornienko State.Column = Current.LastLineColumnWidth; 910632abb9bSAlexander Kornienko 9119fe0e8daSDaniel Jasper if (ColumnsUsed > getColumnLimit(State)) 9129fe0e8daSDaniel Jasper return Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit(State)); 913d7b837e7SAlexander Kornienko return 0; 914d7b837e7SAlexander Kornienko } 915d7b837e7SAlexander Kornienko 916b05a81deSDaniel Jasper static bool getRawStringLiteralPrefixPostfix(StringRef Text, StringRef &Prefix, 91781e3294eSAlexander Kornienko StringRef &Postfix) { 91881e3294eSAlexander Kornienko if (Text.startswith(Prefix = "R\"") || Text.startswith(Prefix = "uR\"") || 91981e3294eSAlexander Kornienko Text.startswith(Prefix = "UR\"") || Text.startswith(Prefix = "u8R\"") || 92081e3294eSAlexander Kornienko Text.startswith(Prefix = "LR\"")) { 92181e3294eSAlexander Kornienko size_t ParenPos = Text.find('('); 92281e3294eSAlexander Kornienko if (ParenPos != StringRef::npos) { 92381e3294eSAlexander Kornienko StringRef Delimiter = 92481e3294eSAlexander Kornienko Text.substr(Prefix.size(), ParenPos - Prefix.size()); 92581e3294eSAlexander Kornienko Prefix = Text.substr(0, ParenPos + 1); 92681e3294eSAlexander Kornienko Postfix = Text.substr(Text.size() - 2 - Delimiter.size()); 92781e3294eSAlexander Kornienko return Postfix.front() == ')' && Postfix.back() == '"' && 92881e3294eSAlexander Kornienko Postfix.substr(1).startswith(Delimiter); 92981e3294eSAlexander Kornienko } 93081e3294eSAlexander Kornienko } 93181e3294eSAlexander Kornienko return false; 93281e3294eSAlexander Kornienko } 93381e3294eSAlexander Kornienko 934de0328aeSDaniel Jasper unsigned ContinuationIndenter::breakProtrudingToken(const FormatToken &Current, 935de0328aeSDaniel Jasper LineState &State, 936de0328aeSDaniel Jasper bool DryRun) { 937917f9e04SAlexander Kornienko // Don't break multi-line tokens other than block comments. Instead, just 938917f9e04SAlexander Kornienko // update the state. 939917f9e04SAlexander Kornienko if (Current.Type != TT_BlockComment && Current.IsMultiline) 940917f9e04SAlexander Kornienko return addMultilineToken(Current, State); 941917f9e04SAlexander Kornienko 9429885784dSDaniel Jasper // Don't break implicit string literals. 9439885784dSDaniel Jasper if (Current.Type == TT_ImplicitStringLiteral) 9449885784dSDaniel Jasper return 0; 9459885784dSDaniel Jasper 94604b6a081SDaniel Jasper if (!Current.isStringLiteral() && !Current.is(tok::comment)) 947f93551c8SDaniel Jasper return 0; 948f93551c8SDaniel Jasper 949b8984329SAhmed Charles std::unique_ptr<BreakableToken> Token; 95039856b71SAlexander Kornienko unsigned StartColumn = State.Column - Current.ColumnWidth; 9513abbb8a4SAlexander Kornienko unsigned ColumnLimit = getColumnLimit(State); 952de0328aeSDaniel Jasper 95304b6a081SDaniel Jasper if (Current.isStringLiteral()) { 954384b40b9SAlexander Kornienko // Don't break string literals inside preprocessor directives (except for 955384b40b9SAlexander Kornienko // #define directives, as their contents are stored in separate lines and 956384b40b9SAlexander Kornienko // are not affected by this check). 957384b40b9SAlexander Kornienko // This way we avoid breaking code with line directives and unknown 958384b40b9SAlexander Kornienko // preprocessor directives that contain long string literals. 959384b40b9SAlexander Kornienko if (State.Line->Type == LT_PreprocessorDirective) 960384b40b9SAlexander Kornienko return 0; 961de0328aeSDaniel Jasper // Exempts unterminated string literals from line breaking. The user will 962de0328aeSDaniel Jasper // likely want to terminate the string before any line breaking is done. 963de0328aeSDaniel Jasper if (Current.IsUnterminatedLiteral) 964de0328aeSDaniel Jasper return 0; 965de0328aeSDaniel Jasper 96681e3294eSAlexander Kornienko StringRef Text = Current.TokenText; 96781e3294eSAlexander Kornienko StringRef Prefix; 96881e3294eSAlexander Kornienko StringRef Postfix; 969174b0125SDaniel Jasper bool IsNSStringLiteral = false; 97081e3294eSAlexander Kornienko // FIXME: Handle whitespace between '_T', '(', '"..."', and ')'. 97181e3294eSAlexander Kornienko // FIXME: Store Prefix and Suffix (or PrefixLength and SuffixLength to 97281e3294eSAlexander Kornienko // reduce the overhead) for each FormatToken, which is a string, so that we 97381e3294eSAlexander Kornienko // don't run multiple checks here on the hot path. 974174b0125SDaniel Jasper if (Text.startswith("\"") && Current.Previous && 975174b0125SDaniel Jasper Current.Previous->is(tok::at)) { 976174b0125SDaniel Jasper IsNSStringLiteral = true; 977174b0125SDaniel Jasper Prefix = "@\""; 978174b0125SDaniel Jasper } 97981e3294eSAlexander Kornienko if ((Text.endswith(Postfix = "\"") && 980174b0125SDaniel Jasper (IsNSStringLiteral || Text.startswith(Prefix = "\"") || 981174b0125SDaniel Jasper Text.startswith(Prefix = "u\"") || Text.startswith(Prefix = "U\"") || 982174b0125SDaniel Jasper Text.startswith(Prefix = "u8\"") || 98381e3294eSAlexander Kornienko Text.startswith(Prefix = "L\""))) || 98481e3294eSAlexander Kornienko (Text.startswith(Prefix = "_T(\"") && Text.endswith(Postfix = "\")")) || 98581e3294eSAlexander Kornienko getRawStringLiteralPrefixPostfix(Text, Prefix, Postfix)) { 9863c3d09c8SAlexander Kornienko Token.reset(new BreakableStringLiteral( 9873c3d09c8SAlexander Kornienko Current, State.Line->Level, StartColumn, Prefix, Postfix, 9883c3d09c8SAlexander Kornienko State.Line->InPPDirective, Encoding, Style)); 98981e3294eSAlexander Kornienko } else { 99081e3294eSAlexander Kornienko return 0; 99181e3294eSAlexander Kornienko } 992de0328aeSDaniel Jasper } else if (Current.Type == TT_BlockComment && Current.isTrailingComment()) { 993ce9161a5SAlexander Kornienko if (CommentPragmasRegex.match(Current.TokenText.substr(2))) 994ce9161a5SAlexander Kornienko return 0; 995de0328aeSDaniel Jasper Token.reset(new BreakableBlockComment( 9963c3d09c8SAlexander Kornienko Current, State.Line->Level, StartColumn, Current.OriginalColumn, 9973c3d09c8SAlexander Kornienko !Current.Previous, State.Line->InPPDirective, Encoding, Style)); 998de0328aeSDaniel Jasper } else if (Current.Type == TT_LineComment && 9992145bc02SCraig Topper (Current.Previous == nullptr || 1000de0328aeSDaniel Jasper Current.Previous->Type != TT_ImplicitStringLiteral)) { 1001ce9161a5SAlexander Kornienko if (CommentPragmasRegex.match(Current.TokenText.substr(2))) 1002ce9161a5SAlexander Kornienko return 0; 10033c3d09c8SAlexander Kornienko Token.reset(new BreakableLineComment(Current, State.Line->Level, 10043abbb8a4SAlexander Kornienko StartColumn, /*InPPDirective=*/false, 10053c3d09c8SAlexander Kornienko Encoding, Style)); 10063abbb8a4SAlexander Kornienko // We don't insert backslashes when breaking line comments. 10073abbb8a4SAlexander Kornienko ColumnLimit = Style.ColumnLimit; 1008de0328aeSDaniel Jasper } else { 1009de0328aeSDaniel Jasper return 0; 1010de0328aeSDaniel Jasper } 10113abbb8a4SAlexander Kornienko if (Current.UnbreakableTailLength >= ColumnLimit) 1012de0328aeSDaniel Jasper return 0; 1013de0328aeSDaniel Jasper 10143abbb8a4SAlexander Kornienko unsigned RemainingSpace = ColumnLimit - Current.UnbreakableTailLength; 1015de0328aeSDaniel Jasper bool BreakInserted = false; 1016de0328aeSDaniel Jasper unsigned Penalty = 0; 1017de0328aeSDaniel Jasper unsigned RemainingTokenColumns = 0; 1018de0328aeSDaniel Jasper for (unsigned LineIndex = 0, EndIndex = Token->getLineCount(); 1019de0328aeSDaniel Jasper LineIndex != EndIndex; ++LineIndex) { 1020de0328aeSDaniel Jasper if (!DryRun) 1021de0328aeSDaniel Jasper Token->replaceWhitespaceBefore(LineIndex, Whitespaces); 1022de0328aeSDaniel Jasper unsigned TailOffset = 0; 1023de0328aeSDaniel Jasper RemainingTokenColumns = 1024de0328aeSDaniel Jasper Token->getLineLengthAfterSplit(LineIndex, TailOffset, StringRef::npos); 1025de0328aeSDaniel Jasper while (RemainingTokenColumns > RemainingSpace) { 1026de0328aeSDaniel Jasper BreakableToken::Split Split = 10273abbb8a4SAlexander Kornienko Token->getSplit(LineIndex, TailOffset, ColumnLimit); 1028de0328aeSDaniel Jasper if (Split.first == StringRef::npos) { 1029de0328aeSDaniel Jasper // The last line's penalty is handled in addNextStateToQueue(). 1030de0328aeSDaniel Jasper if (LineIndex < EndIndex - 1) 1031de0328aeSDaniel Jasper Penalty += Style.PenaltyExcessCharacter * 1032de0328aeSDaniel Jasper (RemainingTokenColumns - RemainingSpace); 1033de0328aeSDaniel Jasper break; 1034de0328aeSDaniel Jasper } 1035de0328aeSDaniel Jasper assert(Split.first != 0); 1036de0328aeSDaniel Jasper unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit( 1037de0328aeSDaniel Jasper LineIndex, TailOffset + Split.first + Split.second, StringRef::npos); 1038875395f9SAlexander Kornienko 1039875395f9SAlexander Kornienko // We can remove extra whitespace instead of breaking the line. 1040875395f9SAlexander Kornienko if (RemainingTokenColumns + 1 - Split.second <= RemainingSpace) { 1041875395f9SAlexander Kornienko RemainingTokenColumns = 0; 1042875395f9SAlexander Kornienko if (!DryRun) 1043875395f9SAlexander Kornienko Token->replaceWhitespace(LineIndex, TailOffset, Split, Whitespaces); 1044875395f9SAlexander Kornienko break; 1045875395f9SAlexander Kornienko } 1046875395f9SAlexander Kornienko 104764a42b8dSAlexander Kornienko // When breaking before a tab character, it may be moved by a few columns, 104864a42b8dSAlexander Kornienko // but will still be expanded to the next tab stop, so we don't save any 104964a42b8dSAlexander Kornienko // columns. 105064a42b8dSAlexander Kornienko if (NewRemainingTokenColumns == RemainingTokenColumns) 105164a42b8dSAlexander Kornienko break; 105264a42b8dSAlexander Kornienko 1053de0328aeSDaniel Jasper assert(NewRemainingTokenColumns < RemainingTokenColumns); 1054de0328aeSDaniel Jasper if (!DryRun) 1055de0328aeSDaniel Jasper Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces); 10562739af3bSDaniel Jasper Penalty += Current.SplitPenalty; 1057de0328aeSDaniel Jasper unsigned ColumnsUsed = 1058de0328aeSDaniel Jasper Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first); 10593abbb8a4SAlexander Kornienko if (ColumnsUsed > ColumnLimit) { 10603abbb8a4SAlexander Kornienko Penalty += Style.PenaltyExcessCharacter * (ColumnsUsed - ColumnLimit); 1061de0328aeSDaniel Jasper } 1062de0328aeSDaniel Jasper TailOffset += Split.first + Split.second; 1063de0328aeSDaniel Jasper RemainingTokenColumns = NewRemainingTokenColumns; 1064de0328aeSDaniel Jasper BreakInserted = true; 1065de0328aeSDaniel Jasper } 1066de0328aeSDaniel Jasper } 1067de0328aeSDaniel Jasper 1068de0328aeSDaniel Jasper State.Column = RemainingTokenColumns; 1069de0328aeSDaniel Jasper 1070de0328aeSDaniel Jasper if (BreakInserted) { 1071de0328aeSDaniel Jasper // If we break the token inside a parameter list, we need to break before 1072de0328aeSDaniel Jasper // the next parameter on all levels, so that the next parameter is clearly 1073de0328aeSDaniel Jasper // visible. Line comments already introduce a break. 1074de0328aeSDaniel Jasper if (Current.Type != TT_LineComment) { 1075de0328aeSDaniel Jasper for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 1076de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 1077de0328aeSDaniel Jasper } 1078de0328aeSDaniel Jasper 107904b6a081SDaniel Jasper Penalty += Current.isStringLiteral() ? Style.PenaltyBreakString 10802739af3bSDaniel Jasper : Style.PenaltyBreakComment; 10812739af3bSDaniel Jasper 1082de0328aeSDaniel Jasper State.Stack.back().LastSpace = StartColumn; 1083de0328aeSDaniel Jasper } 1084de0328aeSDaniel Jasper return Penalty; 1085de0328aeSDaniel Jasper } 1086de0328aeSDaniel Jasper 10879fe0e8daSDaniel Jasper unsigned ContinuationIndenter::getColumnLimit(const LineState &State) const { 1088de0328aeSDaniel Jasper // In preprocessor directives reserve two chars for trailing " \" 10899fe0e8daSDaniel Jasper return Style.ColumnLimit - (State.Line->InPPDirective ? 2 : 0); 1090de0328aeSDaniel Jasper } 1091de0328aeSDaniel Jasper 1092c39b56feSDaniel Jasper bool ContinuationIndenter::nextIsMultilineString(const LineState &State) { 1093f438cb76SDaniel Jasper const FormatToken &Current = *State.NextToken; 10949509f188SDaniel Jasper if (!Current.isStringLiteral() || Current.Type == TT_ImplicitStringLiteral) 1095f438cb76SDaniel Jasper return false; 1096d7b837e7SAlexander Kornienko // We never consider raw string literals "multiline" for the purpose of 1097c39b56feSDaniel Jasper // AlwaysBreakBeforeMultilineStrings implementation as they are special-cased 1098c39b56feSDaniel Jasper // (see TokenAnnotator::mustBreakBefore(). 1099d7b837e7SAlexander Kornienko if (Current.TokenText.startswith("R\"")) 1100d7b837e7SAlexander Kornienko return false; 110139856b71SAlexander Kornienko if (Current.IsMultiline) 1102d7b837e7SAlexander Kornienko return true; 1103f438cb76SDaniel Jasper if (Current.getNextNonComment() && 110404b6a081SDaniel Jasper Current.getNextNonComment()->isStringLiteral()) 1105f438cb76SDaniel Jasper return true; // Implicit concatenation. 110639856b71SAlexander Kornienko if (State.Column + Current.ColumnWidth + Current.UnbreakableTailLength > 1107f438cb76SDaniel Jasper Style.ColumnLimit) 1108f438cb76SDaniel Jasper return true; // String will be split. 1109d7b837e7SAlexander Kornienko return false; 1110f438cb76SDaniel Jasper } 1111f438cb76SDaniel Jasper 1112de0328aeSDaniel Jasper } // namespace format 1113de0328aeSDaniel Jasper } // namespace clang 1114