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 "ContinuationIndenter.h" 1689628f64SManuel Klimek #include "BreakableToken.h" 179ad83fe7SKrasimir Georgiev #include "FormatInternal.h" 18de0328aeSDaniel Jasper #include "WhitespaceManager.h" 19de0328aeSDaniel Jasper #include "clang/Basic/OperatorPrecedence.h" 20de0328aeSDaniel Jasper #include "clang/Basic/SourceManager.h" 21de0328aeSDaniel Jasper #include "clang/Format/Format.h" 22de0328aeSDaniel Jasper #include "llvm/Support/Debug.h" 23de0328aeSDaniel Jasper 2491834227SKrasimir Georgiev #define DEBUG_TYPE "format-indenter" 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 41801cdb27SDaniel Jasper static unsigned getLengthToNextOperator(const FormatToken &Tok) { 42801cdb27SDaniel Jasper if (!Tok.NextOperator) 43801cdb27SDaniel Jasper return 0; 44801cdb27SDaniel Jasper return Tok.NextOperator->TotalLength - Tok.TotalLength; 45801cdb27SDaniel Jasper } 46801cdb27SDaniel Jasper 474c6e0059SDaniel Jasper // Returns \c true if \c Tok is the "." or "->" of a call and starts the next 484c6e0059SDaniel Jasper // segment of a builder type call. 494c6e0059SDaniel Jasper static bool startsSegmentOfBuilderTypeCall(const FormatToken &Tok) { 504c6e0059SDaniel Jasper return Tok.isMemberAccess() && Tok.Previous && Tok.Previous->closesScope(); 514c6e0059SDaniel Jasper } 524c6e0059SDaniel Jasper 53ec01cd6eSDaniel Jasper // Returns \c true if \c Current starts a new parameter. 54ec01cd6eSDaniel Jasper static bool startsNextParameter(const FormatToken &Current, 55ec01cd6eSDaniel Jasper const FormatStyle &Style) { 56ec01cd6eSDaniel Jasper const FormatToken &Previous = *Current.Previous; 57a98b7b01SDaniel Jasper if (Current.is(TT_CtorInitializerComma) && 58a6b6d51bSFrancois Ferrand Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma) 59ec01cd6eSDaniel Jasper return true; 60ff747be4SKrasimir Georgiev if (Style.Language == FormatStyle::LK_Proto && Current.is(TT_SelectorName)) 61ff747be4SKrasimir Georgiev return true; 62ec01cd6eSDaniel Jasper return Previous.is(tok::comma) && !Current.isTrailingComment() && 630ef8ee19SAndi-Bogdan Postelnicu ((Previous.isNot(TT_CtorInitializerComma) || 64a6b6d51bSFrancois Ferrand Style.BreakConstructorInitializers != 65a6b6d51bSFrancois Ferrand FormatStyle::BCIS_BeforeComma) && 660ef8ee19SAndi-Bogdan Postelnicu (Previous.isNot(TT_InheritanceComma) || 670ef8ee19SAndi-Bogdan Postelnicu !Style.BreakBeforeInheritanceComma)); 68ec01cd6eSDaniel Jasper } 69ec01cd6eSDaniel Jasper 7026b144ccSKrasimir Georgiev static bool opensProtoMessageField(const FormatToken &LessTok, 7126b144ccSKrasimir Georgiev const FormatStyle &Style) { 7226b144ccSKrasimir Georgiev if (LessTok.isNot(tok::less)) 7326b144ccSKrasimir Georgiev return false; 7426b144ccSKrasimir Georgiev return Style.Language == FormatStyle::LK_TextProto || 7526b144ccSKrasimir Georgiev (Style.Language == FormatStyle::LK_Proto && 7626b144ccSKrasimir Georgiev (LessTok.NestingLevel > 0 || 7726b144ccSKrasimir Georgiev (LessTok.Previous && LessTok.Previous->is(tok::equal)))); 7826b144ccSKrasimir Georgiev } 7926b144ccSKrasimir Georgiev 809ad83fe7SKrasimir Georgiev // Returns the delimiter of a raw string literal, or None if TokenText is not 819ad83fe7SKrasimir Georgiev // the text of a raw string literal. The delimiter could be the empty string. 829ad83fe7SKrasimir Georgiev // For example, the delimiter of R"deli(cont)deli" is deli. 839ad83fe7SKrasimir Georgiev static llvm::Optional<StringRef> getRawStringDelimiter(StringRef TokenText) { 849ad83fe7SKrasimir Georgiev if (TokenText.size() < 5 // The smallest raw string possible is 'R"()"'. 859ad83fe7SKrasimir Georgiev || !TokenText.startswith("R\"") || !TokenText.endswith("\"")) 869ad83fe7SKrasimir Georgiev return None; 879ad83fe7SKrasimir Georgiev 889ad83fe7SKrasimir Georgiev // A raw string starts with 'R"<delimiter>(' and delimiter is ascii and has 899ad83fe7SKrasimir Georgiev // size at most 16 by the standard, so the first '(' must be among the first 909ad83fe7SKrasimir Georgiev // 19 bytes. 919ad83fe7SKrasimir Georgiev size_t LParenPos = TokenText.substr(0, 19).find_first_of('('); 929ad83fe7SKrasimir Georgiev if (LParenPos == StringRef::npos) 939ad83fe7SKrasimir Georgiev return None; 949ad83fe7SKrasimir Georgiev StringRef Delimiter = TokenText.substr(2, LParenPos - 2); 959ad83fe7SKrasimir Georgiev 969ad83fe7SKrasimir Georgiev // Check that the string ends in ')Delimiter"'. 979ad83fe7SKrasimir Georgiev size_t RParenPos = TokenText.size() - Delimiter.size() - 2; 989ad83fe7SKrasimir Georgiev if (TokenText[RParenPos] != ')') 999ad83fe7SKrasimir Georgiev return None; 1009ad83fe7SKrasimir Georgiev if (!TokenText.substr(RParenPos + 1).startswith(Delimiter)) 1019ad83fe7SKrasimir Georgiev return None; 1029ad83fe7SKrasimir Georgiev return Delimiter; 1039ad83fe7SKrasimir Georgiev } 1049ad83fe7SKrasimir Georgiev 1059ad83fe7SKrasimir Georgiev RawStringFormatStyleManager::RawStringFormatStyleManager( 1069ad83fe7SKrasimir Georgiev const FormatStyle &CodeStyle) { 1079ad83fe7SKrasimir Georgiev for (const auto &RawStringFormat : CodeStyle.RawStringFormats) { 1089ad83fe7SKrasimir Georgiev FormatStyle Style; 1099ad83fe7SKrasimir Georgiev if (!getPredefinedStyle(RawStringFormat.BasedOnStyle, 1109ad83fe7SKrasimir Georgiev RawStringFormat.Language, &Style)) { 1119ad83fe7SKrasimir Georgiev Style = getLLVMStyle(); 1129ad83fe7SKrasimir Georgiev Style.Language = RawStringFormat.Language; 1139ad83fe7SKrasimir Georgiev } 1149ad83fe7SKrasimir Georgiev Style.ColumnLimit = CodeStyle.ColumnLimit; 1159ad83fe7SKrasimir Georgiev DelimiterStyle.insert({RawStringFormat.Delimiter, Style}); 1169ad83fe7SKrasimir Georgiev } 1179ad83fe7SKrasimir Georgiev } 1189ad83fe7SKrasimir Georgiev 1199ad83fe7SKrasimir Georgiev llvm::Optional<FormatStyle> 1209ad83fe7SKrasimir Georgiev RawStringFormatStyleManager::get(StringRef Delimiter) const { 1219ad83fe7SKrasimir Georgiev auto It = DelimiterStyle.find(Delimiter); 1229ad83fe7SKrasimir Georgiev if (It == DelimiterStyle.end()) 1239ad83fe7SKrasimir Georgiev return None; 1249ad83fe7SKrasimir Georgiev return It->second; 1259ad83fe7SKrasimir Georgiev } 1269ad83fe7SKrasimir Georgiev 127de0328aeSDaniel Jasper ContinuationIndenter::ContinuationIndenter(const FormatStyle &Style, 128d0ec0d62SDaniel Jasper const AdditionalKeywords &Keywords, 129635423e6SEric Liu const SourceManager &SourceMgr, 130de0328aeSDaniel Jasper WhitespaceManager &Whitespaces, 131de0328aeSDaniel Jasper encoding::Encoding Encoding, 132de0328aeSDaniel Jasper bool BinPackInconclusiveFunctions) 133d0ec0d62SDaniel Jasper : Style(Style), Keywords(Keywords), SourceMgr(SourceMgr), 134d0ec0d62SDaniel Jasper Whitespaces(Whitespaces), Encoding(Encoding), 135ce9161a5SAlexander Kornienko BinPackInconclusiveFunctions(BinPackInconclusiveFunctions), 1369ad83fe7SKrasimir Georgiev CommentPragmasRegex(Style.CommentPragmas), RawStringFormats(Style) {} 137de0328aeSDaniel Jasper 1389fe0e8daSDaniel Jasper LineState ContinuationIndenter::getInitialState(unsigned FirstIndent, 1399ad83fe7SKrasimir Georgiev unsigned FirstStartColumn, 1401c5d9df8SDaniel Jasper const AnnotatedLine *Line, 1411c5d9df8SDaniel Jasper bool DryRun) { 142de0328aeSDaniel Jasper LineState State; 1439fe0e8daSDaniel Jasper State.FirstIndent = FirstIndent; 1449ad83fe7SKrasimir Georgiev if (FirstStartColumn && Line->First->NewlinesBefore == 0) 1459ad83fe7SKrasimir Georgiev State.Column = FirstStartColumn; 1469ad83fe7SKrasimir Georgiev else 147de0328aeSDaniel Jasper State.Column = FirstIndent; 148ad47c907SKrasimir Georgiev // With preprocessor directive indentation, the line starts on column 0 149ad47c907SKrasimir Georgiev // since it's indented after the hash, but FirstIndent is set to the 150ad47c907SKrasimir Georgiev // preprocessor indent. 151ad47c907SKrasimir Georgiev if (Style.IndentPPDirectives == FormatStyle::PPDIS_AfterHash && 152ad47c907SKrasimir Georgiev (Line->Type == LT_PreprocessorDirective || 153ad47c907SKrasimir Georgiev Line->Type == LT_ImportStatement)) 154ad47c907SKrasimir Georgiev State.Column = 0; 1559fe0e8daSDaniel Jasper State.Line = Line; 1569fe0e8daSDaniel Jasper State.NextToken = Line->First; 1577d42f3f7SDaniel Jasper State.Stack.push_back(ParenState(FirstIndent, FirstIndent, 158de0328aeSDaniel Jasper /*AvoidBinPacking=*/false, 159de0328aeSDaniel Jasper /*NoLineBreak=*/false)); 160de0328aeSDaniel Jasper State.LineContainsContinuedForLoopSection = false; 16135599fdfSKrasimir Georgiev State.NoContinuation = false; 162de0328aeSDaniel Jasper State.StartOfStringLiteral = 0; 16305cd5868SDaniel Jasper State.StartOfLineLevel = 0; 16405cd5868SDaniel Jasper State.LowestLevelOnLine = 0; 165de0328aeSDaniel Jasper State.IgnoreStackForComparison = false; 166de0328aeSDaniel Jasper 16726b144ccSKrasimir Georgiev if (Style.Language == FormatStyle::LK_TextProto) { 16826b144ccSKrasimir Georgiev // We need this in order to deal with the bin packing of text fields at 16926b144ccSKrasimir Georgiev // global scope. 17026b144ccSKrasimir Georgiev State.Stack.back().AvoidBinPacking = true; 17126b144ccSKrasimir Georgiev State.Stack.back().BreakBeforeParameter = true; 17226b144ccSKrasimir Georgiev } 17326b144ccSKrasimir Georgiev 174de0328aeSDaniel Jasper // The first token has already been indented and thus consumed. 1751c5d9df8SDaniel Jasper moveStateToNextToken(State, DryRun, /*Newline=*/false); 176de0328aeSDaniel Jasper return State; 177de0328aeSDaniel Jasper } 178de0328aeSDaniel Jasper 179de0328aeSDaniel Jasper bool ContinuationIndenter::canBreak(const LineState &State) { 180de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 181de0328aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 182de0328aeSDaniel Jasper assert(&Previous == Current.Previous); 18389628f64SManuel Klimek if (!Current.CanBreakBefore && !(State.Stack.back().BreakBeforeClosingBrace && 184bd73bcf8SDaniel Jasper Current.closesBlockOrBlockTypeList(Style))) 185de0328aeSDaniel Jasper return false; 186de0328aeSDaniel Jasper // The opening "{" of a braced list has to be on the same line as the first 187de0328aeSDaniel Jasper // element if it is nested in another braced init list or function call. 188de0328aeSDaniel Jasper if (!Current.MustBreakBefore && Previous.is(tok::l_brace) && 189a98b7b01SDaniel Jasper Previous.isNot(TT_DictLiteral) && Previous.BlockKind == BK_BracedInit && 190b05a81deSDaniel Jasper Previous.Previous && 191de0328aeSDaniel Jasper Previous.Previous->isOneOf(tok::l_brace, tok::l_paren, tok::comma)) 192de0328aeSDaniel Jasper return false; 193de0328aeSDaniel Jasper // This prevents breaks like: 194de0328aeSDaniel Jasper // ... 195de0328aeSDaniel Jasper // SomeParameter, OtherParameter).DoSomething( 196de0328aeSDaniel Jasper // ... 197de0328aeSDaniel Jasper // As they hide "DoSomething" and are generally bad for readability. 1988f59ae53SDaniel Jasper if (Previous.opensScope() && Previous.isNot(tok::l_brace) && 199fcfac10cSDaniel Jasper State.LowestLevelOnLine < State.StartOfLineLevel && 200fcfac10cSDaniel Jasper State.LowestLevelOnLine < Current.NestingLevel) 201de0328aeSDaniel Jasper return false; 2024c6e0059SDaniel Jasper if (Current.isMemberAccess() && State.Stack.back().ContainsUnwrappedBuilder) 2034c6e0059SDaniel Jasper return false; 204114a2bc9SDaniel Jasper 205114a2bc9SDaniel Jasper // Don't create a 'hanging' indent if there are multiple blocks in a single 206114a2bc9SDaniel Jasper // statement. 2074b444495SDaniel Jasper if (Previous.is(tok::l_brace) && State.Stack.size() > 1 && 2084b444495SDaniel Jasper State.Stack[State.Stack.size() - 2].NestedBlockInlined && 209114a2bc9SDaniel Jasper State.Stack[State.Stack.size() - 2].HasMultipleNestedBlocks) 210114a2bc9SDaniel Jasper return false; 211114a2bc9SDaniel Jasper 212e068ac77SDaniel Jasper // Don't break after very short return types (e.g. "void") as that is often 213e068ac77SDaniel Jasper // unexpected. 214448592eeSZachary Turner if (Current.is(TT_FunctionDeclarationName) && State.Column < 6) { 215448592eeSZachary Turner if (Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None) 216e068ac77SDaniel Jasper return false; 217448592eeSZachary Turner } 218e068ac77SDaniel Jasper 219240527caSDaniel Jasper // If binary operators are moved to the next line (including commas for some 220240527caSDaniel Jasper // styles of constructor initializers), that's always ok. 221240527caSDaniel Jasper if (!Current.isOneOf(TT_BinaryOperator, tok::comma) && 222240527caSDaniel Jasper State.Stack.back().NoLineBreakInOperand) 223240527caSDaniel Jasper return false; 224240527caSDaniel Jasper 225de0328aeSDaniel Jasper return !State.Stack.back().NoLineBreak; 226de0328aeSDaniel Jasper } 227de0328aeSDaniel Jasper 228de0328aeSDaniel Jasper bool ContinuationIndenter::mustBreak(const LineState &State) { 229de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 230de0328aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 231a98b7b01SDaniel Jasper if (Current.MustBreakBefore || Current.is(TT_InlineASMColon)) 232de0328aeSDaniel Jasper return true; 2331db6c386SDaniel Jasper if (State.Stack.back().BreakBeforeClosingBrace && 234bd73bcf8SDaniel Jasper Current.closesBlockOrBlockTypeList(Style)) 235de0328aeSDaniel Jasper return true; 236de0328aeSDaniel Jasper if (Previous.is(tok::semi) && State.LineContainsContinuedForLoopSection) 237de0328aeSDaniel Jasper return true; 238ec01cd6eSDaniel Jasper if ((startsNextParameter(Current, Style) || Previous.is(tok::semi) || 23900693b08SDaniel Jasper (Previous.is(TT_TemplateCloser) && Current.is(TT_StartOfName) && 2401dbc2105SDaniel Jasper Style.isCpp() && 24106ca0fc6SDaniel Jasper // FIXME: This is a temporary workaround for the case where clang-format 24206ca0fc6SDaniel Jasper // sets BreakBeforeParameter to avoid bin packing and this creates a 24306ca0fc6SDaniel Jasper // completely unnecessary line break after a template type that isn't 24406ca0fc6SDaniel Jasper // line-wrapped. 24506ca0fc6SDaniel Jasper (Previous.NestingLevel == 1 || Style.BinPackParameters)) || 2463e0dcc27SDaniel Jasper (Style.BreakBeforeTernaryOperators && Current.is(TT_ConditionalExpr) && 2473e0dcc27SDaniel Jasper Previous.isNot(tok::question)) || 248165b29e2SDaniel Jasper (!Style.BreakBeforeTernaryOperators && 2493e0dcc27SDaniel Jasper Previous.is(TT_ConditionalExpr))) && 250de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter && !Current.isTrailingComment() && 251de0328aeSDaniel Jasper !Current.isOneOf(tok::r_paren, tok::r_brace)) 252de0328aeSDaniel Jasper return true; 253a98b7b01SDaniel Jasper if (((Previous.is(TT_DictLiteral) && Previous.is(tok::l_brace)) || 254ccff4d1eSDaniel Jasper (Previous.is(TT_ArrayInitializerLSquare) && 25526b144ccSKrasimir Georgiev Previous.ParameterCount > 1) || 25626b144ccSKrasimir Georgiev opensProtoMessageField(Previous, Style)) && 257db8804b3SDaniel Jasper Style.ColumnLimit > 0 && 258199d0c9eSDaniel Jasper getLengthToMatchingParen(Previous) + State.Column - 1 > 259199d0c9eSDaniel Jasper getColumnLimit(State)) 260d489dd34SDaniel Jasper return true; 261a6b6d51bSFrancois Ferrand 262a6b6d51bSFrancois Ferrand const FormatToken &BreakConstructorInitializersToken = 263a6b6d51bSFrancois Ferrand Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon 264a6b6d51bSFrancois Ferrand ? Previous 265a6b6d51bSFrancois Ferrand : Current; 266a6b6d51bSFrancois Ferrand if (BreakConstructorInitializersToken.is(TT_CtorInitializerColon) && 267a6b6d51bSFrancois Ferrand (State.Column + State.Line->Last->TotalLength - Previous.TotalLength > 2687b259cdaSDaniel Jasper getColumnLimit(State) || 2697b259cdaSDaniel Jasper State.Stack.back().BreakBeforeParameter) && 270a6b6d51bSFrancois Ferrand (Style.AllowShortFunctionsOnASingleLine != FormatStyle::SFS_All || 271a6b6d51bSFrancois Ferrand Style.BreakConstructorInitializers != FormatStyle::BCIS_BeforeColon || 272a6b6d51bSFrancois Ferrand Style.ColumnLimit != 0)) 2735d2587daSDaniel Jasper return true; 274a6b6d51bSFrancois Ferrand 275fd36f0b5SDaniel Jasper if (Current.is(TT_ObjCMethodExpr) && !Previous.is(TT_SelectorName) && 276fd36f0b5SDaniel Jasper State.Line->startsWith(TT_ObjCMethodSpecifier)) 277fd36f0b5SDaniel Jasper return true; 2782746a308SDaniel Jasper if (Current.is(TT_SelectorName) && State.Stack.back().ObjCSelectorNameFound && 2792746a308SDaniel Jasper State.Stack.back().BreakBeforeParameter) 2802746a308SDaniel Jasper return true; 281de0328aeSDaniel Jasper 2822aaedd3aSDaniel Jasper unsigned NewLineColumn = getNewLineColumn(State); 283a3cd2164SDaniel Jasper if (Current.isMemberAccess() && Style.ColumnLimit != 0 && 28428024560SDaniel Jasper State.Column + getLengthToNextOperator(Current) > Style.ColumnLimit && 28528024560SDaniel Jasper (State.Column > NewLineColumn || 28628024560SDaniel Jasper Current.NestingLevel < State.StartOfLineLevel)) 28728024560SDaniel Jasper return true; 28828024560SDaniel Jasper 289e61f9f99SDaniel Jasper if (startsSegmentOfBuilderTypeCall(Current) && 290e61f9f99SDaniel Jasper (State.Stack.back().CallContinuation != 0 || 29151c868e9SDaniel Jasper State.Stack.back().BreakBeforeParameter) && 29251c868e9SDaniel Jasper // JavaScript is treated different here as there is a frequent pattern: 29351c868e9SDaniel Jasper // SomeFunction(function() { 29451c868e9SDaniel Jasper // ... 29551c868e9SDaniel Jasper // }.bind(...)); 29651c868e9SDaniel Jasper // FIXME: We should find a more generic solution to this problem. 297b2f06eaeSMartin Probst !(State.Column <= NewLineColumn && 29851c868e9SDaniel Jasper Style.Language == FormatStyle::LK_JavaScript)) 299e61f9f99SDaniel Jasper return true; 300e61f9f99SDaniel Jasper 301411af72eSDaniel Jasper if (State.Column <= NewLineColumn) 3025d2587daSDaniel Jasper return false; 303173504e4SDaniel Jasper 3042aaedd3aSDaniel Jasper if (Style.AlwaysBreakBeforeMultilineStrings && 3051bf729ceSDaniel Jasper (NewLineColumn == State.FirstIndent + Style.ContinuationIndentWidth || 3069fb676a2SDaniel Jasper Previous.is(tok::comma) || Current.NestingLevel < 2) && 3072aaedd3aSDaniel Jasper !Previous.isOneOf(tok::kw_return, tok::lessless, tok::at) && 3082aaedd3aSDaniel Jasper !Previous.isOneOf(TT_InlineASMColon, TT_ConditionalExpr) && 3092aaedd3aSDaniel Jasper nextIsMultilineString(State)) 3102aaedd3aSDaniel Jasper return true; 3112aaedd3aSDaniel Jasper 312173504e4SDaniel Jasper // Using CanBreakBefore here and below takes care of the decision whether the 313173504e4SDaniel Jasper // current style uses wrapping before or after operators for the given 314173504e4SDaniel Jasper // operator. 315173504e4SDaniel Jasper if (Previous.is(TT_BinaryOperator) && Current.CanBreakBefore) { 316de0328aeSDaniel Jasper // If we need to break somewhere inside the LHS of a binary expression, we 317de0328aeSDaniel Jasper // should also break after the operator. Otherwise, the formatting would 318de0328aeSDaniel Jasper // hide the operator precedence, e.g. in: 319de0328aeSDaniel Jasper // if (aaaaaaaaaaaaaa == 320de0328aeSDaniel Jasper // bbbbbbbbbbbbbb && c) {.. 321de0328aeSDaniel Jasper // For comparisons, we only apply this rule, if the LHS is a binary 322de0328aeSDaniel Jasper // expression itself as otherwise, the line breaks seem superfluous. 323de0328aeSDaniel Jasper // We need special cases for ">>" which we have split into two ">" while 324de0328aeSDaniel Jasper // lexing in order to make template parsing easier. 325de0328aeSDaniel Jasper bool IsComparison = (Previous.getPrecedence() == prec::Relational || 326de0328aeSDaniel Jasper Previous.getPrecedence() == prec::Equality) && 327de0328aeSDaniel Jasper Previous.Previous && 328a98b7b01SDaniel Jasper Previous.Previous->isNot(TT_BinaryOperator); // For >>. 329de0328aeSDaniel Jasper bool LHSIsBinaryExpr = 330562ecd44SDaniel Jasper Previous.Previous && Previous.Previous->EndsBinaryExpression; 331173504e4SDaniel Jasper if ((!IsComparison || LHSIsBinaryExpr) && !Current.isTrailingComment() && 332de0328aeSDaniel Jasper Previous.getPrecedence() != prec::Assignment && 333de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter) 334de0328aeSDaniel Jasper return true; 335173504e4SDaniel Jasper } else if (Current.is(TT_BinaryOperator) && Current.CanBreakBefore && 336173504e4SDaniel Jasper State.Stack.back().BreakBeforeParameter) { 3373219e43cSDaniel Jasper return true; 338de0328aeSDaniel Jasper } 339de0328aeSDaniel Jasper 340de0328aeSDaniel Jasper // Same as above, but for the first "<<" operator. 341a98b7b01SDaniel Jasper if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator) && 34286b2dfdcSAlexander Kornienko State.Stack.back().BreakBeforeParameter && 343de0328aeSDaniel Jasper State.Stack.back().FirstLessLess == 0) 344de0328aeSDaniel Jasper return true; 345de0328aeSDaniel Jasper 346211e1329SDaniel Jasper if (Current.NestingLevel == 0 && !Current.isTrailingComment()) { 347f090f031SDaniel Jasper // Always break after "template <...>" and leading annotations. This is only 348f090f031SDaniel Jasper // for cases where the entire line does not fit on a single line as a 349f090f031SDaniel Jasper // different LineFormatter would be used otherwise. 350211e1329SDaniel Jasper if (Previous.ClosesTemplateDeclaration) 351de0328aeSDaniel Jasper return true; 35247bbda09SDaniel Jasper if (Previous.is(TT_FunctionAnnotationRParen)) 353f090f031SDaniel Jasper return true; 354beb03938SNico Weber if (Previous.is(TT_LeadingJavaAnnotation) && Current.isNot(tok::l_paren) && 355beb03938SNico Weber Current.isNot(TT_LeadingJavaAnnotation)) 356211e1329SDaniel Jasper return true; 357211e1329SDaniel Jasper } 358de0328aeSDaniel Jasper 3594355e7f0SDaniel Jasper // If the return type spans multiple lines, wrap before the function name. 360525579d4SBirunthan Mohanathas if ((Current.is(TT_FunctionDeclarationName) || 361525579d4SBirunthan Mohanathas (Current.is(tok::kw_operator) && !Previous.is(tok::coloncolon))) && 3620c9772e8SDaniel Jasper !Previous.is(tok::kw_template) && State.Stack.back().BreakBeforeParameter) 363de0328aeSDaniel Jasper return true; 3644355e7f0SDaniel Jasper 3659697281eSDaniel Jasper // The following could be precomputed as they do not depend on the state. 3669697281eSDaniel Jasper // However, as they should take effect only if the UnwrappedLine does not fit 3679697281eSDaniel Jasper // into the ColumnLimit, they are checked here in the ContinuationIndenter. 36835995679SDaniel Jasper if (Style.ColumnLimit != 0 && Previous.BlockKind == BK_Block && 36935995679SDaniel Jasper Previous.is(tok::l_brace) && !Current.isOneOf(tok::r_brace, tok::comment)) 3709697281eSDaniel Jasper return true; 3719697281eSDaniel Jasper 3720a589416SDaniel Jasper if (Current.is(tok::lessless) && 3730a589416SDaniel Jasper ((Previous.is(tok::identifier) && Previous.TokenText == "endl") || 3740a589416SDaniel Jasper (Previous.Tok.isLiteral() && (Previous.TokenText.endswith("\\n\"") || 3750a589416SDaniel Jasper Previous.TokenText == "\'\\n\'")))) 37669963129SDaniel Jasper return true; 37769963129SDaniel Jasper 37835599fdfSKrasimir Georgiev if (Previous.is(TT_BlockComment) && Previous.IsMultiline) 37935599fdfSKrasimir Georgiev return true; 38035599fdfSKrasimir Georgiev 38135599fdfSKrasimir Georgiev if (State.NoContinuation) 38235599fdfSKrasimir Georgiev return true; 38335599fdfSKrasimir Georgiev 384de0328aeSDaniel Jasper return false; 385de0328aeSDaniel Jasper } 386de0328aeSDaniel Jasper 387de0328aeSDaniel Jasper unsigned ContinuationIndenter::addTokenToState(LineState &State, bool Newline, 3888de9ed05SDaniel Jasper bool DryRun, 3898de9ed05SDaniel Jasper unsigned ExtraSpaces) { 390de0328aeSDaniel Jasper const FormatToken &Current = *State.NextToken; 391de0328aeSDaniel Jasper 392819788daSManuel Klimek assert(!State.Stack.empty()); 39335599fdfSKrasimir Georgiev State.NoContinuation = false; 39435599fdfSKrasimir Georgiev 395a98b7b01SDaniel Jasper if ((Current.is(TT_ImplicitStringLiteral) && 3962145bc02SCraig Topper (Current.Previous->Tok.getIdentifierInfo() == nullptr || 3979885784dSDaniel Jasper Current.Previous->Tok.getIdentifierInfo()->getPPKeywordID() == 3989885784dSDaniel Jasper tok::pp_not_keyword))) { 39930526e79SDaniel Jasper unsigned EndColumn = 40030526e79SDaniel Jasper SourceMgr.getSpellingColumnNumber(Current.WhitespaceRange.getEnd()); 40130526e79SDaniel Jasper if (Current.LastNewlineOffset != 0) { 40230526e79SDaniel Jasper // If there is a newline within this token, the final column will solely 40330526e79SDaniel Jasper // determined by the current end column. 40430526e79SDaniel Jasper State.Column = EndColumn; 40530526e79SDaniel Jasper } else { 40630526e79SDaniel Jasper unsigned StartColumn = 40730526e79SDaniel Jasper SourceMgr.getSpellingColumnNumber(Current.WhitespaceRange.getBegin()); 40830526e79SDaniel Jasper assert(EndColumn >= StartColumn); 40930526e79SDaniel Jasper State.Column += EndColumn - StartColumn; 41030526e79SDaniel Jasper } 411240dfda3SDaniel Jasper moveStateToNextToken(State, DryRun, /*Newline=*/false); 412de0328aeSDaniel Jasper return 0; 413de0328aeSDaniel Jasper } 414de0328aeSDaniel Jasper 4151f80396dSAlexander Kornienko unsigned Penalty = 0; 4161f80396dSAlexander Kornienko if (Newline) 4171f80396dSAlexander Kornienko Penalty = addTokenOnNewLine(State, DryRun); 4181f80396dSAlexander Kornienko else 41948437ce5SDaniel Jasper addTokenOnCurrentLine(State, DryRun, ExtraSpaces); 4201f80396dSAlexander Kornienko 4211f80396dSAlexander Kornienko return moveStateToNextToken(State, DryRun, Newline) + Penalty; 4221f80396dSAlexander Kornienko } 4231f80396dSAlexander Kornienko 42448437ce5SDaniel Jasper void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun, 4251f80396dSAlexander Kornienko unsigned ExtraSpaces) { 42671814b44SManuel Klimek FormatToken &Current = *State.NextToken; 4271f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 4281f80396dSAlexander Kornienko if (Current.is(tok::equal) && 42905cd5868SDaniel Jasper (State.Line->First->is(tok::kw_for) || Current.NestingLevel == 0) && 4301f80396dSAlexander Kornienko State.Stack.back().VariablePos == 0) { 4311f80396dSAlexander Kornienko State.Stack.back().VariablePos = State.Column; 4321f80396dSAlexander Kornienko // Move over * and & if they are bound to the variable name. 4331f80396dSAlexander Kornienko const FormatToken *Tok = &Previous; 4341f80396dSAlexander Kornienko while (Tok && State.Stack.back().VariablePos >= Tok->ColumnWidth) { 4351f80396dSAlexander Kornienko State.Stack.back().VariablePos -= Tok->ColumnWidth; 4361f80396dSAlexander Kornienko if (Tok->SpacesRequiredBefore != 0) 4371f80396dSAlexander Kornienko break; 4381f80396dSAlexander Kornienko Tok = Tok->Previous; 4391f80396dSAlexander Kornienko } 4401f80396dSAlexander Kornienko if (Previous.PartOfMultiVariableDeclStmt) 4411f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Stack.back().VariablePos; 4421f80396dSAlexander Kornienko } 4431f80396dSAlexander Kornienko 4441f80396dSAlexander Kornienko unsigned Spaces = Current.SpacesRequiredBefore + ExtraSpaces; 4451f80396dSAlexander Kornienko 446ad47c907SKrasimir Georgiev // Indent preprocessor directives after the hash if required. 447ad47c907SKrasimir Georgiev int PPColumnCorrection = 0; 448ad47c907SKrasimir Georgiev if (Style.IndentPPDirectives == FormatStyle::PPDIS_AfterHash && 449ad47c907SKrasimir Georgiev Previous.is(tok::hash) && State.FirstIndent > 0 && 450ad47c907SKrasimir Georgiev (State.Line->Type == LT_PreprocessorDirective || 451ad47c907SKrasimir Georgiev State.Line->Type == LT_ImportStatement)) { 452ad47c907SKrasimir Georgiev Spaces += State.FirstIndent; 453ad47c907SKrasimir Georgiev 454ad47c907SKrasimir Georgiev // For preprocessor indent with tabs, State.Column will be 1 because of the 455ad47c907SKrasimir Georgiev // hash. This causes second-level indents onward to have an extra space 456ad47c907SKrasimir Georgiev // after the tabs. We avoid this misalignment by subtracting 1 from the 457ad47c907SKrasimir Georgiev // column value passed to replaceWhitespace(). 458ad47c907SKrasimir Georgiev if (Style.UseTab != FormatStyle::UT_Never) 459ad47c907SKrasimir Georgiev PPColumnCorrection = -1; 460ad47c907SKrasimir Georgiev } 461ad47c907SKrasimir Georgiev 4621f80396dSAlexander Kornienko if (!DryRun) 4637d42f3f7SDaniel Jasper Whitespaces.replaceWhitespace(Current, /*Newlines=*/0, Spaces, 464ad47c907SKrasimir Georgiev State.Column + Spaces + PPColumnCorrection); 4651f80396dSAlexander Kornienko 4660ef8ee19SAndi-Bogdan Postelnicu // If "BreakBeforeInheritanceComma" mode, don't break within the inheritance 4670ef8ee19SAndi-Bogdan Postelnicu // declaration unless there is multiple inheritance. 4680ef8ee19SAndi-Bogdan Postelnicu if (Style.BreakBeforeInheritanceComma && Current.is(TT_InheritanceColon)) 4690ef8ee19SAndi-Bogdan Postelnicu State.Stack.back().NoLineBreak = true; 4700ef8ee19SAndi-Bogdan Postelnicu 471a98b7b01SDaniel Jasper if (Current.is(TT_SelectorName) && 472b88b25feSDaniel Jasper !State.Stack.back().ObjCSelectorNameFound) { 47306a26957SDaniel Jasper unsigned MinIndent = 47406a26957SDaniel Jasper std::max(State.FirstIndent + Style.ContinuationIndentWidth, 47506a26957SDaniel Jasper State.Stack.back().Indent); 47606a26957SDaniel Jasper unsigned FirstColonPos = State.Column + Spaces + Current.ColumnWidth; 477b88b25feSDaniel Jasper if (Current.LongestObjCSelectorName == 0) 478b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 47906a26957SDaniel Jasper else if (MinIndent + Current.LongestObjCSelectorName > FirstColonPos) 48006a26957SDaniel Jasper State.Stack.back().ColonPos = MinIndent + Current.LongestObjCSelectorName; 4811f80396dSAlexander Kornienko else 48206a26957SDaniel Jasper State.Stack.back().ColonPos = FirstColonPos; 4831f80396dSAlexander Kornienko } 4841f80396dSAlexander Kornienko 4856501f7e8SDaniel Jasper // In "AlwaysBreak" mode, enforce wrapping directly after the parenthesis by 4866501f7e8SDaniel Jasper // disallowing any further line breaks if there is no line break after the 4876501f7e8SDaniel Jasper // opening parenthesis. Don't break if it doesn't conserve columns. 4886501f7e8SDaniel Jasper if (Style.AlignAfterOpenBracket == FormatStyle::BAS_AlwaysBreak && 489b618a985SDaniel Jasper Previous.isOneOf(tok::l_paren, TT_TemplateOpener, tok::l_square) && 490b618a985SDaniel Jasper State.Column > getNewLineColumn(State) && 49189628f64SManuel Klimek (!Previous.Previous || !Previous.Previous->isOneOf( 49289628f64SManuel Klimek tok::kw_for, tok::kw_while, tok::kw_switch)) && 493710f8493SDaniel Jasper // Don't do this for simple (no expressions) one-argument function calls 494710f8493SDaniel Jasper // as that feels like needlessly wasting whitespace, e.g.: 495710f8493SDaniel Jasper // 496710f8493SDaniel Jasper // caaaaaaaaaaaall( 497710f8493SDaniel Jasper // caaaaaaaaaaaall( 498710f8493SDaniel Jasper // caaaaaaaaaaaall( 499710f8493SDaniel Jasper // caaaaaaaaaaaaaaaaaaaaaaall(aaaaaaaaaaaaaa, aaaaaaaaa)))); 500710f8493SDaniel Jasper Current.FakeLParens.size() > 0 && 501710f8493SDaniel Jasper Current.FakeLParens.back() > prec::Unknown) 5026501f7e8SDaniel Jasper State.Stack.back().NoLineBreak = true; 50398e0b12dSDaniel Jasper if (Previous.is(TT_TemplateString) && Previous.opensScope()) 50498e0b12dSDaniel Jasper State.Stack.back().NoLineBreak = true; 5056501f7e8SDaniel Jasper 5066501f7e8SDaniel Jasper if (Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign && 5076501f7e8SDaniel Jasper Previous.opensScope() && Previous.isNot(TT_ObjCMethodExpr) && 508a98b7b01SDaniel Jasper (Current.isNot(TT_LineComment) || Previous.BlockKind == BK_BracedInit)) 5091f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column + Spaces; 510ec01cd6eSDaniel Jasper if (State.Stack.back().AvoidBinPacking && startsNextParameter(Current, Style)) 5111f80396dSAlexander Kornienko State.Stack.back().NoLineBreak = true; 512775954beSDaniel Jasper if (startsSegmentOfBuilderTypeCall(Current) && 513775954beSDaniel Jasper State.Column > getNewLineColumn(State)) 5141f80396dSAlexander Kornienko State.Stack.back().ContainsUnwrappedBuilder = true; 5151f80396dSAlexander Kornienko 5166f2b88a3SDaniel Jasper if (Current.is(TT_LambdaArrow) && Style.Language == FormatStyle::LK_Java) 51705cd9292SDaniel Jasper State.Stack.back().NoLineBreak = true; 518d6f17d83SDaniel Jasper if (Current.isMemberAccess() && Previous.is(tok::r_paren) && 519d6f17d83SDaniel Jasper (Previous.MatchingParen && 52098e0b12dSDaniel Jasper (Previous.TotalLength - Previous.MatchingParen->TotalLength > 10))) 521d6f17d83SDaniel Jasper // If there is a function call with long parameters, break before trailing 522d6f17d83SDaniel Jasper // calls. This prevents things like: 523d6f17d83SDaniel Jasper // EXPECT_CALL(SomeLongParameter).Times( 524d6f17d83SDaniel Jasper // 2); 525d6f17d83SDaniel Jasper // We don't want to do this for short parameters as they can just be 526d6f17d83SDaniel Jasper // indexes. 527d6f17d83SDaniel Jasper State.Stack.back().NoLineBreak = true; 528d6f17d83SDaniel Jasper 529240527caSDaniel Jasper // Don't allow the RHS of an operator to be split over multiple lines unless 530240527caSDaniel Jasper // there is a line-break right after the operator. 531240527caSDaniel Jasper // Exclude relational operators, as there, it is always more desirable to 532240527caSDaniel Jasper // have the LHS 'left' of the RHS. 533240527caSDaniel Jasper const FormatToken *P = Current.getPreviousNonComment(); 534240527caSDaniel Jasper if (!Current.is(tok::comment) && P && 535240527caSDaniel Jasper (P->isOneOf(TT_BinaryOperator, tok::comma) || 536240527caSDaniel Jasper (P->is(TT_ConditionalExpr) && P->is(tok::colon))) && 537240527caSDaniel Jasper !P->isOneOf(TT_OverloadedOperator, TT_CtorInitializerComma) && 538240527caSDaniel Jasper P->getPrecedence() != prec::Assignment && 539240527caSDaniel Jasper P->getPrecedence() != prec::Relational) { 540240527caSDaniel Jasper bool BreakBeforeOperator = 541b127039cSDaniel Jasper P->MustBreakBefore || P->is(tok::lessless) || 542240527caSDaniel Jasper (P->is(TT_BinaryOperator) && 543240527caSDaniel Jasper Style.BreakBeforeBinaryOperators != FormatStyle::BOS_None) || 544240527caSDaniel Jasper (P->is(TT_ConditionalExpr) && Style.BreakBeforeTernaryOperators); 54521f7dea5SDaniel Jasper // Don't do this if there are only two operands. In these cases, there is 54621f7dea5SDaniel Jasper // always a nice vertical separation between them and the extra line break 54721f7dea5SDaniel Jasper // does not help. 54821f7dea5SDaniel Jasper bool HasTwoOperands = 54921f7dea5SDaniel Jasper P->OperatorIndex == 0 && !P->NextOperator && !P->is(TT_ConditionalExpr); 550c3aa05c0SDaniel Jasper if ((!BreakBeforeOperator && !(HasTwoOperands && Style.AlignOperands)) || 551240527caSDaniel Jasper (!State.Stack.back().LastOperatorWrapped && BreakBeforeOperator)) 552240527caSDaniel Jasper State.Stack.back().NoLineBreakInOperand = true; 553240527caSDaniel Jasper } 554240527caSDaniel Jasper 5551f80396dSAlexander Kornienko State.Column += Spaces; 5568acf822bSDaniel Jasper if (Current.isNot(tok::comment) && Previous.is(tok::l_paren) && 55711a0ac66SDaniel Jasper Previous.Previous && 5586a7d5a7aSDaniel Jasper (Previous.Previous->isOneOf(tok::kw_if, tok::kw_for) || 5596a7d5a7aSDaniel Jasper Previous.Previous->endsSequence(tok::kw_constexpr, tok::kw_if))) { 5601f80396dSAlexander Kornienko // Treat the condition inside an if as if it was a second function 5616633ab8aSDaniel Jasper // parameter, i.e. let nested calls have a continuation indent. 5628acf822bSDaniel Jasper State.Stack.back().LastSpace = State.Column; 56311a0ac66SDaniel Jasper State.Stack.back().NestedBlockIndent = State.Column; 56411a0ac66SDaniel Jasper } else if (!Current.isOneOf(tok::comment, tok::caret) && 565804a276fSDaniel Jasper ((Previous.is(tok::comma) && 566804a276fSDaniel Jasper !Previous.is(TT_OverloadedOperator)) || 56711a0ac66SDaniel Jasper (Previous.is(tok::colon) && Previous.is(TT_ObjCMethodExpr)))) { 5681f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 569a6b6d51bSFrancois Ferrand } else if (Previous.is(TT_CtorInitializerColon) && 570a6b6d51bSFrancois Ferrand Style.BreakConstructorInitializers == 571a6b6d51bSFrancois Ferrand FormatStyle::BCIS_AfterColon) { 572a6b6d51bSFrancois Ferrand State.Stack.back().Indent = State.Column; 573a6b6d51bSFrancois Ferrand State.Stack.back().LastSpace = State.Column; 57411a0ac66SDaniel Jasper } else if ((Previous.isOneOf(TT_BinaryOperator, TT_ConditionalExpr, 575a98b7b01SDaniel Jasper TT_CtorInitializerColon)) && 5760e61784aSDaniel Jasper ((Previous.getPrecedence() != prec::Assignment && 5770e61784aSDaniel Jasper (Previous.isNot(tok::lessless) || Previous.OperatorIndex != 0 || 57800492f96SDaniel Jasper Previous.NextOperator)) || 57911a0ac66SDaniel Jasper Current.StartsBinaryExpression)) { 580602a727aSDaniel Jasper // Indent relative to the RHS of the expression unless this is a simple 581602a727aSDaniel Jasper // assignment without binary expression on the RHS. Also indent relative to 582602a727aSDaniel Jasper // unary operators and the colons of constructor initializers. 5831f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 58411a0ac66SDaniel Jasper } else if (Previous.is(TT_InheritanceColon)) { 5851f80396dSAlexander Kornienko State.Stack.back().Indent = State.Column; 586f9a5e404SDaniel Jasper State.Stack.back().LastSpace = State.Column; 587f9a5e404SDaniel Jasper } else if (Previous.opensScope()) { 5881f80396dSAlexander Kornienko // If a function has a trailing call, indent all parameters from the 5891f80396dSAlexander Kornienko // opening parenthesis. This avoids confusing indents like: 5901f80396dSAlexander Kornienko // OuterFunction(InnerFunctionCall( // break 5911f80396dSAlexander Kornienko // ParameterToInnerFunction)) // break 5921f80396dSAlexander Kornienko // .SecondInnerFunctionCall(); 5931f80396dSAlexander Kornienko bool HasTrailingCall = false; 5941f80396dSAlexander Kornienko if (Previous.MatchingParen) { 5951f80396dSAlexander Kornienko const FormatToken *Next = Previous.MatchingParen->getNextNonComment(); 5961f80396dSAlexander Kornienko HasTrailingCall = Next && Next->isMemberAccess(); 5971f80396dSAlexander Kornienko } 598d97d5d5cSDaniel Jasper if (HasTrailingCall && State.Stack.size() > 1 && 5991f80396dSAlexander Kornienko State.Stack[State.Stack.size() - 2].CallContinuation == 0) 6001f80396dSAlexander Kornienko State.Stack.back().LastSpace = State.Column; 6011f80396dSAlexander Kornienko } 6021f80396dSAlexander Kornienko } 6031f80396dSAlexander Kornienko 6041f80396dSAlexander Kornienko unsigned ContinuationIndenter::addTokenOnNewLine(LineState &State, 6051f80396dSAlexander Kornienko bool DryRun) { 60671814b44SManuel Klimek FormatToken &Current = *State.NextToken; 6071f80396dSAlexander Kornienko const FormatToken &Previous = *State.NextToken->Previous; 6089f388d04SDaniel Jasper 6091f80396dSAlexander Kornienko // Extra penalty that needs to be added because of the way certain line 6101f80396dSAlexander Kornienko // breaks are chosen. 6111f80396dSAlexander Kornienko unsigned Penalty = 0; 6121f80396dSAlexander Kornienko 613a0407740SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 614a0407740SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 615a0407740SDaniel Jasper if (!NextNonComment) 616a0407740SDaniel Jasper NextNonComment = &Current; 61705cd5868SDaniel Jasper // The first line break on any NestingLevel causes an extra penalty in order 6188de9ed05SDaniel Jasper // prefer similar line breaks. 6198de9ed05SDaniel Jasper if (!State.Stack.back().ContainsLineBreak) 6208de9ed05SDaniel Jasper Penalty += 15; 6218de9ed05SDaniel Jasper State.Stack.back().ContainsLineBreak = true; 6228de9ed05SDaniel Jasper 6238de9ed05SDaniel Jasper Penalty += State.NextToken->SplitPenalty; 6248de9ed05SDaniel Jasper 625de0328aeSDaniel Jasper // Breaking before the first "<<" is generally not desirable if the LHS is 6267aacf468SDaniel Jasper // short. Also always add the penalty if the LHS is split over multiple lines 6272b7556ecSDaniel Jasper // to avoid unnecessary line breaks that just work around this penalty. 628a0407740SDaniel Jasper if (NextNonComment->is(tok::lessless) && 629a0407740SDaniel Jasper State.Stack.back().FirstLessLess == 0 && 630004177eeSDaniel Jasper (State.Column <= Style.ColumnLimit / 3 || 63148437ce5SDaniel Jasper State.Stack.back().BreakBeforeParameter)) 6328de9ed05SDaniel Jasper Penalty += Style.PenaltyBreakFirstLessLess; 633de0328aeSDaniel Jasper 6349f388d04SDaniel Jasper State.Column = getNewLineColumn(State); 635ed3f3957SDaniel Jasper 636ed3f3957SDaniel Jasper // Indent nested blocks relative to this column, unless in a very specific 637ed3f3957SDaniel Jasper // JavaScript special case where: 638ed3f3957SDaniel Jasper // 639ed3f3957SDaniel Jasper // var loooooong_name = 640ed3f3957SDaniel Jasper // function() { 641ed3f3957SDaniel Jasper // // code 642ed3f3957SDaniel Jasper // } 643ed3f3957SDaniel Jasper // 64487448c55SDaniel Jasper // is common and should be formatted like a free-standing function. The same 64587448c55SDaniel Jasper // goes for wrapping before the lambda return type arrow. 64687448c55SDaniel Jasper if (!Current.is(TT_LambdaArrow) && 64787448c55SDaniel Jasper (Style.Language != FormatStyle::LK_JavaScript || 648e77f19c0SDaniel Jasper Current.NestingLevel != 0 || !PreviousNonComment || 649e77f19c0SDaniel Jasper !PreviousNonComment->is(tok::equal) || 65087448c55SDaniel Jasper !Current.isOneOf(Keywords.kw_async, Keywords.kw_function))) 65111a0ac66SDaniel Jasper State.Stack.back().NestedBlockIndent = State.Column; 652ed3f3957SDaniel Jasper 6539f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 6549f388d04SDaniel Jasper if (State.Stack.back().CallContinuation == 0) 655de0328aeSDaniel Jasper State.Stack.back().CallContinuation = State.Column; 656a98b7b01SDaniel Jasper } else if (NextNonComment->is(TT_SelectorName)) { 657b88b25feSDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 658a0407740SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) { 659b88b25feSDaniel Jasper State.Stack.back().AlignColons = false; 660b88b25feSDaniel Jasper } else { 661b302f9a0SDaniel Jasper State.Stack.back().ColonPos = 662a2a4d9c0SDaniel Jasper (Style.IndentWrappedFunctionNames 663a2a4d9c0SDaniel Jasper ? std::max(State.Stack.back().Indent, 664a2a4d9c0SDaniel Jasper State.FirstIndent + Style.ContinuationIndentWidth) 665a2a4d9c0SDaniel Jasper : State.Stack.back().Indent) + 666a2a4d9c0SDaniel Jasper NextNonComment->LongestObjCSelectorName; 667b88b25feSDaniel Jasper } 6689f388d04SDaniel Jasper } else if (State.Stack.back().AlignColons && 6699f388d04SDaniel Jasper State.Stack.back().ColonPos <= NextNonComment->ColumnWidth) { 670a0407740SDaniel Jasper State.Stack.back().ColonPos = State.Column + NextNonComment->ColumnWidth; 671de0328aeSDaniel Jasper } 6721fd6f1f8SDaniel Jasper } else if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 673a98b7b01SDaniel Jasper PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral)) { 674b88b25feSDaniel Jasper // FIXME: This is hacky, find a better way. The problem is that in an ObjC 675b88b25feSDaniel Jasper // method expression, the block should be aligned to the line starting it, 676b88b25feSDaniel Jasper // e.g.: 677b88b25feSDaniel Jasper // [aaaaaaaaaaaaaaa aaaaaaaaa: \\ break for some reason 678b88b25feSDaniel Jasper // ^(int *i) { 679b88b25feSDaniel Jasper // // ... 680b88b25feSDaniel Jasper // }]; 68105cd5868SDaniel Jasper // Thus, we set LastSpace of the next higher NestingLevel, to which we move 682b88b25feSDaniel Jasper // when we consume all of the "}"'s FakeRParens at the "{". 6839a26e773SDaniel Jasper if (State.Stack.size() > 1) 6849f388d04SDaniel Jasper State.Stack[State.Stack.size() - 2].LastSpace = 6859f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 6869f388d04SDaniel Jasper Style.ContinuationIndentWidth; 687de0328aeSDaniel Jasper } 688de0328aeSDaniel Jasper 68935e4122fSDaniel Jasper if ((PreviousNonComment && 69035e4122fSDaniel Jasper PreviousNonComment->isOneOf(tok::comma, tok::semi) && 691de0328aeSDaniel Jasper !State.Stack.back().AvoidBinPacking) || 692a98b7b01SDaniel Jasper Previous.is(TT_BinaryOperator)) 693de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 694a98b7b01SDaniel Jasper if (Previous.isOneOf(TT_TemplateCloser, TT_JavaAnnotation) && 69539af6cd5SDaniel Jasper Current.NestingLevel == 0) 696de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 697a0407740SDaniel Jasper if (NextNonComment->is(tok::question) || 698165b29e2SDaniel Jasper (PreviousNonComment && PreviousNonComment->is(tok::question))) 699165b29e2SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 7005962fa80SDaniel Jasper if (Current.is(TT_BinaryOperator) && Current.CanBreakBefore) 7015962fa80SDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 702de0328aeSDaniel Jasper 703de0328aeSDaniel Jasper if (!DryRun) { 704a69ca9beSDaniel Jasper unsigned Newlines = std::max( 705a69ca9beSDaniel Jasper 1u, std::min(Current.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1)); 706a1c30937SKrasimir Georgiev bool ContinuePPDirective = 707a1c30937SKrasimir Georgiev State.Line->InPPDirective && State.Line->Type != LT_ImportStatement; 7087d42f3f7SDaniel Jasper Whitespaces.replaceWhitespace(Current, Newlines, State.Column, State.Column, 709a1c30937SKrasimir Georgiev ContinuePPDirective); 710de0328aeSDaniel Jasper } 711de0328aeSDaniel Jasper 712de0328aeSDaniel Jasper if (!Current.isTrailingComment()) 713de0328aeSDaniel Jasper State.Stack.back().LastSpace = State.Column; 714602a727aSDaniel Jasper if (Current.is(tok::lessless)) 715602a727aSDaniel Jasper // If we are breaking before a "<<", we always want to indent relative to 716602a727aSDaniel Jasper // RHS. This is necessary only for "<<", as we special-case it and don't 717602a727aSDaniel Jasper // always indent relative to the RHS. 718602a727aSDaniel Jasper State.Stack.back().LastSpace += 3; // 3 -> width of "<< ". 719602a727aSDaniel Jasper 72005cd5868SDaniel Jasper State.StartOfLineLevel = Current.NestingLevel; 72105cd5868SDaniel Jasper State.LowestLevelOnLine = Current.NestingLevel; 722de0328aeSDaniel Jasper 723de0328aeSDaniel Jasper // Any break on this level means that the parent level has been broken 724de0328aeSDaniel Jasper // and we need to avoid bin packing there. 7254b444495SDaniel Jasper bool NestedBlockSpecialCase = 7261dbc2105SDaniel Jasper !Style.isCpp() && Current.is(tok::r_brace) && State.Stack.size() > 1 && 7274b444495SDaniel Jasper State.Stack[State.Stack.size() - 2].NestedBlockInlined; 7281699eca1SDaniel Jasper if (!NestedBlockSpecialCase) 7291699eca1SDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) 730de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 731b16b969dSDaniel Jasper 7329e5ede0fSDaniel Jasper if (PreviousNonComment && 733a6b6d51bSFrancois Ferrand !PreviousNonComment->isOneOf(tok::comma, tok::colon, tok::semi) && 734a98b7b01SDaniel Jasper (PreviousNonComment->isNot(TT_TemplateCloser) || 7356c0ee17bSDaniel Jasper Current.NestingLevel != 0) && 73647bbda09SDaniel Jasper !PreviousNonComment->isOneOf( 73747bbda09SDaniel Jasper TT_BinaryOperator, TT_FunctionAnnotationRParen, TT_JavaAnnotation, 738a98b7b01SDaniel Jasper TT_LeadingJavaAnnotation) && 739a98b7b01SDaniel Jasper Current.isNot(TT_BinaryOperator) && !PreviousNonComment->opensScope()) 740de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 741de0328aeSDaniel Jasper 7421db6c386SDaniel Jasper // If we break after { or the [ of an array initializer, we should also break 7431db6c386SDaniel Jasper // before the corresponding } or ]. 74490818057SDaniel Jasper if (PreviousNonComment && 74598e0b12dSDaniel Jasper (PreviousNonComment->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) || 746c10d97f9SMartin Probst opensProtoMessageField(*PreviousNonComment, Style))) 747de0328aeSDaniel Jasper State.Stack.back().BreakBeforeClosingBrace = true; 748de0328aeSDaniel Jasper 749de0328aeSDaniel Jasper if (State.Stack.back().AvoidBinPacking) { 750de0328aeSDaniel Jasper // If we are breaking after '(', '{', '<', this is not bin packing 7512a958321SDaniel Jasper // unless AllowAllParametersOfDeclarationOnNextLine is false or this is a 7522a958321SDaniel Jasper // dict/object literal. 753a98b7b01SDaniel Jasper if (!Previous.isOneOf(tok::l_paren, tok::l_brace, TT_BinaryOperator) || 754de0328aeSDaniel Jasper (!Style.AllowAllParametersOfDeclarationOnNextLine && 7552a958321SDaniel Jasper State.Line->MustBeDeclaration) || 756a98b7b01SDaniel Jasper Previous.is(TT_DictLiteral)) 757de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 758de0328aeSDaniel Jasper } 759de0328aeSDaniel Jasper 7601f80396dSAlexander Kornienko return Penalty; 761de0328aeSDaniel Jasper } 762de0328aeSDaniel Jasper 7639f388d04SDaniel Jasper unsigned ContinuationIndenter::getNewLineColumn(const LineState &State) { 7645d2587daSDaniel Jasper if (!State.NextToken || !State.NextToken->Previous) 7655d2587daSDaniel Jasper return 0; 7669f388d04SDaniel Jasper FormatToken &Current = *State.NextToken; 7674281c5aeSDaniel Jasper const FormatToken &Previous = *Current.Previous; 7689f388d04SDaniel Jasper // If we are continuing an expression, we want to use the continuation indent. 7699f388d04SDaniel Jasper unsigned ContinuationIndent = 7709f388d04SDaniel Jasper std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 7719f388d04SDaniel Jasper Style.ContinuationIndentWidth; 7729f388d04SDaniel Jasper const FormatToken *PreviousNonComment = Current.getPreviousNonComment(); 7739f388d04SDaniel Jasper const FormatToken *NextNonComment = Previous.getNextNonComment(); 7749f388d04SDaniel Jasper if (!NextNonComment) 7759f388d04SDaniel Jasper NextNonComment = &Current; 77650b4bd7cSDaniel Jasper 77750b4bd7cSDaniel Jasper // Java specific bits. 778d0ec0d62SDaniel Jasper if (Style.Language == FormatStyle::LK_Java && 779d0ec0d62SDaniel Jasper Current.isOneOf(Keywords.kw_implements, Keywords.kw_extends)) 78050b4bd7cSDaniel Jasper return std::max(State.Stack.back().LastSpace, 78150b4bd7cSDaniel Jasper State.Stack.back().Indent + Style.ContinuationIndentWidth); 78250b4bd7cSDaniel Jasper 783b05a81deSDaniel Jasper if (NextNonComment->is(tok::l_brace) && NextNonComment->BlockKind == BK_Block) 78405cd5868SDaniel Jasper return Current.NestingLevel == 0 ? State.FirstIndent 7859f388d04SDaniel Jasper : State.Stack.back().Indent; 786ff747be4SKrasimir Georgiev if ((Current.isOneOf(tok::r_brace, tok::r_square) || 78726b144ccSKrasimir Georgiev (Current.is(tok::greater) && 78826b144ccSKrasimir Georgiev (Style.Language == FormatStyle::LK_Proto || 78926b144ccSKrasimir Georgiev Style.Language == FormatStyle::LK_TextProto))) && 790ff747be4SKrasimir Georgiev State.Stack.size() > 1) { 791bd73bcf8SDaniel Jasper if (Current.closesBlockOrBlockTypeList(Style)) 79211a0ac66SDaniel Jasper return State.Stack[State.Stack.size() - 2].NestedBlockIndent; 79311a0ac66SDaniel Jasper if (Current.MatchingParen && 79411a0ac66SDaniel Jasper Current.MatchingParen->BlockKind == BK_BracedInit) 7959f388d04SDaniel Jasper return State.Stack[State.Stack.size() - 2].LastSpace; 7969f388d04SDaniel Jasper return State.FirstIndent; 7979f388d04SDaniel Jasper } 798b2f06eaeSMartin Probst // Indent a closing parenthesis at the previous level if followed by a semi or 799b2f06eaeSMartin Probst // opening brace. This allows indentations such as: 800b2f06eaeSMartin Probst // foo( 801b2f06eaeSMartin Probst // a, 802b2f06eaeSMartin Probst // ); 803b2f06eaeSMartin Probst // function foo( 804b2f06eaeSMartin Probst // a, 805b2f06eaeSMartin Probst // ) { 806b2f06eaeSMartin Probst // code(); // 807b2f06eaeSMartin Probst // } 808b2f06eaeSMartin Probst if (Current.is(tok::r_paren) && State.Stack.size() > 1 && 809b2f06eaeSMartin Probst (!Current.Next || Current.Next->isOneOf(tok::semi, tok::l_brace))) 8102c1cdae2SMartin Probst return State.Stack[State.Stack.size() - 2].LastSpace; 81198e0b12dSDaniel Jasper if (NextNonComment->is(TT_TemplateString) && NextNonComment->closesScope()) 81298e0b12dSDaniel Jasper return State.Stack[State.Stack.size() - 2].LastSpace; 813783bac6bSDaniel Jasper if (Current.is(tok::identifier) && Current.Next && 814ddb19248SKrasimir Georgiev (Current.Next->is(TT_DictLiteral) || 815ddb19248SKrasimir Georgiev ((Style.Language == FormatStyle::LK_Proto || 816ddb19248SKrasimir Georgiev Style.Language == FormatStyle::LK_TextProto) && 817ddb19248SKrasimir Georgiev Current.Next->isOneOf(TT_TemplateOpener, tok::l_brace)))) 818783bac6bSDaniel Jasper return State.Stack.back().Indent; 8190928553eSDaniel Jasper if (NextNonComment->is(TT_ObjCStringLiteral) && 8200928553eSDaniel Jasper State.StartOfStringLiteral != 0) 8210928553eSDaniel Jasper return State.StartOfStringLiteral - 1; 822d4fa2e63SAlexander Kornienko if (NextNonComment->isStringLiteral() && State.StartOfStringLiteral != 0) 823d4fa2e63SAlexander Kornienko return State.StartOfStringLiteral; 8249f388d04SDaniel Jasper if (NextNonComment->is(tok::lessless) && 8259f388d04SDaniel Jasper State.Stack.back().FirstLessLess != 0) 8269f388d04SDaniel Jasper return State.Stack.back().FirstLessLess; 8279f388d04SDaniel Jasper if (NextNonComment->isMemberAccess()) { 82824a14777SDaniel Jasper if (State.Stack.back().CallContinuation == 0) 8299f388d04SDaniel Jasper return ContinuationIndent; 8309f388d04SDaniel Jasper return State.Stack.back().CallContinuation; 8319f388d04SDaniel Jasper } 8329f388d04SDaniel Jasper if (State.Stack.back().QuestionColumn != 0 && 833c0d606a5SDaniel Jasper ((NextNonComment->is(tok::colon) && 834a98b7b01SDaniel Jasper NextNonComment->is(TT_ConditionalExpr)) || 835a98b7b01SDaniel Jasper Previous.is(TT_ConditionalExpr))) 8369f388d04SDaniel Jasper return State.Stack.back().QuestionColumn; 8379f388d04SDaniel Jasper if (Previous.is(tok::comma) && State.Stack.back().VariablePos != 0) 8389f388d04SDaniel Jasper return State.Stack.back().VariablePos; 839e9ab42dfSDaniel Jasper if ((PreviousNonComment && 840e9ab42dfSDaniel Jasper (PreviousNonComment->ClosesTemplateDeclaration || 84147bbda09SDaniel Jasper PreviousNonComment->isOneOf( 84247bbda09SDaniel Jasper TT_AttributeParen, TT_FunctionAnnotationRParen, TT_JavaAnnotation, 843a98b7b01SDaniel Jasper TT_LeadingJavaAnnotation))) || 844c75e1effSDaniel Jasper (!Style.IndentWrappedFunctionNames && 845a98b7b01SDaniel Jasper NextNonComment->isOneOf(tok::kw_operator, TT_FunctionDeclarationName))) 8469f388d04SDaniel Jasper return std::max(State.Stack.back().LastSpace, State.Stack.back().Indent); 847a98b7b01SDaniel Jasper if (NextNonComment->is(TT_SelectorName)) { 8489f388d04SDaniel Jasper if (!State.Stack.back().ObjCSelectorNameFound) { 84924a14777SDaniel Jasper if (NextNonComment->LongestObjCSelectorName == 0) 8509f388d04SDaniel Jasper return State.Stack.back().Indent; 851a2a4d9c0SDaniel Jasper return (Style.IndentWrappedFunctionNames 852a2a4d9c0SDaniel Jasper ? std::max(State.Stack.back().Indent, 853a2a4d9c0SDaniel Jasper State.FirstIndent + Style.ContinuationIndentWidth) 854a2a4d9c0SDaniel Jasper : State.Stack.back().Indent) + 8559f388d04SDaniel Jasper NextNonComment->LongestObjCSelectorName - 8569f388d04SDaniel Jasper NextNonComment->ColumnWidth; 8579f388d04SDaniel Jasper } 85824a14777SDaniel Jasper if (!State.Stack.back().AlignColons) 8599f388d04SDaniel Jasper return State.Stack.back().Indent; 86024a14777SDaniel Jasper if (State.Stack.back().ColonPos > NextNonComment->ColumnWidth) 8619f388d04SDaniel Jasper return State.Stack.back().ColonPos - NextNonComment->ColumnWidth; 8629f388d04SDaniel Jasper return State.Stack.back().Indent; 8639f388d04SDaniel Jasper } 864fd36f0b5SDaniel Jasper if (NextNonComment->is(tok::colon) && NextNonComment->is(TT_ObjCMethodExpr)) 865fd36f0b5SDaniel Jasper return State.Stack.back().ColonPos; 866a98b7b01SDaniel Jasper if (NextNonComment->is(TT_ArraySubscriptLSquare)) { 8679f388d04SDaniel Jasper if (State.Stack.back().StartOfArraySubscripts != 0) 8689f388d04SDaniel Jasper return State.Stack.back().StartOfArraySubscripts; 8699f388d04SDaniel Jasper return ContinuationIndent; 8709f388d04SDaniel Jasper } 8719c95013eSDaniel Jasper 8729c95013eSDaniel Jasper // This ensure that we correctly format ObjC methods calls without inputs, 8739c95013eSDaniel Jasper // i.e. where the last element isn't selector like: [callee method]; 8749c95013eSDaniel Jasper if (NextNonComment->is(tok::identifier) && NextNonComment->FakeRParens == 0 && 8759c95013eSDaniel Jasper NextNonComment->Next && NextNonComment->Next->is(TT_ObjCMethodExpr)) 876eb53668cSDaniel Jasper return State.Stack.back().Indent; 8779c95013eSDaniel Jasper 878b754a747SDaniel Jasper if (NextNonComment->isOneOf(TT_StartOfName, TT_PointerOrReference) || 879b2328b1eSDaniel Jasper Previous.isOneOf(tok::coloncolon, tok::equal, TT_JsTypeColon)) 8809f388d04SDaniel Jasper return ContinuationIndent; 8819f388d04SDaniel Jasper if (PreviousNonComment && PreviousNonComment->is(tok::colon) && 882a98b7b01SDaniel Jasper PreviousNonComment->isOneOf(TT_ObjCMethodExpr, TT_DictLiteral)) 8839f388d04SDaniel Jasper return ContinuationIndent; 884a98b7b01SDaniel Jasper if (NextNonComment->is(TT_CtorInitializerComma)) 8859f388d04SDaniel Jasper return State.Stack.back().Indent; 886a6b6d51bSFrancois Ferrand if (PreviousNonComment && PreviousNonComment->is(TT_CtorInitializerColon) && 887a6b6d51bSFrancois Ferrand Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon) 888a6b6d51bSFrancois Ferrand return State.Stack.back().Indent; 8890ef8ee19SAndi-Bogdan Postelnicu if (NextNonComment->isOneOf(TT_CtorInitializerColon, TT_InheritanceColon, 8900ef8ee19SAndi-Bogdan Postelnicu TT_InheritanceComma)) 8910ef8ee19SAndi-Bogdan Postelnicu return State.FirstIndent + Style.ConstructorInitializerIndentWidth; 892316ab38eSDaniel Jasper if (Previous.is(tok::r_paren) && !Current.isBinaryOperator() && 893119ff533SDaniel Jasper !Current.isOneOf(tok::colon, tok::comment)) 894316ab38eSDaniel Jasper return ContinuationIndent; 8955d2587daSDaniel Jasper if (State.Stack.back().Indent == State.FirstIndent && PreviousNonComment && 8969f388d04SDaniel Jasper PreviousNonComment->isNot(tok::r_brace)) 8979f388d04SDaniel Jasper // Ensure that we fall back to the continuation indent width instead of 8989f388d04SDaniel Jasper // just flushing continuations left. 8999f388d04SDaniel Jasper return State.Stack.back().Indent + Style.ContinuationIndentWidth; 9009f388d04SDaniel Jasper return State.Stack.back().Indent; 9019f388d04SDaniel Jasper } 9029f388d04SDaniel Jasper 903de0328aeSDaniel Jasper unsigned ContinuationIndenter::moveStateToNextToken(LineState &State, 904de0328aeSDaniel Jasper bool DryRun, bool Newline) { 905de0328aeSDaniel Jasper assert(State.Stack.size()); 90660553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 907de0328aeSDaniel Jasper 908240527caSDaniel Jasper if (Current.isOneOf(tok::comma, TT_BinaryOperator)) 909240527caSDaniel Jasper State.Stack.back().NoLineBreakInOperand = false; 910a98b7b01SDaniel Jasper if (Current.is(TT_InheritanceColon)) 911de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 912a98b7b01SDaniel Jasper if (Current.is(tok::lessless) && Current.isNot(TT_OverloadedOperator)) { 913c0d606a5SDaniel Jasper if (State.Stack.back().FirstLessLess == 0) 914de0328aeSDaniel Jasper State.Stack.back().FirstLessLess = State.Column; 915c0d606a5SDaniel Jasper else 916c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 917c0d606a5SDaniel Jasper } 918240527caSDaniel Jasper if (Current.is(TT_BinaryOperator) && Current.isNot(tok::lessless)) 919240527caSDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 920240527caSDaniel Jasper if (Current.is(TT_ConditionalExpr) && Current.Previous && 921240527caSDaniel Jasper !Current.Previous->is(TT_ConditionalExpr)) 922c0d606a5SDaniel Jasper State.Stack.back().LastOperatorWrapped = Newline; 923a98b7b01SDaniel Jasper if (Current.is(TT_ArraySubscriptLSquare) && 924de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts == 0) 925de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = State.Column; 92645860facSDaniel Jasper if (Style.BreakBeforeTernaryOperators && Current.is(tok::question)) 927de0328aeSDaniel Jasper State.Stack.back().QuestionColumn = State.Column; 92845860facSDaniel Jasper if (!Style.BreakBeforeTernaryOperators && Current.isNot(tok::colon)) { 92945860facSDaniel Jasper const FormatToken *Previous = Current.Previous; 93045860facSDaniel Jasper while (Previous && Previous->isTrailingComment()) 93145860facSDaniel Jasper Previous = Previous->Previous; 93245860facSDaniel Jasper if (Previous && Previous->is(tok::question)) 93345860facSDaniel Jasper State.Stack.back().QuestionColumn = State.Column; 93445860facSDaniel Jasper } 935cab46171SDaniel Jasper if (!Current.opensScope() && !Current.closesScope() && 936cab46171SDaniel Jasper !Current.is(TT_PointerOrReference)) 937de0328aeSDaniel Jasper State.LowestLevelOnLine = 93805cd5868SDaniel Jasper std::min(State.LowestLevelOnLine, Current.NestingLevel); 9394c6e0059SDaniel Jasper if (Current.isMemberAccess()) 940de0328aeSDaniel Jasper State.Stack.back().StartOfFunctionCall = 94100492f96SDaniel Jasper !Current.NextOperator ? 0 : State.Column; 9423c44c220SDaniel Jasper if (Current.is(TT_SelectorName)) { 943b88b25feSDaniel Jasper State.Stack.back().ObjCSelectorNameFound = true; 9443c44c220SDaniel Jasper if (Style.IndentWrappedFunctionNames) { 9453c44c220SDaniel Jasper State.Stack.back().Indent = 9463c44c220SDaniel Jasper State.FirstIndent + Style.ContinuationIndentWidth; 9473c44c220SDaniel Jasper } 9483c44c220SDaniel Jasper } 949a6b6d51bSFrancois Ferrand if (Current.is(TT_CtorInitializerColon) && 950a6b6d51bSFrancois Ferrand Style.BreakConstructorInitializers != FormatStyle::BCIS_AfterColon) { 951de0328aeSDaniel Jasper // Indent 2 from the column, so: 952de0328aeSDaniel Jasper // SomeClass::SomeClass() 953de0328aeSDaniel Jasper // : First(...), ... 954de0328aeSDaniel Jasper // Next(...) 955de0328aeSDaniel Jasper // ^ line up here. 956de0328aeSDaniel Jasper State.Stack.back().Indent = 95789628f64SManuel Klimek State.Column + 95889628f64SManuel Klimek (Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeComma 95989628f64SManuel Klimek ? 0 96089628f64SManuel Klimek : 2); 961d6a1cab1SDaniel Jasper State.Stack.back().NestedBlockIndent = State.Stack.back().Indent; 962de0328aeSDaniel Jasper if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine) 963de0328aeSDaniel Jasper State.Stack.back().AvoidBinPacking = true; 964de0328aeSDaniel Jasper State.Stack.back().BreakBeforeParameter = false; 965de0328aeSDaniel Jasper } 966a6b6d51bSFrancois Ferrand if (Current.is(TT_CtorInitializerColon) && 967a6b6d51bSFrancois Ferrand Style.BreakConstructorInitializers == FormatStyle::BCIS_AfterColon) { 968a6b6d51bSFrancois Ferrand State.Stack.back().Indent = 969a6b6d51bSFrancois Ferrand State.FirstIndent + Style.ConstructorInitializerIndentWidth; 970a6b6d51bSFrancois Ferrand State.Stack.back().NestedBlockIndent = State.Stack.back().Indent; 971a6b6d51bSFrancois Ferrand if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine) 972a6b6d51bSFrancois Ferrand State.Stack.back().AvoidBinPacking = true; 973a6b6d51bSFrancois Ferrand } 9740ef8ee19SAndi-Bogdan Postelnicu if (Current.is(TT_InheritanceColon)) 9750ef8ee19SAndi-Bogdan Postelnicu State.Stack.back().Indent = 9760ef8ee19SAndi-Bogdan Postelnicu State.FirstIndent + Style.ContinuationIndentWidth; 977c4144ea4SDaniel Jasper if (Current.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) && Newline) 978c4144ea4SDaniel Jasper State.Stack.back().NestedBlockIndent = 979c4144ea4SDaniel Jasper State.Column + Current.ColumnWidth + 1; 980d9b319e3SDaniel Jasper if (Current.isOneOf(TT_LambdaLSquare, TT_LambdaArrow)) 981d9b319e3SDaniel Jasper State.Stack.back().LastSpace = State.Column; 982de0328aeSDaniel Jasper 983de0328aeSDaniel Jasper // Insert scopes created by fake parenthesis. 984de0328aeSDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 985b16b969dSDaniel Jasper 986b16b969dSDaniel Jasper // Add special behavior to support a format commonly used for JavaScript 987b16b969dSDaniel Jasper // closures: 988b16b969dSDaniel Jasper // SomeFunction(function() { 989b16b969dSDaniel Jasper // foo(); 990b16b969dSDaniel Jasper // bar(); 991b16b969dSDaniel Jasper // }, a, b, c); 992b2ad4d4cSDaniel Jasper if (Current.isNot(tok::comment) && Previous && 993b2ad4d4cSDaniel Jasper Previous->isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) && 994ccff4d1eSDaniel Jasper !Previous->is(TT_DictLiteral) && State.Stack.size() > 1) { 9951699eca1SDaniel Jasper if (State.Stack[State.Stack.size() - 2].NestedBlockInlined && Newline) 9961699eca1SDaniel Jasper for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) 997b16b969dSDaniel Jasper State.Stack[i].NoLineBreak = true; 9984b444495SDaniel Jasper State.Stack[State.Stack.size() - 2].NestedBlockInlined = false; 999b16b969dSDaniel Jasper } 100089628f64SManuel Klimek if (Previous && 100189628f64SManuel Klimek (Previous->isOneOf(tok::l_paren, tok::comma, tok::colon) || 10024b444495SDaniel Jasper Previous->isOneOf(TT_BinaryOperator, TT_ConditionalExpr)) && 10034b444495SDaniel Jasper !Previous->isOneOf(TT_DictLiteral, TT_ObjCMethodExpr)) { 10044b444495SDaniel Jasper State.Stack.back().NestedBlockInlined = 10054b444495SDaniel Jasper !Newline && 100611a0ac66SDaniel Jasper (Previous->isNot(tok::l_paren) || Previous->ParameterCount > 1); 1007b16b969dSDaniel Jasper } 1008b16b969dSDaniel Jasper 100960553be5SDaniel Jasper moveStatePastFakeLParens(State, Newline); 101060553be5SDaniel Jasper moveStatePastScopeCloser(State); 1011*45ab559eSManuel Klimek bool AllowBreak = !State.Stack.back().NoLineBreak && 1012bc05ebaaSKrasimir Georgiev !State.Stack.back().NoLineBreakInOperand; 1013c06f6da3SDaniel Jasper moveStatePastScopeOpener(State, Newline); 101460553be5SDaniel Jasper moveStatePastFakeRParens(State); 101560553be5SDaniel Jasper 10160928553eSDaniel Jasper if (Current.is(TT_ObjCStringLiteral) && State.StartOfStringLiteral == 0) 10170928553eSDaniel Jasper State.StartOfStringLiteral = State.Column + 1; 1018d4fa2e63SAlexander Kornienko else if (Current.isStringLiteral() && State.StartOfStringLiteral == 0) 1019d4fa2e63SAlexander Kornienko State.StartOfStringLiteral = State.Column; 10200928553eSDaniel Jasper else if (!Current.isOneOf(tok::comment, tok::identifier, tok::hash) && 10210928553eSDaniel Jasper !Current.isStringLiteral()) 102260553be5SDaniel Jasper State.StartOfStringLiteral = 0; 102360553be5SDaniel Jasper 102460553be5SDaniel Jasper State.Column += Current.ColumnWidth; 102560553be5SDaniel Jasper State.NextToken = State.NextToken->Next; 1026*45ab559eSManuel Klimek 1027*45ab559eSManuel Klimek unsigned Penalty = 1028*45ab559eSManuel Klimek handleEndOfLine(Current, State, DryRun, AllowBreak); 102960553be5SDaniel Jasper 103060553be5SDaniel Jasper if (Current.Role) 103160553be5SDaniel Jasper Current.Role->formatFromToken(State, this, DryRun); 103260553be5SDaniel Jasper // If the previous has a special role, let it consume tokens as appropriate. 103360553be5SDaniel Jasper // It is necessary to start at the previous token for the only implemented 103460553be5SDaniel Jasper // role (comma separated list). That way, the decision whether or not to break 103560553be5SDaniel Jasper // after the "{" is already done and both options are tried and evaluated. 103660553be5SDaniel Jasper // FIXME: This is ugly, find a better way. 103760553be5SDaniel Jasper if (Previous && Previous->Role) 103860553be5SDaniel Jasper Penalty += Previous->Role->formatAfterToken(State, this, DryRun); 103960553be5SDaniel Jasper 104060553be5SDaniel Jasper return Penalty; 104160553be5SDaniel Jasper } 104260553be5SDaniel Jasper 104360553be5SDaniel Jasper void ContinuationIndenter::moveStatePastFakeLParens(LineState &State, 104460553be5SDaniel Jasper bool Newline) { 104560553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 104660553be5SDaniel Jasper const FormatToken *Previous = Current.getPreviousNonComment(); 104760553be5SDaniel Jasper 1048de0328aeSDaniel Jasper // Don't add extra indentation for the first fake parenthesis after 10490db806b7SDinesh Dwivedi // 'return', assignments or opening <({[. The indentation for these cases 1050de0328aeSDaniel Jasper // is special cased. 1051de0328aeSDaniel Jasper bool SkipFirstExtraIndent = 105298f8ae34SDaniel Jasper (Previous && (Previous->opensScope() || 105398f8ae34SDaniel Jasper Previous->isOneOf(tok::semi, tok::kw_return) || 10543219e43cSDaniel Jasper (Previous->getPrecedence() == prec::Assignment && 10553219e43cSDaniel Jasper Style.AlignOperands) || 1056a98b7b01SDaniel Jasper Previous->is(TT_ObjCMethodExpr))); 1057de0328aeSDaniel Jasper for (SmallVectorImpl<prec::Level>::const_reverse_iterator 1058de0328aeSDaniel Jasper I = Current.FakeLParens.rbegin(), 1059de0328aeSDaniel Jasper E = Current.FakeLParens.rend(); 1060de0328aeSDaniel Jasper I != E; ++I) { 1061de0328aeSDaniel Jasper ParenState NewParenState = State.Stack.back(); 1062de0328aeSDaniel Jasper NewParenState.ContainsLineBreak = false; 106304bbda99SDaniel Jasper NewParenState.LastOperatorWrapped = true; 1064240527caSDaniel Jasper NewParenState.NoLineBreak = 1065240527caSDaniel Jasper NewParenState.NoLineBreak || State.Stack.back().NoLineBreakInOperand; 1066eabede6dSDaniel Jasper 1067988e7e4fSDaniel Jasper // Don't propagate AvoidBinPacking into subexpressions of arg/param lists. 1068988e7e4fSDaniel Jasper if (*I > prec::Comma) 1069988e7e4fSDaniel Jasper NewParenState.AvoidBinPacking = false; 1070988e7e4fSDaniel Jasper 10713aa9a6a1SDaniel Jasper // Indent from 'LastSpace' unless these are fake parentheses encapsulating 10723aa9a6a1SDaniel Jasper // a builder type call after 'return' or, if the alignment after opening 10733aa9a6a1SDaniel Jasper // brackets is disabled. 10744281c5aeSDaniel Jasper if (!Current.isTrailingComment() && 10753219e43cSDaniel Jasper (Style.AlignOperands || *I < prec::Assignment) && 10766cab6784SDaniel Jasper (!Previous || Previous->isNot(tok::kw_return) || 10776cab6784SDaniel Jasper (Style.Language != FormatStyle::LK_Java && *I > 0)) && 10786501f7e8SDaniel Jasper (Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign || 10796501f7e8SDaniel Jasper *I != prec::Comma || Current.NestingLevel == 0)) 1080de0328aeSDaniel Jasper NewParenState.Indent = 1081de0328aeSDaniel Jasper std::max(std::max(State.Column, NewParenState.Indent), 1082de0328aeSDaniel Jasper State.Stack.back().LastSpace); 1083eabede6dSDaniel Jasper 10849fe0e8daSDaniel Jasper // Do not indent relative to the fake parentheses inserted for "." or "->". 10859fe0e8daSDaniel Jasper // This is a special case to make the following to statements consistent: 10869fe0e8daSDaniel Jasper // OuterFunction(InnerFunctionCall( // break 10879fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 10889fe0e8daSDaniel Jasper // OuterFunction(SomeObject.InnerFunctionCall( // break 10899fe0e8daSDaniel Jasper // ParameterToInnerFunction)); 10909fe0e8daSDaniel Jasper if (*I > prec::Unknown) 10919fe0e8daSDaniel Jasper NewParenState.LastSpace = std::max(NewParenState.LastSpace, State.Column); 10922a9f7201SDaniel Jasper if (*I != prec::Conditional && !Current.is(TT_UnaryOperator) && 10932a9f7201SDaniel Jasper Style.AlignAfterOpenBracket != FormatStyle::BAS_DontAlign) 109496964359SDaniel Jasper NewParenState.StartOfFunctionCall = State.Column; 1095de0328aeSDaniel Jasper 1096de0328aeSDaniel Jasper // Always indent conditional expressions. Never indent expression where 1097de0328aeSDaniel Jasper // the 'operator' is ',', ';' or an assignment (i.e. *I <= 1098de0328aeSDaniel Jasper // prec::Assignment) as those have different indentation rules. Indent 1099de0328aeSDaniel Jasper // other expression, unless the indentation needs to be skipped. 1100de0328aeSDaniel Jasper if (*I == prec::Conditional || 1101de0328aeSDaniel Jasper (!SkipFirstExtraIndent && *I > prec::Assignment && 11028c6e9ef6SDaniel Jasper !Current.isTrailingComment())) 11036633ab8aSDaniel Jasper NewParenState.Indent += Style.ContinuationIndentWidth; 11047bec87c9SDaniel Jasper if ((Previous && !Previous->opensScope()) || *I != prec::Comma) 1105de0328aeSDaniel Jasper NewParenState.BreakBeforeParameter = false; 1106de0328aeSDaniel Jasper State.Stack.push_back(NewParenState); 1107de0328aeSDaniel Jasper SkipFirstExtraIndent = false; 1108de0328aeSDaniel Jasper } 110960553be5SDaniel Jasper } 1110de0328aeSDaniel Jasper 111111a0ac66SDaniel Jasper void ContinuationIndenter::moveStatePastFakeRParens(LineState &State) { 111211a0ac66SDaniel Jasper for (unsigned i = 0, e = State.NextToken->FakeRParens; i != e; ++i) { 111360553be5SDaniel Jasper unsigned VariablePos = State.Stack.back().VariablePos; 1114819788daSManuel Klimek if (State.Stack.size() == 1) { 1115819788daSManuel Klimek // Do not pop the last element. 1116819788daSManuel Klimek break; 1117819788daSManuel Klimek } 11189fe0e8daSDaniel Jasper State.Stack.pop_back(); 111960553be5SDaniel Jasper State.Stack.back().VariablePos = VariablePos; 1120819788daSManuel Klimek } 112160553be5SDaniel Jasper } 1122335ff266SDaniel Jasper 112360553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeOpener(LineState &State, 112460553be5SDaniel Jasper bool Newline) { 112560553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 112660553be5SDaniel Jasper if (!Current.opensScope()) 112760553be5SDaniel Jasper return; 112860553be5SDaniel Jasper 112960553be5SDaniel Jasper if (Current.MatchingParen && Current.BlockKind == BK_Block) { 113060553be5SDaniel Jasper moveStateToNewBlock(State); 113160553be5SDaniel Jasper return; 113260553be5SDaniel Jasper } 113360553be5SDaniel Jasper 113460553be5SDaniel Jasper unsigned NewIndent; 1135de7ca75cSDaniel Jasper unsigned LastSpace = State.Stack.back().LastSpace; 113660553be5SDaniel Jasper bool AvoidBinPacking; 113760553be5SDaniel Jasper bool BreakBeforeParameter = false; 1138ea40cee2SDaniel Jasper unsigned NestedBlockIndent = std::max(State.Stack.back().StartOfFunctionCall, 1139ea40cee2SDaniel Jasper State.Stack.back().NestedBlockIndent); 1140ff747be4SKrasimir Georgiev if (Current.isOneOf(tok::l_brace, TT_ArrayInitializerLSquare) || 114126b144ccSKrasimir Georgiev opensProtoMessageField(Current, Style)) { 1142bd73bcf8SDaniel Jasper if (Current.opensBlockOrBlockTypeList(Style)) { 114338423276SMartin Probst NewIndent = Style.IndentWidth + 114438423276SMartin Probst std::min(State.Column, State.Stack.back().NestedBlockIndent); 1145b8f61682SDaniel Jasper } else { 114611a0ac66SDaniel Jasper NewIndent = State.Stack.back().LastSpace + Style.ContinuationIndentWidth; 1147e2e0387fSAlexander Kornienko } 1148de0328aeSDaniel Jasper const FormatToken *NextNoComment = Current.getNextNonComment(); 114950780ce1SDaniel Jasper bool EndsInComma = Current.MatchingParen && 115050780ce1SDaniel Jasper Current.MatchingParen->Previous && 115150780ce1SDaniel Jasper Current.MatchingParen->Previous->is(tok::comma); 115289628f64SManuel Klimek AvoidBinPacking = EndsInComma || Current.is(TT_DictLiteral) || 115326b144ccSKrasimir Georgiev Style.Language == FormatStyle::LK_Proto || 115426b144ccSKrasimir Georgiev Style.Language == FormatStyle::LK_TextProto || 115526b144ccSKrasimir Georgiev !Style.BinPackArguments || 11565f07f443SFrancois Ferrand (NextNoComment && 11575f07f443SFrancois Ferrand NextNoComment->isOneOf(TT_DesignatedInitializerPeriod, 11585f07f443SFrancois Ferrand TT_DesignatedInitializerLSquare)); 1159d2130f51SFrancois Ferrand BreakBeforeParameter = EndsInComma; 1160ea40cee2SDaniel Jasper if (Current.ParameterCount > 1) 1161ea40cee2SDaniel Jasper NestedBlockIndent = std::max(NestedBlockIndent, State.Column + 1); 1162de0328aeSDaniel Jasper } else { 11636633ab8aSDaniel Jasper NewIndent = Style.ContinuationIndentWidth + 11646633ab8aSDaniel Jasper std::max(State.Stack.back().LastSpace, 11659fe0e8daSDaniel Jasper State.Stack.back().StartOfFunctionCall); 1166de7ca75cSDaniel Jasper 1167de7ca75cSDaniel Jasper // Ensure that different different brackets force relative alignment, e.g.: 1168de7ca75cSDaniel Jasper // void SomeFunction(vector< // break 1169de7ca75cSDaniel Jasper // int> v); 1170de7ca75cSDaniel Jasper // FIXME: We likely want to do this for more combinations of brackets. 1171de7ca75cSDaniel Jasper // Verify that it is wanted for ObjC, too. 11723f11941dSDaniel Jasper if (Current.is(tok::less) && Current.ParentBracket == tok::l_paren) { 1173de7ca75cSDaniel Jasper NewIndent = std::max(NewIndent, State.Stack.back().Indent); 1174de7ca75cSDaniel Jasper LastSpace = std::max(LastSpace, State.Stack.back().Indent); 1175de7ca75cSDaniel Jasper } 1176de7ca75cSDaniel Jasper 11772c1cdae2SMartin Probst bool EndsInComma = 11782c1cdae2SMartin Probst Current.MatchingParen && 11792c1cdae2SMartin Probst Current.MatchingParen->getPreviousNonComment() && 11802c1cdae2SMartin Probst Current.MatchingParen->getPreviousNonComment()->is(tok::comma); 11812c1cdae2SMartin Probst 118218210d7dSDaniel Jasper AvoidBinPacking = 11832c1cdae2SMartin Probst (Style.Language == FormatStyle::LK_JavaScript && EndsInComma) || 118418210d7dSDaniel Jasper (State.Line->MustBeDeclaration && !Style.BinPackParameters) || 118518210d7dSDaniel Jasper (!State.Line->MustBeDeclaration && !Style.BinPackArguments) || 1186de0328aeSDaniel Jasper (Style.ExperimentalAutoDetectBinPacking && 1187de0328aeSDaniel Jasper (Current.PackingKind == PPK_OnePerLine || 1188de0328aeSDaniel Jasper (!BinPackInconclusiveFunctions && 1189de0328aeSDaniel Jasper Current.PackingKind == PPK_Inconclusive))); 11902c1cdae2SMartin Probst 1191289afc07SDaniel Jasper if (Current.is(TT_ObjCMethodExpr) && Current.MatchingParen) { 1192289afc07SDaniel Jasper if (Style.ColumnLimit) { 11931db6c386SDaniel Jasper // If this '[' opens an ObjC call, determine whether all parameters fit 11941db6c386SDaniel Jasper // into one line and put one per line if they don't. 1195289afc07SDaniel Jasper if (getLengthToMatchingParen(Current) + State.Column > 11961db6c386SDaniel Jasper getColumnLimit(State)) 11971db6c386SDaniel Jasper BreakBeforeParameter = true; 1198289afc07SDaniel Jasper } else { 1199289afc07SDaniel Jasper // For ColumnLimit = 0, we have to figure out whether there is or has to 1200289afc07SDaniel Jasper // be a line break within this call. 1201289afc07SDaniel Jasper for (const FormatToken *Tok = &Current; 1202289afc07SDaniel Jasper Tok && Tok != Current.MatchingParen; Tok = Tok->Next) { 1203289afc07SDaniel Jasper if (Tok->MustBreakBefore || 1204289afc07SDaniel Jasper (Tok->CanBreakBefore && Tok->NewlinesBefore > 0)) { 1205289afc07SDaniel Jasper BreakBeforeParameter = true; 1206289afc07SDaniel Jasper break; 1207289afc07SDaniel Jasper } 1208289afc07SDaniel Jasper } 1209289afc07SDaniel Jasper } 1210289afc07SDaniel Jasper } 12112c1cdae2SMartin Probst 12122c1cdae2SMartin Probst if (Style.Language == FormatStyle::LK_JavaScript && EndsInComma) 12132c1cdae2SMartin Probst BreakBeforeParameter = true; 1214de0328aeSDaniel Jasper } 1215bd73bcf8SDaniel Jasper // Generally inherit NoLineBreak from the current scope to nested scope. 1216bd73bcf8SDaniel Jasper // However, don't do this for non-empty nested blocks, dict literals and 1217bd73bcf8SDaniel Jasper // array literals as these follow different indentation rules. 1218bd73bcf8SDaniel Jasper bool NoLineBreak = 1219bd73bcf8SDaniel Jasper Current.Children.empty() && 1220bd73bcf8SDaniel Jasper !Current.isOneOf(TT_DictLiteral, TT_ArrayInitializerLSquare) && 1221bd73bcf8SDaniel Jasper (State.Stack.back().NoLineBreak || 1222240527caSDaniel Jasper State.Stack.back().NoLineBreakInOperand || 1223bd73bcf8SDaniel Jasper (Current.is(TT_TemplateOpener) && 1224240527caSDaniel Jasper State.Stack.back().ContainsUnwrappedBuilder)); 12257d42f3f7SDaniel Jasper State.Stack.push_back( 12267d42f3f7SDaniel Jasper ParenState(NewIndent, LastSpace, AvoidBinPacking, NoLineBreak)); 122711a0ac66SDaniel Jasper State.Stack.back().NestedBlockIndent = NestedBlockIndent; 12281db6c386SDaniel Jasper State.Stack.back().BreakBeforeParameter = BreakBeforeParameter; 1229114a2bc9SDaniel Jasper State.Stack.back().HasMultipleNestedBlocks = Current.BlockParameterCount > 1; 1230de0328aeSDaniel Jasper } 1231de0328aeSDaniel Jasper 123260553be5SDaniel Jasper void ContinuationIndenter::moveStatePastScopeCloser(LineState &State) { 123360553be5SDaniel Jasper const FormatToken &Current = *State.NextToken; 123460553be5SDaniel Jasper if (!Current.closesScope()) 123560553be5SDaniel Jasper return; 123660553be5SDaniel Jasper 1237de0328aeSDaniel Jasper // If we encounter a closing ), ], } or >, we can remove a level from our 1238de0328aeSDaniel Jasper // stacks. 123996df37a6SDaniel Jasper if (State.Stack.size() > 1 && 1240c06f6da3SDaniel Jasper (Current.isOneOf(tok::r_paren, tok::r_square, TT_TemplateString) || 12419fe0e8daSDaniel Jasper (Current.is(tok::r_brace) && State.NextToken != State.Line->First) || 1242a98b7b01SDaniel Jasper State.NextToken->is(TT_TemplateCloser))) 1243de0328aeSDaniel Jasper State.Stack.pop_back(); 1244335ff266SDaniel Jasper 1245de0328aeSDaniel Jasper if (Current.is(tok::r_square)) { 1246de0328aeSDaniel Jasper // If this ends the array subscript expr, reset the corresponding value. 1247de0328aeSDaniel Jasper const FormatToken *NextNonComment = Current.getNextNonComment(); 1248de0328aeSDaniel Jasper if (NextNonComment && NextNonComment->isNot(tok::l_square)) 1249de0328aeSDaniel Jasper State.Stack.back().StartOfArraySubscripts = 0; 1250de0328aeSDaniel Jasper } 125160553be5SDaniel Jasper } 1252de0328aeSDaniel Jasper 125360553be5SDaniel Jasper void ContinuationIndenter::moveStateToNewBlock(LineState &State) { 125411a0ac66SDaniel Jasper unsigned NestedBlockIndent = State.Stack.back().NestedBlockIndent; 125550d634b3SDaniel Jasper // ObjC block sometimes follow special indentation rules. 1256a98b7b01SDaniel Jasper unsigned NewIndent = 125711a0ac66SDaniel Jasper NestedBlockIndent + (State.NextToken->is(TT_ObjCBlockLBrace) 125850d634b3SDaniel Jasper ? Style.ObjCBlockIndentWidth 125960553be5SDaniel Jasper : Style.IndentWidth); 12607d42f3f7SDaniel Jasper State.Stack.push_back(ParenState(NewIndent, State.Stack.back().LastSpace, 12617d42f3f7SDaniel Jasper /*AvoidBinPacking=*/true, 12626501f7e8SDaniel Jasper /*NoLineBreak=*/false)); 126311a0ac66SDaniel Jasper State.Stack.back().NestedBlockIndent = NestedBlockIndent; 126460553be5SDaniel Jasper State.Stack.back().BreakBeforeParameter = true; 1265de0328aeSDaniel Jasper } 1266de0328aeSDaniel Jasper 12679ad83fe7SKrasimir Georgiev static unsigned getLastLineEndColumn(StringRef Text, unsigned StartColumn, 12689ad83fe7SKrasimir Georgiev unsigned TabWidth, 12699ad83fe7SKrasimir Georgiev encoding::Encoding Encoding) { 12709ad83fe7SKrasimir Georgiev size_t LastNewlinePos = Text.find_last_of("\n"); 12719ad83fe7SKrasimir Georgiev if (LastNewlinePos == StringRef::npos) { 12729ad83fe7SKrasimir Georgiev return StartColumn + 12739ad83fe7SKrasimir Georgiev encoding::columnWidthWithTabs(Text, StartColumn, TabWidth, Encoding); 12749ad83fe7SKrasimir Georgiev } else { 12759ad83fe7SKrasimir Georgiev return encoding::columnWidthWithTabs(Text.substr(LastNewlinePos), 12769ad83fe7SKrasimir Georgiev /*StartColumn=*/0, TabWidth, Encoding); 12779ad83fe7SKrasimir Georgiev } 12789ad83fe7SKrasimir Georgiev } 12799ad83fe7SKrasimir Georgiev 12809ad83fe7SKrasimir Georgiev unsigned ContinuationIndenter::reformatRawStringLiteral( 1281*45ab559eSManuel Klimek const FormatToken &Current, LineState &State, 1282*45ab559eSManuel Klimek const FormatStyle &RawStringStyle, bool DryRun) { 1283*45ab559eSManuel Klimek unsigned StartColumn = State.Column - Current.ColumnWidth; 1284*45ab559eSManuel Klimek auto Delimiter = *getRawStringDelimiter(Current.TokenText); 12859ad83fe7SKrasimir Georgiev // The text of a raw string is between the leading 'R"delimiter(' and the 12869ad83fe7SKrasimir Georgiev // trailing 'delimiter)"'. 12879ad83fe7SKrasimir Georgiev unsigned PrefixSize = 3 + Delimiter.size(); 12889ad83fe7SKrasimir Georgiev unsigned SuffixSize = 2 + Delimiter.size(); 12899ad83fe7SKrasimir Georgiev 12909ad83fe7SKrasimir Georgiev // The first start column is the column the raw text starts. 12919ad83fe7SKrasimir Georgiev unsigned FirstStartColumn = StartColumn + PrefixSize; 12929ad83fe7SKrasimir Georgiev 12939ad83fe7SKrasimir Georgiev // The next start column is the intended indentation a line break inside 12949ad83fe7SKrasimir Georgiev // the raw string at level 0. It is determined by the following rules: 12959ad83fe7SKrasimir Georgiev // - if the content starts on newline, it is one level more than the current 12969ad83fe7SKrasimir Georgiev // indent, and 12979ad83fe7SKrasimir Georgiev // - if the content does not start on a newline, it is the first start 12989ad83fe7SKrasimir Georgiev // column. 12999ad83fe7SKrasimir Georgiev // These rules have the advantage that the formatted content both does not 13009ad83fe7SKrasimir Georgiev // violate the rectangle rule and visually flows within the surrounding 13019ad83fe7SKrasimir Georgiev // source. 13029ad83fe7SKrasimir Georgiev bool ContentStartsOnNewline = Current.TokenText[PrefixSize] == '\n'; 13039ad83fe7SKrasimir Georgiev unsigned NextStartColumn = ContentStartsOnNewline 13049ad83fe7SKrasimir Georgiev ? State.Stack.back().Indent + Style.IndentWidth 13059ad83fe7SKrasimir Georgiev : FirstStartColumn; 13069ad83fe7SKrasimir Georgiev 13079ad83fe7SKrasimir Georgiev // The last start column is the column the raw string suffix starts if it is 13089ad83fe7SKrasimir Georgiev // put on a newline. 13099ad83fe7SKrasimir Georgiev // The last start column is the intended indentation of the raw string postfix 13109ad83fe7SKrasimir Georgiev // if it is put on a newline. It is determined by the following rules: 13119ad83fe7SKrasimir Georgiev // - if the raw string prefix starts on a newline, it is the column where 13129ad83fe7SKrasimir Georgiev // that raw string prefix starts, and 13139ad83fe7SKrasimir Georgiev // - if the raw string prefix does not start on a newline, it is the current 13149ad83fe7SKrasimir Georgiev // indent. 13159ad83fe7SKrasimir Georgiev unsigned LastStartColumn = Current.NewlinesBefore 13169ad83fe7SKrasimir Georgiev ? FirstStartColumn - PrefixSize 13179ad83fe7SKrasimir Georgiev : State.Stack.back().Indent; 13189ad83fe7SKrasimir Georgiev 13199ad83fe7SKrasimir Georgiev std::string RawText = 13209ad83fe7SKrasimir Georgiev Current.TokenText.substr(PrefixSize).drop_back(SuffixSize); 13219ad83fe7SKrasimir Georgiev 13229ad83fe7SKrasimir Georgiev std::pair<tooling::Replacements, unsigned> Fixes = internal::reformat( 13239ad83fe7SKrasimir Georgiev RawStringStyle, RawText, {tooling::Range(0, RawText.size())}, 13249ad83fe7SKrasimir Georgiev FirstStartColumn, NextStartColumn, LastStartColumn, "<stdin>", 13250fcb580bSKrasimir Georgiev /*Status=*/nullptr); 13269ad83fe7SKrasimir Georgiev 13279ad83fe7SKrasimir Georgiev auto NewCode = applyAllReplacements(RawText, Fixes.first); 13289ad83fe7SKrasimir Georgiev tooling::Replacements NoFixes; 13299ad83fe7SKrasimir Georgiev if (!NewCode) { 13309ad83fe7SKrasimir Georgiev State.Column += Current.ColumnWidth; 13319ad83fe7SKrasimir Georgiev return 0; 13329ad83fe7SKrasimir Georgiev } 13339ad83fe7SKrasimir Georgiev if (!DryRun) { 13349ad83fe7SKrasimir Georgiev SourceLocation OriginLoc = 13359ad83fe7SKrasimir Georgiev Current.Tok.getLocation().getLocWithOffset(PrefixSize); 13369ad83fe7SKrasimir Georgiev for (const tooling::Replacement &Fix : Fixes.first) { 13379ad83fe7SKrasimir Georgiev auto Err = Whitespaces.addReplacement(tooling::Replacement( 13389ad83fe7SKrasimir Georgiev SourceMgr, OriginLoc.getLocWithOffset(Fix.getOffset()), 13399ad83fe7SKrasimir Georgiev Fix.getLength(), Fix.getReplacementText())); 13409ad83fe7SKrasimir Georgiev if (Err) { 13419ad83fe7SKrasimir Georgiev llvm::errs() << "Failed to reformat raw string: " 13429ad83fe7SKrasimir Georgiev << llvm::toString(std::move(Err)) << "\n"; 13439ad83fe7SKrasimir Georgiev } 13449ad83fe7SKrasimir Georgiev } 13459ad83fe7SKrasimir Georgiev } 13469ad83fe7SKrasimir Georgiev unsigned RawLastLineEndColumn = getLastLineEndColumn( 13479ad83fe7SKrasimir Georgiev *NewCode, FirstStartColumn, Style.TabWidth, Encoding); 13489ad83fe7SKrasimir Georgiev State.Column = RawLastLineEndColumn + SuffixSize; 13499ad83fe7SKrasimir Georgiev return Fixes.second; 13509ad83fe7SKrasimir Georgiev } 13519ad83fe7SKrasimir Georgiev 1352917f9e04SAlexander Kornienko unsigned ContinuationIndenter::addMultilineToken(const FormatToken &Current, 1353d7b837e7SAlexander Kornienko LineState &State) { 1354d7b837e7SAlexander Kornienko // Break before further function parameters on all levels. 1355d7b837e7SAlexander Kornienko for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 1356d7b837e7SAlexander Kornienko State.Stack[i].BreakBeforeParameter = true; 1357d7b837e7SAlexander Kornienko 135839856b71SAlexander Kornienko unsigned ColumnsUsed = State.Column; 1359632abb9bSAlexander Kornienko // We can only affect layout of the first and the last line, so the penalty 1360632abb9bSAlexander Kornienko // for all other lines is constant, and we ignore it. 1361ebb43caaSAlexander Kornienko State.Column = Current.LastLineColumnWidth; 1362632abb9bSAlexander Kornienko 13639fe0e8daSDaniel Jasper if (ColumnsUsed > getColumnLimit(State)) 13649fe0e8daSDaniel Jasper return Style.PenaltyExcessCharacter * (ColumnsUsed - getColumnLimit(State)); 1365d7b837e7SAlexander Kornienko return 0; 1366d7b837e7SAlexander Kornienko } 1367d7b837e7SAlexander Kornienko 1368*45ab559eSManuel Klimek unsigned ContinuationIndenter::handleEndOfLine(const FormatToken &Current, 1369*45ab559eSManuel Klimek LineState &State, bool DryRun, 1370*45ab559eSManuel Klimek bool AllowBreak) { 1371*45ab559eSManuel Klimek unsigned Penalty = 0; 13729ad83fe7SKrasimir Georgiev // Compute the raw string style to use in case this is a raw string literal 13739ad83fe7SKrasimir Georgiev // that can be reformatted. 1374*45ab559eSManuel Klimek auto RawStringStyle = getRawStringStyle(Current, State); 1375*45ab559eSManuel Klimek if (RawStringStyle) { 1376*45ab559eSManuel Klimek Penalty = reformatRawStringLiteral(Current, State, *RawStringStyle, DryRun); 1377*45ab559eSManuel Klimek } else if (Current.IsMultiline && Current.isNot(TT_BlockComment)) { 13789ad83fe7SKrasimir Georgiev // Don't break multi-line tokens other than block comments and raw string 13799ad83fe7SKrasimir Georgiev // literals. Instead, just update the state. 1380*45ab559eSManuel Klimek Penalty = addMultilineToken(Current, State); 1381*45ab559eSManuel Klimek } else if (State.Line->Type != LT_ImportStatement) { 1382*45ab559eSManuel Klimek // We generally don't break import statements. 1383*45ab559eSManuel Klimek Penalty = breakProtrudingToken(Current, State, AllowBreak, DryRun); 1384*45ab559eSManuel Klimek } 1385*45ab559eSManuel Klimek if (State.Column > getColumnLimit(State)) { 1386*45ab559eSManuel Klimek unsigned ExcessCharacters = State.Column - getColumnLimit(State); 1387*45ab559eSManuel Klimek Penalty += Style.PenaltyExcessCharacter * ExcessCharacters; 1388*45ab559eSManuel Klimek } 1389*45ab559eSManuel Klimek return Penalty; 1390*45ab559eSManuel Klimek } 1391917f9e04SAlexander Kornienko 1392*45ab559eSManuel Klimek llvm::Optional<FormatStyle> 1393*45ab559eSManuel Klimek ContinuationIndenter::getRawStringStyle(const FormatToken &Current, 1394*45ab559eSManuel Klimek const LineState &State) { 1395*45ab559eSManuel Klimek if (!Current.isStringLiteral()) 1396*45ab559eSManuel Klimek return None; 1397*45ab559eSManuel Klimek auto Delimiter = getRawStringDelimiter(Current.TokenText); 1398*45ab559eSManuel Klimek if (!Delimiter) 1399*45ab559eSManuel Klimek return None; 1400*45ab559eSManuel Klimek auto RawStringStyle = RawStringFormats.get(*Delimiter); 1401*45ab559eSManuel Klimek if (!RawStringStyle) 1402*45ab559eSManuel Klimek return None; 1403*45ab559eSManuel Klimek RawStringStyle->ColumnLimit = getColumnLimit(State); 1404*45ab559eSManuel Klimek return RawStringStyle; 1405*45ab559eSManuel Klimek } 14069885784dSDaniel Jasper 1407*45ab559eSManuel Klimek std::unique_ptr<BreakableToken> ContinuationIndenter::createBreakableToken( 1408*45ab559eSManuel Klimek const FormatToken &Current, LineState &State, bool AllowBreak) { 140939856b71SAlexander Kornienko unsigned StartColumn = State.Column - Current.ColumnWidth; 141004b6a081SDaniel Jasper if (Current.isStringLiteral()) { 1411428f0b14SDaniel Jasper // FIXME: String literal breaking is currently disabled for Java and JS, as 1412428f0b14SDaniel Jasper // it requires strings to be merged using "+" which we don't support. 1413428f0b14SDaniel Jasper if (Style.Language == FormatStyle::LK_Java || 1414e1a7b763SDaniel Jasper Style.Language == FormatStyle::LK_JavaScript || 1415*45ab559eSManuel Klimek !Style.BreakStringLiterals || 1416*45ab559eSManuel Klimek !AllowBreak) 1417*45ab559eSManuel Klimek return nullptr; 1418428f0b14SDaniel Jasper 1419384b40b9SAlexander Kornienko // Don't break string literals inside preprocessor directives (except for 1420384b40b9SAlexander Kornienko // #define directives, as their contents are stored in separate lines and 1421384b40b9SAlexander Kornienko // are not affected by this check). 1422384b40b9SAlexander Kornienko // This way we avoid breaking code with line directives and unknown 1423384b40b9SAlexander Kornienko // preprocessor directives that contain long string literals. 1424384b40b9SAlexander Kornienko if (State.Line->Type == LT_PreprocessorDirective) 1425*45ab559eSManuel Klimek return nullptr; 1426de0328aeSDaniel Jasper // Exempts unterminated string literals from line breaking. The user will 1427de0328aeSDaniel Jasper // likely want to terminate the string before any line breaking is done. 1428de0328aeSDaniel Jasper if (Current.IsUnterminatedLiteral) 1429*45ab559eSManuel Klimek return nullptr; 1430de0328aeSDaniel Jasper 143181e3294eSAlexander Kornienko StringRef Text = Current.TokenText; 143281e3294eSAlexander Kornienko StringRef Prefix; 143381e3294eSAlexander Kornienko StringRef Postfix; 143481e3294eSAlexander Kornienko // FIXME: Handle whitespace between '_T', '(', '"..."', and ')'. 143581e3294eSAlexander Kornienko // FIXME: Store Prefix and Suffix (or PrefixLength and SuffixLength to 143681e3294eSAlexander Kornienko // reduce the overhead) for each FormatToken, which is a string, so that we 143781e3294eSAlexander Kornienko // don't run multiple checks here on the hot path. 143881e3294eSAlexander Kornienko if ((Text.endswith(Postfix = "\"") && 1439d4fa2e63SAlexander Kornienko (Text.startswith(Prefix = "@\"") || Text.startswith(Prefix = "\"") || 1440174b0125SDaniel Jasper Text.startswith(Prefix = "u\"") || Text.startswith(Prefix = "U\"") || 1441174b0125SDaniel Jasper Text.startswith(Prefix = "u8\"") || 144281e3294eSAlexander Kornienko Text.startswith(Prefix = "L\""))) || 1443732b6bd4SAlexander Kornienko (Text.startswith(Prefix = "_T(\"") && Text.endswith(Postfix = "\")"))) { 1444*45ab559eSManuel Klimek return llvm::make_unique<BreakableStringLiteral>( 1445*45ab559eSManuel Klimek Current, StartColumn, Prefix, Postfix, State.Line->InPPDirective, 1446*45ab559eSManuel Klimek Encoding, Style); 144781e3294eSAlexander Kornienko } 1448acadc8e0SDaniel Jasper } else if (Current.is(TT_BlockComment)) { 144935599fdfSKrasimir Georgiev if (!Style.ReflowComments || 145091834227SKrasimir Georgiev // If a comment token switches formatting, like 145191834227SKrasimir Georgiev // /* clang-format on */, we don't want to break it further, 145291834227SKrasimir Georgiev // but we may still want to adjust its indentation. 1453*45ab559eSManuel Klimek switchesFormatting(Current)) { 1454*45ab559eSManuel Klimek return nullptr; 1455*45ab559eSManuel Klimek } 1456*45ab559eSManuel Klimek return llvm::make_unique<BreakableBlockComment>( 14577d42f3f7SDaniel Jasper Current, StartColumn, Current.OriginalColumn, !Current.Previous, 1458*45ab559eSManuel Klimek State.Line->InPPDirective, Encoding, Style); 1459a98b7b01SDaniel Jasper } else if (Current.is(TT_LineComment) && 14602145bc02SCraig Topper (Current.Previous == nullptr || 1461a98b7b01SDaniel Jasper Current.Previous->isNot(TT_ImplicitStringLiteral))) { 1462a0a5039dSDaniel Jasper if (!Style.ReflowComments || 146391834227SKrasimir Georgiev CommentPragmasRegex.match(Current.TokenText.substr(2)) || 146491834227SKrasimir Georgiev switchesFormatting(Current)) 1465*45ab559eSManuel Klimek return nullptr; 1466*45ab559eSManuel Klimek return llvm::make_unique<BreakableLineCommentSection>( 14677d42f3f7SDaniel Jasper Current, StartColumn, Current.OriginalColumn, !Current.Previous, 1468*45ab559eSManuel Klimek /*InPPDirective=*/false, Encoding, Style); 1469*45ab559eSManuel Klimek } 1470*45ab559eSManuel Klimek return nullptr; 1471*45ab559eSManuel Klimek } 1472*45ab559eSManuel Klimek 1473*45ab559eSManuel Klimek unsigned ContinuationIndenter::breakProtrudingToken(const FormatToken &Current, 1474*45ab559eSManuel Klimek LineState &State, 1475*45ab559eSManuel Klimek bool AllowBreak, 1476*45ab559eSManuel Klimek bool DryRun) { 1477*45ab559eSManuel Klimek std::unique_ptr<BreakableToken> Token = 1478*45ab559eSManuel Klimek createBreakableToken(Current, State, AllowBreak); 1479*45ab559eSManuel Klimek if (!Token) 1480*45ab559eSManuel Klimek return 0; 1481*45ab559eSManuel Klimek unsigned ColumnLimit = getColumnLimit(State); 1482*45ab559eSManuel Klimek unsigned StartColumn = State.Column - Current.ColumnWidth; 1483*45ab559eSManuel Klimek if (Current.is(TT_LineComment)) { 14843abbb8a4SAlexander Kornienko // We don't insert backslashes when breaking line comments. 14853abbb8a4SAlexander Kornienko ColumnLimit = Style.ColumnLimit; 1486de0328aeSDaniel Jasper } 14873abbb8a4SAlexander Kornienko if (Current.UnbreakableTailLength >= ColumnLimit) 1488de0328aeSDaniel Jasper return 0; 1489de0328aeSDaniel Jasper 14903abbb8a4SAlexander Kornienko unsigned RemainingSpace = ColumnLimit - Current.UnbreakableTailLength; 1491de0328aeSDaniel Jasper bool BreakInserted = false; 149291834227SKrasimir Georgiev // We use a conservative reflowing strategy. Reflow starts after a line is 149391834227SKrasimir Georgiev // broken or the corresponding whitespace compressed. Reflow ends as soon as a 149491834227SKrasimir Georgiev // line that doesn't get reflown with the previous line is reached. 149591834227SKrasimir Georgiev bool ReflowInProgress = false; 1496de0328aeSDaniel Jasper unsigned Penalty = 0; 1497de0328aeSDaniel Jasper unsigned RemainingTokenColumns = 0; 149822d7e6b0SKrasimir Georgiev unsigned TailOffset = 0; 1499de0328aeSDaniel Jasper for (unsigned LineIndex = 0, EndIndex = Token->getLineCount(); 1500de0328aeSDaniel Jasper LineIndex != EndIndex; ++LineIndex) { 150191834227SKrasimir Georgiev BreakableToken::Split SplitBefore(StringRef::npos, 0); 150291834227SKrasimir Georgiev if (ReflowInProgress) { 150391834227SKrasimir Georgiev SplitBefore = Token->getSplitBefore(LineIndex, RemainingTokenColumns, 150400c5c72dSKrasimir Georgiev RemainingSpace, CommentPragmasRegex); 150591834227SKrasimir Georgiev } 150691834227SKrasimir Georgiev ReflowInProgress = SplitBefore.first != StringRef::npos; 150722d7e6b0SKrasimir Georgiev TailOffset = 150891834227SKrasimir Georgiev ReflowInProgress ? (SplitBefore.first + SplitBefore.second) : 0; 150935599fdfSKrasimir Georgiev BreakInserted = BreakInserted || Token->introducesBreakBefore(LineIndex); 1510de0328aeSDaniel Jasper if (!DryRun) 151191834227SKrasimir Georgiev Token->replaceWhitespaceBefore(LineIndex, RemainingTokenColumns, 151291834227SKrasimir Georgiev RemainingSpace, SplitBefore, Whitespaces); 151391834227SKrasimir Georgiev RemainingTokenColumns = Token->getLineLengthAfterSplitBefore( 151491834227SKrasimir Georgiev LineIndex, TailOffset, RemainingTokenColumns, ColumnLimit, SplitBefore); 1515de0328aeSDaniel Jasper while (RemainingTokenColumns > RemainingSpace) { 151617725d83SKrasimir Georgiev BreakableToken::Split Split = Token->getSplit( 151717725d83SKrasimir Georgiev LineIndex, TailOffset, ColumnLimit, CommentPragmasRegex); 1518de0328aeSDaniel Jasper if (Split.first == StringRef::npos) { 1519de0328aeSDaniel Jasper // The last line's penalty is handled in addNextStateToQueue(). 1520de0328aeSDaniel Jasper if (LineIndex < EndIndex - 1) 1521de0328aeSDaniel Jasper Penalty += Style.PenaltyExcessCharacter * 1522de0328aeSDaniel Jasper (RemainingTokenColumns - RemainingSpace); 1523de0328aeSDaniel Jasper break; 1524de0328aeSDaniel Jasper } 1525de0328aeSDaniel Jasper assert(Split.first != 0); 1526875395f9SAlexander Kornienko 152791834227SKrasimir Georgiev // Check if compressing the whitespace range will bring the line length 152891834227SKrasimir Georgiev // under the limit. If that is the case, we perform whitespace compression 152991834227SKrasimir Georgiev // instead of inserting a line break. 153091834227SKrasimir Georgiev unsigned RemainingTokenColumnsAfterCompression = 153191834227SKrasimir Georgiev Token->getLineLengthAfterCompression(RemainingTokenColumns, Split); 153291834227SKrasimir Georgiev if (RemainingTokenColumnsAfterCompression <= RemainingSpace) { 153391834227SKrasimir Georgiev RemainingTokenColumns = RemainingTokenColumnsAfterCompression; 153491834227SKrasimir Georgiev ReflowInProgress = true; 1535875395f9SAlexander Kornienko if (!DryRun) 153691834227SKrasimir Georgiev Token->compressWhitespace(LineIndex, TailOffset, Split, Whitespaces); 1537875395f9SAlexander Kornienko break; 1538875395f9SAlexander Kornienko } 1539875395f9SAlexander Kornienko 154091834227SKrasimir Georgiev unsigned NewRemainingTokenColumns = Token->getLineLengthAfterSplit( 154191834227SKrasimir Georgiev LineIndex, TailOffset + Split.first + Split.second, StringRef::npos); 154291834227SKrasimir Georgiev 154364a42b8dSAlexander Kornienko // When breaking before a tab character, it may be moved by a few columns, 154464a42b8dSAlexander Kornienko // but will still be expanded to the next tab stop, so we don't save any 154564a42b8dSAlexander Kornienko // columns. 154664a42b8dSAlexander Kornienko if (NewRemainingTokenColumns == RemainingTokenColumns) 154764a42b8dSAlexander Kornienko break; 154864a42b8dSAlexander Kornienko 1549de0328aeSDaniel Jasper assert(NewRemainingTokenColumns < RemainingTokenColumns); 1550de0328aeSDaniel Jasper if (!DryRun) 1551de0328aeSDaniel Jasper Token->insertBreak(LineIndex, TailOffset, Split, Whitespaces); 15522739af3bSDaniel Jasper Penalty += Current.SplitPenalty; 1553de0328aeSDaniel Jasper unsigned ColumnsUsed = 1554de0328aeSDaniel Jasper Token->getLineLengthAfterSplit(LineIndex, TailOffset, Split.first); 15553abbb8a4SAlexander Kornienko if (ColumnsUsed > ColumnLimit) { 15563abbb8a4SAlexander Kornienko Penalty += Style.PenaltyExcessCharacter * (ColumnsUsed - ColumnLimit); 1557de0328aeSDaniel Jasper } 1558de0328aeSDaniel Jasper TailOffset += Split.first + Split.second; 1559de0328aeSDaniel Jasper RemainingTokenColumns = NewRemainingTokenColumns; 156091834227SKrasimir Georgiev ReflowInProgress = true; 1561de0328aeSDaniel Jasper BreakInserted = true; 1562de0328aeSDaniel Jasper } 1563de0328aeSDaniel Jasper } 1564de0328aeSDaniel Jasper 15653b86534aSKrasimir Georgiev BreakableToken::Split SplitAfterLastLine = 15663b86534aSKrasimir Georgiev Token->getSplitAfterLastLine(TailOffset, ColumnLimit); 156722d7e6b0SKrasimir Georgiev if (SplitAfterLastLine.first != StringRef::npos) { 156822d7e6b0SKrasimir Georgiev if (!DryRun) 156922d7e6b0SKrasimir Georgiev Token->replaceWhitespaceAfterLastLine(TailOffset, SplitAfterLastLine, 157022d7e6b0SKrasimir Georgiev Whitespaces); 157122d7e6b0SKrasimir Georgiev RemainingTokenColumns = Token->getLineLengthAfterSplitAfterLastLine( 157222d7e6b0SKrasimir Georgiev TailOffset, SplitAfterLastLine); 157322d7e6b0SKrasimir Georgiev } 157422d7e6b0SKrasimir Georgiev 1575de0328aeSDaniel Jasper State.Column = RemainingTokenColumns; 1576de0328aeSDaniel Jasper 1577de0328aeSDaniel Jasper if (BreakInserted) { 1578de0328aeSDaniel Jasper // If we break the token inside a parameter list, we need to break before 1579de0328aeSDaniel Jasper // the next parameter on all levels, so that the next parameter is clearly 1580de0328aeSDaniel Jasper // visible. Line comments already introduce a break. 1581a98b7b01SDaniel Jasper if (Current.isNot(TT_LineComment)) { 1582de0328aeSDaniel Jasper for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) 1583de0328aeSDaniel Jasper State.Stack[i].BreakBeforeParameter = true; 1584de0328aeSDaniel Jasper } 1585de0328aeSDaniel Jasper 158635599fdfSKrasimir Georgiev if (Current.is(TT_BlockComment)) 158735599fdfSKrasimir Georgiev State.NoContinuation = true; 158835599fdfSKrasimir Georgiev 158904b6a081SDaniel Jasper Penalty += Current.isStringLiteral() ? Style.PenaltyBreakString 15902739af3bSDaniel Jasper : Style.PenaltyBreakComment; 15912739af3bSDaniel Jasper 1592de0328aeSDaniel Jasper State.Stack.back().LastSpace = StartColumn; 1593de0328aeSDaniel Jasper } 159491834227SKrasimir Georgiev 159591834227SKrasimir Georgiev Token->updateNextToken(State); 159691834227SKrasimir Georgiev 1597de0328aeSDaniel Jasper return Penalty; 1598de0328aeSDaniel Jasper } 1599de0328aeSDaniel Jasper 16009fe0e8daSDaniel Jasper unsigned ContinuationIndenter::getColumnLimit(const LineState &State) const { 1601de0328aeSDaniel Jasper // In preprocessor directives reserve two chars for trailing " \" 16029fe0e8daSDaniel Jasper return Style.ColumnLimit - (State.Line->InPPDirective ? 2 : 0); 1603de0328aeSDaniel Jasper } 1604de0328aeSDaniel Jasper 1605c39b56feSDaniel Jasper bool ContinuationIndenter::nextIsMultilineString(const LineState &State) { 1606f438cb76SDaniel Jasper const FormatToken &Current = *State.NextToken; 1607a98b7b01SDaniel Jasper if (!Current.isStringLiteral() || Current.is(TT_ImplicitStringLiteral)) 1608f438cb76SDaniel Jasper return false; 1609d7b837e7SAlexander Kornienko // We never consider raw string literals "multiline" for the purpose of 1610c39b56feSDaniel Jasper // AlwaysBreakBeforeMultilineStrings implementation as they are special-cased 1611c39b56feSDaniel Jasper // (see TokenAnnotator::mustBreakBefore(). 1612d7b837e7SAlexander Kornienko if (Current.TokenText.startswith("R\"")) 1613d7b837e7SAlexander Kornienko return false; 161439856b71SAlexander Kornienko if (Current.IsMultiline) 1615d7b837e7SAlexander Kornienko return true; 1616f438cb76SDaniel Jasper if (Current.getNextNonComment() && 161704b6a081SDaniel Jasper Current.getNextNonComment()->isStringLiteral()) 1618f438cb76SDaniel Jasper return true; // Implicit concatenation. 16196fd5d646SDaniel Jasper if (Style.ColumnLimit != 0 && 16206fd5d646SDaniel Jasper State.Column + Current.ColumnWidth + Current.UnbreakableTailLength > 1621f438cb76SDaniel Jasper Style.ColumnLimit) 1622f438cb76SDaniel Jasper return true; // String will be split. 1623d7b837e7SAlexander Kornienko return false; 1624f438cb76SDaniel Jasper } 1625f438cb76SDaniel Jasper 1626de0328aeSDaniel Jasper } // namespace format 1627de0328aeSDaniel Jasper } // namespace clang 1628