12 #include "llvm/Support/Debug.h" 15 #define DEBUG_TYPE "format-formatter" 22 bool startsExternCBlock(
const AnnotatedLine &
Line) {
23 const FormatToken *Next = Line.First->getNextNonComment();
24 const FormatToken *NextNext = Next ? Next->getNextNonComment() :
nullptr;
25 return Line.startsWith(tok::kw_extern) && Next && Next->isStringLiteral() &&
26 NextNext && NextNext->is(tok::l_brace);
38 class LevelIndentTracker {
40 LevelIndentTracker(
const FormatStyle &
Style,
41 const AdditionalKeywords &Keywords,
unsigned StartLevel,
43 :
Style(Style), Keywords(Keywords), AdditionalIndent(AdditionalIndent) {
44 for (
unsigned i = 0; i != StartLevel; ++i)
45 IndentForLevel.push_back(Style.IndentWidth * i + AdditionalIndent);
49 unsigned getIndent()
const {
return Indent; }
53 void nextLine(
const AnnotatedLine &Line) {
54 Offset = getIndentOffset(*Line.First);
57 while (IndentForLevel.size() <= Line.Level)
58 IndentForLevel.push_back(-1);
59 if (Line.InPPDirective) {
60 Indent = Line.Level * Style.IndentWidth + AdditionalIndent;
62 IndentForLevel.resize(Line.Level + 1);
63 Indent = getIndent(IndentForLevel, Line.Level);
71 void skipLine(
const AnnotatedLine &Line) {
72 while (IndentForLevel.size() <= Line.Level)
73 IndentForLevel.push_back(
Indent);
81 void adjustToUnmodifiedLine(
const AnnotatedLine &Line) {
82 unsigned LevelIndent = Line.First->OriginalColumn;
83 if (static_cast<int>(LevelIndent) -
Offset >= 0)
85 if ((!Line.First->is(tok::comment) || IndentForLevel[Line.Level] == -1) &&
87 IndentForLevel[Line.Level] = LevelIndent;
95 int getIndentOffset(
const FormatToken &RootToken) {
96 if (Style.Language == FormatStyle::LK_Java ||
97 Style.Language == FormatStyle::LK_JavaScript || Style.isCSharp())
99 if (RootToken.isAccessSpecifier(
false) ||
100 RootToken.isObjCAccessSpecifier() ||
101 (RootToken.isOneOf(Keywords.kw_signals, Keywords.kw_qsignals) &&
102 RootToken.Next && RootToken.Next->is(tok::colon)))
103 return Style.AccessModifierOffset;
112 unsigned getIndent(ArrayRef<int> IndentForLevel,
unsigned Level) {
113 if (IndentForLevel[Level] != -1)
114 return IndentForLevel[
Level];
117 return getIndent(IndentForLevel, Level - 1) + Style.IndentWidth;
120 const FormatStyle &
Style;
121 const AdditionalKeywords &Keywords;
122 const unsigned AdditionalIndent;
125 std::vector<int> IndentForLevel;
137 const FormatToken *getMatchingNamespaceToken(
138 const AnnotatedLine *Line,
139 const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
140 if (!Line->startsWith(tok::r_brace))
142 size_t StartLineIndex = Line->MatchingOpeningBlockLineIndex;
145 assert(StartLineIndex < AnnotatedLines.size());
146 return AnnotatedLines[StartLineIndex]->First->getNamespaceToken();
150 const FormatToken *NamespaceToken = Line->First->getNamespaceToken();
151 return NamespaceToken ? NamespaceToken->TokenText : StringRef();
154 StringRef getMatchingNamespaceTokenText(
155 const AnnotatedLine *Line,
156 const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
157 const FormatToken *NamespaceToken =
158 getMatchingNamespaceToken(Line, AnnotatedLines);
159 return NamespaceToken ? NamespaceToken->TokenText : StringRef();
164 LineJoiner(
const FormatStyle &
Style,
const AdditionalKeywords &Keywords,
165 const SmallVectorImpl<AnnotatedLine *> &Lines)
166 :
Style(Style), Keywords(Keywords),
End(Lines.end()), Next(Lines.begin()),
167 AnnotatedLines(Lines) {}
170 const AnnotatedLine *getNextMergedLine(
bool DryRun,
171 LevelIndentTracker &IndentTracker) {
174 const AnnotatedLine *Current = *Next;
175 IndentTracker.nextLine(*Current);
176 unsigned MergedLines = tryFitMultipleLinesInOne(IndentTracker, Next,
End);
177 if (MergedLines > 0 && Style.ColumnLimit == 0)
180 for (
unsigned i = 0; i < MergedLines; ++i)
181 if (Next[i + 1]->First->NewlinesBefore > 0)
184 for (
unsigned i = 0; i < MergedLines; ++i)
185 join(*Next[0], *Next[i + 1]);
186 Next = Next + MergedLines + 1;
193 tryFitMultipleLinesInOne(LevelIndentTracker &IndentTracker,
194 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
195 SmallVectorImpl<AnnotatedLine *>::const_iterator E) {
196 const unsigned Indent = IndentTracker.getIndent();
202 const AnnotatedLine *TheLine = *I;
203 if (TheLine->Last->is(TT_LineComment))
207 if (TheLine->InPPDirective &&
208 (!I[1]->InPPDirective || I[1]->First->HasUnescapedNewline))
211 if (Style.ColumnLimit > 0 && Indent > Style.ColumnLimit)
218 Limit = TheLine->Last->TotalLength > Limit
220 : Limit - TheLine->Last->TotalLength;
222 if (TheLine->Last->is(TT_FunctionLBrace) &&
223 TheLine->First == TheLine->Last &&
224 !Style.BraceWrapping.SplitEmptyFunction &&
225 I[1]->First->is(tok::r_brace))
226 return tryMergeSimpleBlock(I, E, Limit);
229 if (TheLine->Last->is(tok::l_brace) && TheLine->First == TheLine->Last &&
230 I != AnnotatedLines.begin()) {
231 bool EmptyBlock = I[1]->First->is(tok::r_brace);
233 const FormatToken *
Tok = I[-1]->First;
234 if (Tok && Tok->is(tok::comment))
237 if (Tok && Tok->getNamespaceToken())
238 return !Style.BraceWrapping.SplitEmptyNamespace && EmptyBlock
239 ? tryMergeSimpleBlock(I, E, Limit)
242 if (Tok && Tok->is(tok::kw_typedef))
244 if (Tok && Tok->isOneOf(tok::kw_class, tok::kw_struct, tok::kw_union,
245 tok::kw_extern, Keywords.kw_interface))
246 return !Style.BraceWrapping.SplitEmptyRecord && EmptyBlock
247 ? tryMergeSimpleBlock(I, E, Limit)
253 bool MergeShortFunctions =
254 Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_All ||
255 (Style.AllowShortFunctionsOnASingleLine >= FormatStyle::SFS_Empty &&
256 I[1]->First->is(tok::r_brace)) ||
257 (Style.AllowShortFunctionsOnASingleLine & FormatStyle::SFS_InlineOnly &&
258 TheLine->Level != 0);
260 if (Style.CompactNamespaces) {
261 if (
auto nsToken = TheLine->First->getNamespaceToken()) {
263 unsigned closingLine = TheLine->MatchingClosingBlockLineIndex - 1;
264 for (; I + 1 + i != E &&
266 closingLine == I[i + 1]->MatchingClosingBlockLineIndex &&
267 I[i + 1]->Last->TotalLength < Limit;
268 i++, closingLine--) {
270 IndentTracker.skipLine(*I[i + 1]);
272 Limit -= I[i + 1]->Last->TotalLength;
277 if (
auto nsToken = getMatchingNamespaceToken(TheLine, AnnotatedLines)) {
279 unsigned openingLine = TheLine->MatchingOpeningBlockLineIndex - 1;
280 for (; I + 1 + i != E &&
281 nsToken->TokenText ==
282 getMatchingNamespaceTokenText(I[i + 1], AnnotatedLines) &&
283 openingLine == I[i + 1]->MatchingOpeningBlockLineIndex;
284 i++, openingLine--) {
286 I[i + 1]->First->SpacesRequiredBefore = !I[i]->Last->is(tok::r_brace);
289 IndentTracker.nextLine(*I[i + 1]);
296 if (TheLine->Last->is(TT_FunctionLBrace) &&
297 TheLine->First != TheLine->Last) {
298 return MergeShortFunctions ? tryMergeSimpleBlock(I, E, Limit) : 0;
301 if (TheLine->Last->is(tok::l_brace) && TheLine->First != TheLine->Last &&
302 TheLine->First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_for)) {
303 return Style.AllowShortBlocksOnASingleLine != FormatStyle::SBS_Never
304 ? tryMergeSimpleBlock(I, E, Limit)
308 if (I[1]->First->is(tok::l_brace) &&
309 (TheLine->First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_for,
310 tok::kw_switch, tok::kw_try, tok::kw_do) ||
311 (TheLine->First->is(tok::r_brace) && TheLine->First->Next &&
312 TheLine->First->Next->isOneOf(tok::kw_else, tok::kw_catch))) &&
313 Style.BraceWrapping.AfterControlStatement ==
314 FormatStyle::BWACS_MultiLine) {
318 return (Style.ColumnLimit == 0 ||
319 TheLine->Last->TotalLength <= Style.ColumnLimit)
322 }
else if (I[1]->First->is(tok::l_brace) &&
323 TheLine->First->isOneOf(tok::kw_if, tok::kw_while,
325 return (Style.BraceWrapping.AfterControlStatement ==
326 FormatStyle::BWACS_Always)
327 ? tryMergeSimpleBlock(I, E, Limit)
329 }
else if (I[1]->First->is(tok::l_brace) &&
330 TheLine->First->isOneOf(tok::kw_else, tok::kw_catch) &&
331 Style.BraceWrapping.AfterControlStatement ==
332 FormatStyle::BWACS_MultiLine) {
338 return (Style.ColumnLimit == 0 ||
339 TheLine->Last->TotalLength <= Style.ColumnLimit)
345 if (TheLine->First->is(tok::l_brace) && TheLine->First == TheLine->Last &&
346 I != AnnotatedLines.begin() &&
347 I[-1]->First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_for)) {
348 unsigned MergedLines = 0;
349 if (Style.AllowShortBlocksOnASingleLine != FormatStyle::SBS_Never) {
350 MergedLines = tryMergeSimpleBlock(I - 1, E, Limit);
359 if (TheLine->First->is(tok::l_brace) && I != AnnotatedLines.begin() &&
360 I[-1]->First->is(tok::at) && I[-1]->First->Next) {
362 if (kwId == clang::tok::objc_autoreleasepool ||
363 kwId == clang::tok::objc_synchronized)
367 if (TheLine->First->is(tok::l_brace) && I != AnnotatedLines.begin() &&
368 I[-1]->First->isOneOf(tok::kw_case, tok::kw_default))
371 if (TheLine->Last->is(tok::l_brace)) {
372 return !Style.BraceWrapping.AfterFunction ||
373 (I[1]->First->is(tok::r_brace) &&
374 !Style.BraceWrapping.SplitEmptyRecord)
375 ? tryMergeSimpleBlock(I, E, Limit)
379 if (I[1]->First->is(TT_FunctionLBrace) &&
380 Style.BraceWrapping.AfterFunction) {
381 if (I[1]->Last->is(TT_LineComment))
385 if (Limit <= 2 || (Style.ColumnLimit == 0 && containsMustBreak(TheLine)))
389 unsigned MergedLines = 0;
390 if (MergeShortFunctions ||
391 (Style.AllowShortFunctionsOnASingleLine >= FormatStyle::SFS_Empty &&
392 I[1]->First == I[1]->Last && I + 2 != E &&
393 I[2]->First->is(tok::r_brace))) {
394 MergedLines = tryMergeSimpleBlock(I + 1, E, Limit);
402 if (TheLine->First->is(tok::kw_if)) {
403 return Style.AllowShortIfStatementsOnASingleLine
404 ? tryMergeSimpleControlStatement(I, E, Limit)
407 if (TheLine->First->isOneOf(tok::kw_for, tok::kw_while)) {
408 return Style.AllowShortLoopsOnASingleLine
409 ? tryMergeSimpleControlStatement(I, E, Limit)
412 if (TheLine->First->isOneOf(tok::kw_case, tok::kw_default)) {
413 return Style.AllowShortCaseLabelsOnASingleLine
414 ? tryMergeShortCaseLabels(I, E, Limit)
417 if (TheLine->InPPDirective &&
418 (TheLine->First->HasUnescapedNewline || TheLine->First->IsFirst)) {
419 return tryMergeSimplePPDirective(I, E, Limit);
425 tryMergeSimplePPDirective(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
426 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
430 if (I + 2 != E && I[2]->
InPPDirective && !I[2]->First->HasUnescapedNewline)
432 if (1 + I[1]->Last->TotalLength > Limit)
437 unsigned tryMergeSimpleControlStatement(
438 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
439 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
unsigned Limit) {
442 if (Style.BraceWrapping.AfterControlStatement ==
443 FormatStyle::BWACS_Always &&
444 I[1]->First->is(tok::l_brace) &&
445 Style.AllowShortBlocksOnASingleLine == FormatStyle::SBS_Never)
448 (I[1]->InPPDirective && I[1]->First->HasUnescapedNewline))
450 Limit = limitConsideringMacros(I + 1, E, Limit);
451 AnnotatedLine &Line = **I;
452 if (Line.Last->isNot(tok::r_paren))
454 if (1 + I[1]->Last->TotalLength > Limit)
456 if (I[1]->First->isOneOf(tok::semi, tok::kw_if, tok::kw_for, tok::kw_while,
460 if (Style.AllowShortIfStatementsOnASingleLine != FormatStyle::SIS_Always) {
461 if (I + 2 != E && Line.startsWith(tok::kw_if) &&
462 I[2]->First->is(tok::kw_else))
469 tryMergeShortCaseLabels(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
470 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
472 if (Limit == 0 || I + 1 == E ||
473 I[1]->First->isOneOf(tok::kw_case, tok::kw_default))
475 if (I[0]->Last->is(tok::l_brace) || I[1]->First->is(tok::l_brace))
477 unsigned NumStmts = 0;
479 bool EndsWithComment =
false;
481 const unsigned Level = I[0]->Level;
482 for (; NumStmts < 3; ++NumStmts) {
483 if (I + 1 + NumStmts == E)
485 const AnnotatedLine *Line = I[1 + NumStmts];
486 if (Line->InPPDirective != InPPDirective)
488 if (Line->First->isOneOf(tok::kw_case, tok::kw_default, tok::r_brace))
490 if (Line->First->isOneOf(tok::kw_if, tok::kw_for, tok::kw_switch,
494 if (Line->First->is(tok::comment)) {
495 if (Level != Line->Level)
497 SmallVectorImpl<AnnotatedLine *>::const_iterator J = I + 2 + NumStmts;
498 for (; J != E; ++J) {
500 if (Line->InPPDirective != InPPDirective)
502 if (Line->First->isOneOf(tok::kw_case, tok::kw_default, tok::r_brace))
504 if (Line->First->isNot(tok::comment) || Level != Line->Level)
509 if (Line->Last->is(tok::comment))
510 EndsWithComment =
true;
511 Length += I[1 + NumStmts]->Last->TotalLength + 1;
513 if (NumStmts == 0 || NumStmts == 3 || Length > Limit)
519 tryMergeSimpleBlock(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
520 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
522 AnnotatedLine &Line = **I;
527 if (Style.Language != FormatStyle::LK_Java &&
528 Line.First->isOneOf(tok::at, tok::minus, tok::plus))
533 if (Line.First->isOneOf(tok::kw_else, tok::kw_case) ||
534 (Line.First->Next && Line.First->Next->is(tok::kw_else)))
537 if (Line.First->is(tok::kw_default)) {
539 if (Tok && Tok->is(tok::colon))
542 if (Line.First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_do, tok::kw_try,
543 tok::kw___try, tok::kw_catch, tok::kw___finally,
544 tok::kw_for, tok::r_brace, Keywords.kw___except)) {
545 if (Style.AllowShortBlocksOnASingleLine == FormatStyle::SBS_Never)
549 if (!Style.AllowShortIfStatementsOnASingleLine &&
550 Line.startsWith(tok::kw_if) &&
551 !Style.BraceWrapping.AfterControlStatement &&
552 !I[1]->First->is(tok::r_brace))
554 if (!Style.AllowShortIfStatementsOnASingleLine &&
555 Line.startsWith(tok::kw_if) &&
556 Style.BraceWrapping.AfterControlStatement ==
557 FormatStyle::BWACS_Always &&
558 I + 2 != E && !I[2]->First->is(tok::r_brace))
560 if (!Style.AllowShortLoopsOnASingleLine &&
561 Line.First->isOneOf(tok::kw_while, tok::kw_do, tok::kw_for) &&
562 !Style.BraceWrapping.AfterControlStatement &&
563 !I[1]->First->is(tok::r_brace))
565 if (!Style.AllowShortLoopsOnASingleLine &&
566 Line.First->isOneOf(tok::kw_while, tok::kw_do, tok::kw_for) &&
567 Style.BraceWrapping.AfterControlStatement ==
568 FormatStyle::BWACS_Always &&
569 I + 2 != E && !I[2]->First->is(tok::r_brace))
576 if (Line.First->isOneOf(tok::kw_try, tok::kw___try, tok::kw_catch,
577 Keywords.kw___except, tok::kw___finally))
581 if (Line.Last->is(tok::l_brace)) {
582 FormatToken *
Tok = I[1]->First;
583 if (Tok->is(tok::r_brace) && !Tok->MustBreakBefore &&
584 (Tok->getNextNonComment() ==
nullptr ||
585 Tok->getNextNonComment()->is(tok::semi))) {
588 Tok->CanBreakBefore =
true;
590 }
else if (Limit != 0 && !Line.startsWithNamespace() &&
591 !startsExternCBlock(Line)) {
593 FormatToken *RecordTok = Line.First;
595 while (RecordTok->Next &&
596 RecordTok->isOneOf(tok::kw_typedef, tok::kw_export,
597 Keywords.kw_declare, Keywords.kw_abstract,
599 RecordTok = RecordTok->Next;
601 RecordTok->isOneOf(tok::kw_class, tok::kw_union, tok::kw_struct,
602 Keywords.kw_interface))
608 Limit = limitConsideringMacros(I + 2, E, Limit);
610 if (!nextTwoLinesFitInto(I, Limit))
615 if (I[1]->Last->is(TT_LineComment))
618 if (Tok->is(tok::l_brace) && Tok->BlockKind !=
BK_BracedInit)
625 if (Tok->isNot(tok::r_brace))
629 if (Tok->Next && Tok->Next->is(tok::kw_else))
638 if (Line.First == Line.Last &&
639 Style.BraceWrapping.AfterControlStatement ==
640 FormatStyle::BWACS_MultiLine)
645 }
else if (I[1]->First->is(tok::l_brace)) {
646 if (I[1]->Last->is(TT_LineComment))
650 if (Limit <= 2 || (Style.ColumnLimit == 0 && containsMustBreak(*I)))
653 unsigned MergedLines = 0;
654 if (Style.AllowShortBlocksOnASingleLine != FormatStyle::SBS_Never ||
655 (I[1]->First == I[1]->Last && I + 2 != E &&
656 I[2]->First->is(tok::r_brace))) {
657 MergedLines = tryMergeSimpleBlock(I + 1, E, Limit);
671 limitConsideringMacros(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
672 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
675 !I[1]->First->HasUnescapedNewline && !I[1]->First->is(
tok::eof)) {
676 return Limit < 2 ? 0 : Limit - 2;
681 bool nextTwoLinesFitInto(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
683 if (I[1]->First->MustBreakBefore || I[2]->First->MustBreakBefore)
685 return 1 + I[1]->Last->TotalLength + 1 + I[2]->Last->TotalLength <= Limit;
688 bool containsMustBreak(
const AnnotatedLine *Line) {
696 void join(AnnotatedLine &A,
const AnnotatedLine &B) {
697 assert(!A.Last->Next);
698 assert(!B.First->Previous);
701 A.Last->Next = B.First;
702 B.First->Previous = A.Last;
703 B.First->CanBreakBefore =
true;
704 unsigned LengthA = A.Last->TotalLength + B.First->SpacesRequiredBefore;
711 const FormatStyle &
Style;
712 const AdditionalKeywords &Keywords;
713 const SmallVectorImpl<AnnotatedLine *>::const_iterator
End;
715 SmallVectorImpl<AnnotatedLine *>::const_iterator Next;
716 const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines;
719 static void markFinalized(FormatToken *
Tok) {
721 Tok->Finalized =
true;
722 for (AnnotatedLine *Child : Tok->Children)
723 markFinalized(Child->First);
728 static void printLineState(
const LineState &
State) {
729 llvm::dbgs() <<
"State: ";
730 for (
const ParenState &
P : State.Stack) {
731 llvm::dbgs() << (P.Tok ? P.Tok->TokenText :
"F") <<
"|" << P.Indent <<
"|" 732 << P.LastSpace <<
"|" << P.NestedBlockIndent <<
" ";
734 llvm::dbgs() << State.NextToken->TokenText <<
"\n";
739 class LineFormatter {
741 LineFormatter(ContinuationIndenter *
Indenter, WhitespaceManager *Whitespaces,
742 const FormatStyle &
Style,
743 UnwrappedLineFormatter *BlockFormatter)
744 :
Indenter(Indenter), Whitespaces(Whitespaces),
Style(Style),
745 BlockFormatter(BlockFormatter) {}
746 virtual ~LineFormatter() {}
751 virtual unsigned formatLine(
const AnnotatedLine &Line,
unsigned FirstIndent,
752 unsigned FirstStartColumn,
bool DryRun) = 0;
775 bool formatChildren(LineState &State,
bool NewLine,
bool DryRun,
777 const FormatToken *LBrace = State.NextToken->getPreviousNonComment();
778 FormatToken &
Previous = *State.NextToken->Previous;
779 if (!LBrace || LBrace->isNot(tok::l_brace) ||
780 LBrace->BlockKind !=
BK_Block || Previous.Children.size() == 0)
786 int AdditionalIndent = State.Stack.back().Indent -
787 Previous.Children[0]->Level * Style.IndentWidth;
790 BlockFormatter->format(Previous.Children, DryRun, AdditionalIndent,
795 if (Previous.Children[0]->First->MustBreakBefore)
799 if (Previous.is(tok::comment))
803 if (Previous.Children.size() > 1)
806 const AnnotatedLine *Child = Previous.Children[0];
808 if (Child->Last->isTrailingComment())
813 if (Style.ColumnLimit > 0 &&
814 Child->Last->TotalLength + State.Column + 2 > Style.ColumnLimit)
818 Whitespaces->replaceWhitespace(
820 State.Column, State.Line->InPPDirective);
823 formatLine(*Child, State.Column + 1, 0, DryRun);
825 State.Column += 1 + Child->Last->TotalLength;
832 WhitespaceManager *Whitespaces;
833 const FormatStyle &
Style;
834 UnwrappedLineFormatter *BlockFormatter;
838 class NoColumnLimitLineFormatter :
public LineFormatter {
840 NoColumnLimitLineFormatter(ContinuationIndenter *
Indenter,
841 WhitespaceManager *Whitespaces,
842 const FormatStyle &
Style,
843 UnwrappedLineFormatter *BlockFormatter)
844 : LineFormatter(Indenter, Whitespaces, Style, BlockFormatter) {}
848 unsigned formatLine(
const AnnotatedLine &Line,
unsigned FirstIndent,
849 unsigned FirstStartColumn,
bool DryRun)
override {
851 LineState State = Indenter->getInitialState(FirstIndent, FirstStartColumn,
853 while (State.NextToken) {
855 Indenter->mustBreak(State) ||
856 (Indenter->canBreak(State) && State.NextToken->NewlinesBefore > 0);
857 unsigned Penalty = 0;
858 formatChildren(State, Newline,
false, Penalty);
859 Indenter->addTokenToState(State, Newline,
false);
866 class NoLineBreakFormatter :
public LineFormatter {
868 NoLineBreakFormatter(ContinuationIndenter *
Indenter,
869 WhitespaceManager *Whitespaces,
const FormatStyle &
Style,
870 UnwrappedLineFormatter *BlockFormatter)
871 : LineFormatter(Indenter, Whitespaces, Style, BlockFormatter) {}
874 unsigned formatLine(
const AnnotatedLine &Line,
unsigned FirstIndent,
875 unsigned FirstStartColumn,
bool DryRun)
override {
876 unsigned Penalty = 0;
878 Indenter->getInitialState(FirstIndent, FirstStartColumn, &Line, DryRun);
879 while (State.NextToken) {
880 formatChildren(State,
false, DryRun, Penalty);
881 Indenter->addTokenToState(
882 State, State.NextToken->MustBreakBefore, DryRun);
889 class OptimizingLineFormatter :
public LineFormatter {
891 OptimizingLineFormatter(ContinuationIndenter *
Indenter,
892 WhitespaceManager *Whitespaces,
893 const FormatStyle &
Style,
894 UnwrappedLineFormatter *BlockFormatter)
895 : LineFormatter(Indenter, Whitespaces, Style, BlockFormatter) {}
899 unsigned formatLine(
const AnnotatedLine &Line,
unsigned FirstIndent,
900 unsigned FirstStartColumn,
bool DryRun)
override {
902 Indenter->getInitialState(FirstIndent, FirstStartColumn, &Line, DryRun);
907 State.Stack.back().BreakBeforeParameter =
true;
910 return analyzeSolutionSpace(State, DryRun);
914 struct CompareLineStatePointers {
915 bool operator()(LineState *obj1, LineState *obj2)
const {
916 return *obj1 < *obj2;
925 typedef std::pair<unsigned, unsigned> OrderedPenalty;
939 typedef std::pair<OrderedPenalty, StateNode *> QueueItem;
942 typedef std::priority_queue<QueueItem, std::vector<QueueItem>,
943 std::greater<QueueItem>>
954 unsigned analyzeSolutionSpace(LineState &InitialState,
bool DryRun) {
955 std::set<LineState *, CompareLineStatePointers> Seen;
964 new (Allocator.Allocate()) StateNode(InitialState,
false,
nullptr);
965 Queue.push(QueueItem(OrderedPenalty(0, Count), Node));
968 unsigned Penalty = 0;
971 while (!Queue.empty()) {
972 Penalty = Queue.top().first.first;
973 StateNode *Node = Queue.top().second;
974 if (!Node->State.NextToken) {
975 LLVM_DEBUG(llvm::dbgs()
976 <<
"\n---\nPenalty for line: " << Penalty <<
"\n");
984 Node->State.IgnoreStackForComparison =
true;
986 if (!Seen.insert(&Node->State).second)
992 addNextStateToQueue(Penalty, Node,
false, &Count, &Queue);
994 addNextStateToQueue(Penalty, Node,
true, &Count, &Queue);
1000 LLVM_DEBUG(llvm::dbgs() <<
"Could not find a solution.\n");
1006 reconstructPath(InitialState, Queue.top().second);
1008 LLVM_DEBUG(llvm::dbgs()
1009 <<
"Total number of analyzed states: " << Count <<
"\n");
1010 LLVM_DEBUG(llvm::dbgs() <<
"---\n");
1019 void addNextStateToQueue(
unsigned Penalty, StateNode *PreviousNode,
1020 bool NewLine,
unsigned *Count, QueueType *Queue) {
1021 if (NewLine && !Indenter->canBreak(PreviousNode->State))
1023 if (!NewLine && Indenter->mustBreak(PreviousNode->State))
1026 StateNode *
Node =
new (Allocator.Allocate())
1027 StateNode(PreviousNode->State, NewLine, PreviousNode);
1028 if (!formatChildren(Node->State, NewLine,
true, Penalty))
1031 Penalty += Indenter->addTokenToState(Node->State, NewLine,
true);
1033 Queue->push(QueueItem(OrderedPenalty(Penalty, *Count), Node));
1039 void reconstructPath(LineState &State, StateNode *Best) {
1040 std::deque<StateNode *> Path;
1042 while (Best->Previous) {
1043 Path.push_front(Best);
1044 Best = Best->Previous;
1046 for (
auto I = Path.begin(), E = Path.end(); I != E; ++I) {
1047 unsigned Penalty = 0;
1048 formatChildren(State, (*I)->NewLine,
false, Penalty);
1049 Penalty += Indenter->addTokenToState(State, (*I)->NewLine,
false);
1052 printLineState((*I)->Previous->State);
1053 if ((*I)->NewLine) {
1054 llvm::dbgs() <<
"Penalty for placing " 1055 << (*I)->Previous->State.NextToken->Tok.getName()
1056 <<
" on a new line: " << Penalty <<
"\n";
1062 llvm::SpecificBumpPtrAllocator<StateNode> Allocator;
1069 int AdditionalIndent,
bool FixBadIndentation,
unsigned FirstStartColumn,
1070 unsigned NextStartColumn,
unsigned LastStartColumn) {
1071 LineJoiner Joiner(
Style, Keywords, Lines);
1074 std::pair<const SmallVectorImpl<AnnotatedLine *> *,
unsigned> CacheKey(
1075 &Lines, AdditionalIndent);
1076 auto CacheIt = PenaltyCache.find(CacheKey);
1077 if (DryRun && CacheIt != PenaltyCache.end())
1078 return CacheIt->second;
1080 assert(!Lines.empty());
1081 unsigned Penalty = 0;
1082 LevelIndentTracker IndentTracker(
Style, Keywords, Lines[0]->
Level,
1090 bool FirstLine =
true;
1092 Joiner.getNextMergedLine(DryRun, IndentTracker);
1093 Line;
Line = NextLine, FirstLine =
false) {
1095 unsigned Indent = IndentTracker.getIndent();
1101 bool PreviousRBrace =
1102 PreviousLine && PreviousLine->
startsWith(tok::r_brace);
1103 bool ContinueFormatting =
1104 TheLine.
Level > RangeMinLevel ||
1105 (TheLine.
Level == RangeMinLevel && !PreviousRBrace &&
1108 bool FixIndentation = (FixBadIndentation || ContinueFormatting) &&
1110 bool ShouldFormat = TheLine.
Affected || FixIndentation;
1114 Status->FormatComplete =
false;
1122 formatFirstToken(TheLine, PreviousLine, Lines, Indent,
1123 LastLine ? LastStartColumn : NextStartColumn + Indent);
1126 NextLine = Joiner.getNextMergedLine(DryRun, IndentTracker);
1127 unsigned ColumnLimit = getColumnLimit(TheLine.
InPPDirective, NextLine);
1128 bool FitsIntoOneLine =
1131 (
Style.Language != FormatStyle::LK_JavaScript ||
1132 !
Style.JavaScriptWrapImports)) ||
1133 (
Style.isCSharp() &&
1135 if (
Style.ColumnLimit == 0)
1136 NoColumnLimitLineFormatter(
Indenter, Whitespaces,
Style,
this)
1137 .formatLine(TheLine, NextStartColumn + Indent,
1138 FirstLine ? FirstStartColumn : 0, DryRun);
1139 else if (FitsIntoOneLine)
1140 Penalty += NoLineBreakFormatter(
Indenter, Whitespaces,
Style,
this)
1141 .formatLine(TheLine, NextStartColumn + Indent,
1142 FirstLine ? FirstStartColumn : 0, DryRun);
1144 Penalty += OptimizingLineFormatter(
Indenter, Whitespaces,
Style,
this)
1145 .formatLine(TheLine, NextStartColumn + Indent,
1146 FirstLine ? FirstStartColumn : 0, DryRun);
1158 bool StartsNewLine =
1161 IndentTracker.adjustToUnmodifiedLine(TheLine);
1163 bool ReformatLeadingWhitespace =
1164 StartsNewLine && ((PreviousLine && PreviousLine->
Affected) ||
1167 if (ReformatLeadingWhitespace)
1168 formatFirstToken(TheLine, PreviousLine, Lines,
1172 Whitespaces->addUntouchableToken(*TheLine.
First,
1179 NextLine = Joiner.getNextMergedLine(DryRun, IndentTracker);
1183 markFinalized(TheLine.
First);
1184 PreviousLine = &TheLine;
1186 PenaltyCache[CacheKey] = Penalty;
1190 void UnwrappedLineFormatter::formatFirstToken(
1193 unsigned NewlineIndent) {
1197 unsigned TokenIndent = Newlines ? NewlineIndent : 0;
1198 Whitespaces->replaceWhitespace(RootToken, Newlines, TokenIndent,
1205 if (RootToken.
is(tok::r_brace) &&
1212 if (PreviousLine ==
nullptr && Line.
Level > 0)
1214 if (Newlines == 0 && !RootToken.
IsFirst)
1220 if (!
Style.KeepEmptyLinesAtTheStartOfBlocks && PreviousLine &&
1221 PreviousLine->
Last->
is(tok::l_brace) &&
1223 !startsExternCBlock(*PreviousLine))
1227 if (PreviousLine && PreviousLine->
Last->
isOneOf(tok::semi, tok::r_brace) &&
1237 Indent = NewlineIndent;
1240 if (
Style.BreakBeforeBraces == FormatStyle::BS_Whitesmiths) {
1241 if (RootToken.
isOneOf(tok::l_brace, tok::r_brace, tok::kw_case))
1242 Indent +=
Style.IndentWidth;
1246 if (
Style.IndentPPDirectives != FormatStyle::PPDIS_BeforeHash &&
1251 Whitespaces->replaceWhitespace(RootToken, Newlines, Indent, Indent,
1261 bool ContinuesPPDirective =
1270 return Style.ColumnLimit - (ContinuesPPDirective ? 2 : 0);
if(T->getSizeExpr()) TRY_TO(TraverseStmt(T -> getSizeExpr()))
WhitespaceManager class manages whitespace around tokens and their replacements.
const AnnotatedLine * Line
SourceLocation getLocation() const
Return a source location identifier for the specified offset in the current file. ...
ObjCKeywordKind
Provides a namespace for Objective-C keywords which start with an '@'.
ast_type_traits::DynTypedNode Node
Optional< types::ID > Type
Dataflow Directional Tag Classes.
static void skipLine(const char *&First, const char *const End)
__DEVICE__ int min(int __a, int __b)
raw_ostream & Indent(raw_ostream &Out, const unsigned int Space, bool IsDot)