annotate clang/lib/Format/UnwrappedLineFormatter.cpp @ 176:de4ac79aef9d

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 17:13:11 +0900
parents 0572611fdcc8
children 2e18cbf3894f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===--- UnwrappedLineFormatter.cpp - Format C++ code ---------------------===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 #include "UnwrappedLineFormatter.h"
anatofuz
parents:
diff changeset
10 #include "NamespaceEndCommentsFixer.h"
anatofuz
parents:
diff changeset
11 #include "WhitespaceManager.h"
anatofuz
parents:
diff changeset
12 #include "llvm/Support/Debug.h"
anatofuz
parents:
diff changeset
13 #include <queue>
anatofuz
parents:
diff changeset
14
anatofuz
parents:
diff changeset
15 #define DEBUG_TYPE "format-formatter"
anatofuz
parents:
diff changeset
16
anatofuz
parents:
diff changeset
17 namespace clang {
anatofuz
parents:
diff changeset
18 namespace format {
anatofuz
parents:
diff changeset
19
anatofuz
parents:
diff changeset
20 namespace {
anatofuz
parents:
diff changeset
21
anatofuz
parents:
diff changeset
22 bool startsExternCBlock(const AnnotatedLine &Line) {
anatofuz
parents:
diff changeset
23 const FormatToken *Next = Line.First->getNextNonComment();
anatofuz
parents:
diff changeset
24 const FormatToken *NextNext = Next ? Next->getNextNonComment() : nullptr;
anatofuz
parents:
diff changeset
25 return Line.startsWith(tok::kw_extern) && Next && Next->isStringLiteral() &&
anatofuz
parents:
diff changeset
26 NextNext && NextNext->is(tok::l_brace);
anatofuz
parents:
diff changeset
27 }
anatofuz
parents:
diff changeset
28
anatofuz
parents:
diff changeset
29 /// Tracks the indent level of \c AnnotatedLines across levels.
anatofuz
parents:
diff changeset
30 ///
anatofuz
parents:
diff changeset
31 /// \c nextLine must be called for each \c AnnotatedLine, after which \c
anatofuz
parents:
diff changeset
32 /// getIndent() will return the indent for the last line \c nextLine was called
anatofuz
parents:
diff changeset
33 /// with.
anatofuz
parents:
diff changeset
34 /// If the line is not formatted (and thus the indent does not change), calling
anatofuz
parents:
diff changeset
35 /// \c adjustToUnmodifiedLine after the call to \c nextLine will cause
anatofuz
parents:
diff changeset
36 /// subsequent lines on the same level to be indented at the same level as the
anatofuz
parents:
diff changeset
37 /// given line.
anatofuz
parents:
diff changeset
38 class LevelIndentTracker {
anatofuz
parents:
diff changeset
39 public:
anatofuz
parents:
diff changeset
40 LevelIndentTracker(const FormatStyle &Style,
anatofuz
parents:
diff changeset
41 const AdditionalKeywords &Keywords, unsigned StartLevel,
anatofuz
parents:
diff changeset
42 int AdditionalIndent)
anatofuz
parents:
diff changeset
43 : Style(Style), Keywords(Keywords), AdditionalIndent(AdditionalIndent) {
anatofuz
parents:
diff changeset
44 for (unsigned i = 0; i != StartLevel; ++i)
anatofuz
parents:
diff changeset
45 IndentForLevel.push_back(Style.IndentWidth * i + AdditionalIndent);
anatofuz
parents:
diff changeset
46 }
anatofuz
parents:
diff changeset
47
anatofuz
parents:
diff changeset
48 /// Returns the indent for the current line.
anatofuz
parents:
diff changeset
49 unsigned getIndent() const { return Indent; }
anatofuz
parents:
diff changeset
50
anatofuz
parents:
diff changeset
51 /// Update the indent state given that \p Line is going to be formatted
anatofuz
parents:
diff changeset
52 /// next.
anatofuz
parents:
diff changeset
53 void nextLine(const AnnotatedLine &Line) {
anatofuz
parents:
diff changeset
54 Offset = getIndentOffset(*Line.First);
anatofuz
parents:
diff changeset
55 // Update the indent level cache size so that we can rely on it
anatofuz
parents:
diff changeset
56 // having the right size in adjustToUnmodifiedline.
anatofuz
parents:
diff changeset
57 while (IndentForLevel.size() <= Line.Level)
anatofuz
parents:
diff changeset
58 IndentForLevel.push_back(-1);
anatofuz
parents:
diff changeset
59 if (Line.InPPDirective) {
anatofuz
parents:
diff changeset
60 Indent = Line.Level * Style.IndentWidth + AdditionalIndent;
anatofuz
parents:
diff changeset
61 } else {
anatofuz
parents:
diff changeset
62 IndentForLevel.resize(Line.Level + 1);
anatofuz
parents:
diff changeset
63 Indent = getIndent(IndentForLevel, Line.Level);
anatofuz
parents:
diff changeset
64 }
anatofuz
parents:
diff changeset
65 if (static_cast<int>(Indent) + Offset >= 0)
anatofuz
parents:
diff changeset
66 Indent += Offset;
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
67 if (Line.First->is(TT_CSharpGenericTypeConstraint))
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
68 Indent = Line.Level * Style.IndentWidth + Style.ContinuationIndentWidth;
150
anatofuz
parents:
diff changeset
69 }
anatofuz
parents:
diff changeset
70
anatofuz
parents:
diff changeset
71 /// Update the indent state given that \p Line indent should be
anatofuz
parents:
diff changeset
72 /// skipped.
anatofuz
parents:
diff changeset
73 void skipLine(const AnnotatedLine &Line) {
anatofuz
parents:
diff changeset
74 while (IndentForLevel.size() <= Line.Level)
anatofuz
parents:
diff changeset
75 IndentForLevel.push_back(Indent);
anatofuz
parents:
diff changeset
76 }
anatofuz
parents:
diff changeset
77
anatofuz
parents:
diff changeset
78 /// Update the level indent to adapt to the given \p Line.
anatofuz
parents:
diff changeset
79 ///
anatofuz
parents:
diff changeset
80 /// When a line is not formatted, we move the subsequent lines on the same
anatofuz
parents:
diff changeset
81 /// level to the same indent.
anatofuz
parents:
diff changeset
82 /// Note that \c nextLine must have been called before this method.
anatofuz
parents:
diff changeset
83 void adjustToUnmodifiedLine(const AnnotatedLine &Line) {
anatofuz
parents:
diff changeset
84 unsigned LevelIndent = Line.First->OriginalColumn;
anatofuz
parents:
diff changeset
85 if (static_cast<int>(LevelIndent) - Offset >= 0)
anatofuz
parents:
diff changeset
86 LevelIndent -= Offset;
anatofuz
parents:
diff changeset
87 if ((!Line.First->is(tok::comment) || IndentForLevel[Line.Level] == -1) &&
anatofuz
parents:
diff changeset
88 !Line.InPPDirective)
anatofuz
parents:
diff changeset
89 IndentForLevel[Line.Level] = LevelIndent;
anatofuz
parents:
diff changeset
90 }
anatofuz
parents:
diff changeset
91
anatofuz
parents:
diff changeset
92 private:
anatofuz
parents:
diff changeset
93 /// Get the offset of the line relatively to the level.
anatofuz
parents:
diff changeset
94 ///
anatofuz
parents:
diff changeset
95 /// For example, 'public:' labels in classes are offset by 1 or 2
anatofuz
parents:
diff changeset
96 /// characters to the left from their level.
anatofuz
parents:
diff changeset
97 int getIndentOffset(const FormatToken &RootToken) {
anatofuz
parents:
diff changeset
98 if (Style.Language == FormatStyle::LK_Java ||
anatofuz
parents:
diff changeset
99 Style.Language == FormatStyle::LK_JavaScript || Style.isCSharp())
anatofuz
parents:
diff changeset
100 return 0;
anatofuz
parents:
diff changeset
101 if (RootToken.isAccessSpecifier(false) ||
anatofuz
parents:
diff changeset
102 RootToken.isObjCAccessSpecifier() ||
anatofuz
parents:
diff changeset
103 (RootToken.isOneOf(Keywords.kw_signals, Keywords.kw_qsignals) &&
anatofuz
parents:
diff changeset
104 RootToken.Next && RootToken.Next->is(tok::colon)))
anatofuz
parents:
diff changeset
105 return Style.AccessModifierOffset;
anatofuz
parents:
diff changeset
106 return 0;
anatofuz
parents:
diff changeset
107 }
anatofuz
parents:
diff changeset
108
anatofuz
parents:
diff changeset
109 /// Get the indent of \p Level from \p IndentForLevel.
anatofuz
parents:
diff changeset
110 ///
anatofuz
parents:
diff changeset
111 /// \p IndentForLevel must contain the indent for the level \c l
anatofuz
parents:
diff changeset
112 /// at \p IndentForLevel[l], or a value < 0 if the indent for
anatofuz
parents:
diff changeset
113 /// that level is unknown.
anatofuz
parents:
diff changeset
114 unsigned getIndent(ArrayRef<int> IndentForLevel, unsigned Level) {
anatofuz
parents:
diff changeset
115 if (IndentForLevel[Level] != -1)
anatofuz
parents:
diff changeset
116 return IndentForLevel[Level];
anatofuz
parents:
diff changeset
117 if (Level == 0)
anatofuz
parents:
diff changeset
118 return 0;
anatofuz
parents:
diff changeset
119 return getIndent(IndentForLevel, Level - 1) + Style.IndentWidth;
anatofuz
parents:
diff changeset
120 }
anatofuz
parents:
diff changeset
121
anatofuz
parents:
diff changeset
122 const FormatStyle &Style;
anatofuz
parents:
diff changeset
123 const AdditionalKeywords &Keywords;
anatofuz
parents:
diff changeset
124 const unsigned AdditionalIndent;
anatofuz
parents:
diff changeset
125
anatofuz
parents:
diff changeset
126 /// The indent in characters for each level.
anatofuz
parents:
diff changeset
127 std::vector<int> IndentForLevel;
anatofuz
parents:
diff changeset
128
anatofuz
parents:
diff changeset
129 /// Offset of the current line relative to the indent level.
anatofuz
parents:
diff changeset
130 ///
anatofuz
parents:
diff changeset
131 /// For example, the 'public' keywords is often indented with a negative
anatofuz
parents:
diff changeset
132 /// offset.
anatofuz
parents:
diff changeset
133 int Offset = 0;
anatofuz
parents:
diff changeset
134
anatofuz
parents:
diff changeset
135 /// The current line's indent.
anatofuz
parents:
diff changeset
136 unsigned Indent = 0;
anatofuz
parents:
diff changeset
137 };
anatofuz
parents:
diff changeset
138
anatofuz
parents:
diff changeset
139 const FormatToken *getMatchingNamespaceToken(
anatofuz
parents:
diff changeset
140 const AnnotatedLine *Line,
anatofuz
parents:
diff changeset
141 const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
anatofuz
parents:
diff changeset
142 if (!Line->startsWith(tok::r_brace))
anatofuz
parents:
diff changeset
143 return nullptr;
anatofuz
parents:
diff changeset
144 size_t StartLineIndex = Line->MatchingOpeningBlockLineIndex;
anatofuz
parents:
diff changeset
145 if (StartLineIndex == UnwrappedLine::kInvalidIndex)
anatofuz
parents:
diff changeset
146 return nullptr;
anatofuz
parents:
diff changeset
147 assert(StartLineIndex < AnnotatedLines.size());
anatofuz
parents:
diff changeset
148 return AnnotatedLines[StartLineIndex]->First->getNamespaceToken();
anatofuz
parents:
diff changeset
149 }
anatofuz
parents:
diff changeset
150
anatofuz
parents:
diff changeset
151 StringRef getNamespaceTokenText(const AnnotatedLine *Line) {
anatofuz
parents:
diff changeset
152 const FormatToken *NamespaceToken = Line->First->getNamespaceToken();
anatofuz
parents:
diff changeset
153 return NamespaceToken ? NamespaceToken->TokenText : StringRef();
anatofuz
parents:
diff changeset
154 }
anatofuz
parents:
diff changeset
155
anatofuz
parents:
diff changeset
156 StringRef getMatchingNamespaceTokenText(
anatofuz
parents:
diff changeset
157 const AnnotatedLine *Line,
anatofuz
parents:
diff changeset
158 const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
anatofuz
parents:
diff changeset
159 const FormatToken *NamespaceToken =
anatofuz
parents:
diff changeset
160 getMatchingNamespaceToken(Line, AnnotatedLines);
anatofuz
parents:
diff changeset
161 return NamespaceToken ? NamespaceToken->TokenText : StringRef();
anatofuz
parents:
diff changeset
162 }
anatofuz
parents:
diff changeset
163
anatofuz
parents:
diff changeset
164 class LineJoiner {
anatofuz
parents:
diff changeset
165 public:
anatofuz
parents:
diff changeset
166 LineJoiner(const FormatStyle &Style, const AdditionalKeywords &Keywords,
anatofuz
parents:
diff changeset
167 const SmallVectorImpl<AnnotatedLine *> &Lines)
anatofuz
parents:
diff changeset
168 : Style(Style), Keywords(Keywords), End(Lines.end()), Next(Lines.begin()),
anatofuz
parents:
diff changeset
169 AnnotatedLines(Lines) {}
anatofuz
parents:
diff changeset
170
anatofuz
parents:
diff changeset
171 /// Returns the next line, merging multiple lines into one if possible.
anatofuz
parents:
diff changeset
172 const AnnotatedLine *getNextMergedLine(bool DryRun,
anatofuz
parents:
diff changeset
173 LevelIndentTracker &IndentTracker) {
anatofuz
parents:
diff changeset
174 if (Next == End)
anatofuz
parents:
diff changeset
175 return nullptr;
anatofuz
parents:
diff changeset
176 const AnnotatedLine *Current = *Next;
anatofuz
parents:
diff changeset
177 IndentTracker.nextLine(*Current);
anatofuz
parents:
diff changeset
178 unsigned MergedLines = tryFitMultipleLinesInOne(IndentTracker, Next, End);
anatofuz
parents:
diff changeset
179 if (MergedLines > 0 && Style.ColumnLimit == 0)
anatofuz
parents:
diff changeset
180 // Disallow line merging if there is a break at the start of one of the
anatofuz
parents:
diff changeset
181 // input lines.
anatofuz
parents:
diff changeset
182 for (unsigned i = 0; i < MergedLines; ++i)
anatofuz
parents:
diff changeset
183 if (Next[i + 1]->First->NewlinesBefore > 0)
anatofuz
parents:
diff changeset
184 MergedLines = 0;
anatofuz
parents:
diff changeset
185 if (!DryRun)
anatofuz
parents:
diff changeset
186 for (unsigned i = 0; i < MergedLines; ++i)
anatofuz
parents:
diff changeset
187 join(*Next[0], *Next[i + 1]);
anatofuz
parents:
diff changeset
188 Next = Next + MergedLines + 1;
anatofuz
parents:
diff changeset
189 return Current;
anatofuz
parents:
diff changeset
190 }
anatofuz
parents:
diff changeset
191
anatofuz
parents:
diff changeset
192 private:
anatofuz
parents:
diff changeset
193 /// Calculates how many lines can be merged into 1 starting at \p I.
anatofuz
parents:
diff changeset
194 unsigned
anatofuz
parents:
diff changeset
195 tryFitMultipleLinesInOne(LevelIndentTracker &IndentTracker,
anatofuz
parents:
diff changeset
196 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
anatofuz
parents:
diff changeset
197 SmallVectorImpl<AnnotatedLine *>::const_iterator E) {
anatofuz
parents:
diff changeset
198 const unsigned Indent = IndentTracker.getIndent();
anatofuz
parents:
diff changeset
199
anatofuz
parents:
diff changeset
200 // Can't join the last line with anything.
anatofuz
parents:
diff changeset
201 if (I + 1 == E)
anatofuz
parents:
diff changeset
202 return 0;
anatofuz
parents:
diff changeset
203 // We can never merge stuff if there are trailing line comments.
anatofuz
parents:
diff changeset
204 const AnnotatedLine *TheLine = *I;
anatofuz
parents:
diff changeset
205 if (TheLine->Last->is(TT_LineComment))
anatofuz
parents:
diff changeset
206 return 0;
anatofuz
parents:
diff changeset
207 if (I[1]->Type == LT_Invalid || I[1]->First->MustBreakBefore)
anatofuz
parents:
diff changeset
208 return 0;
anatofuz
parents:
diff changeset
209 if (TheLine->InPPDirective &&
anatofuz
parents:
diff changeset
210 (!I[1]->InPPDirective || I[1]->First->HasUnescapedNewline))
anatofuz
parents:
diff changeset
211 return 0;
anatofuz
parents:
diff changeset
212
anatofuz
parents:
diff changeset
213 if (Style.ColumnLimit > 0 && Indent > Style.ColumnLimit)
anatofuz
parents:
diff changeset
214 return 0;
anatofuz
parents:
diff changeset
215
anatofuz
parents:
diff changeset
216 unsigned Limit =
anatofuz
parents:
diff changeset
217 Style.ColumnLimit == 0 ? UINT_MAX : Style.ColumnLimit - Indent;
anatofuz
parents:
diff changeset
218 // If we already exceed the column limit, we set 'Limit' to 0. The different
anatofuz
parents:
diff changeset
219 // tryMerge..() functions can then decide whether to still do merging.
anatofuz
parents:
diff changeset
220 Limit = TheLine->Last->TotalLength > Limit
anatofuz
parents:
diff changeset
221 ? 0
anatofuz
parents:
diff changeset
222 : Limit - TheLine->Last->TotalLength;
anatofuz
parents:
diff changeset
223
anatofuz
parents:
diff changeset
224 if (TheLine->Last->is(TT_FunctionLBrace) &&
anatofuz
parents:
diff changeset
225 TheLine->First == TheLine->Last &&
anatofuz
parents:
diff changeset
226 !Style.BraceWrapping.SplitEmptyFunction &&
anatofuz
parents:
diff changeset
227 I[1]->First->is(tok::r_brace))
anatofuz
parents:
diff changeset
228 return tryMergeSimpleBlock(I, E, Limit);
anatofuz
parents:
diff changeset
229
anatofuz
parents:
diff changeset
230 // Handle empty record blocks where the brace has already been wrapped
anatofuz
parents:
diff changeset
231 if (TheLine->Last->is(tok::l_brace) && TheLine->First == TheLine->Last &&
anatofuz
parents:
diff changeset
232 I != AnnotatedLines.begin()) {
anatofuz
parents:
diff changeset
233 bool EmptyBlock = I[1]->First->is(tok::r_brace);
anatofuz
parents:
diff changeset
234
anatofuz
parents:
diff changeset
235 const FormatToken *Tok = I[-1]->First;
anatofuz
parents:
diff changeset
236 if (Tok && Tok->is(tok::comment))
anatofuz
parents:
diff changeset
237 Tok = Tok->getNextNonComment();
anatofuz
parents:
diff changeset
238
anatofuz
parents:
diff changeset
239 if (Tok && Tok->getNamespaceToken())
anatofuz
parents:
diff changeset
240 return !Style.BraceWrapping.SplitEmptyNamespace && EmptyBlock
anatofuz
parents:
diff changeset
241 ? tryMergeSimpleBlock(I, E, Limit)
anatofuz
parents:
diff changeset
242 : 0;
anatofuz
parents:
diff changeset
243
anatofuz
parents:
diff changeset
244 if (Tok && Tok->is(tok::kw_typedef))
anatofuz
parents:
diff changeset
245 Tok = Tok->getNextNonComment();
anatofuz
parents:
diff changeset
246 if (Tok && Tok->isOneOf(tok::kw_class, tok::kw_struct, tok::kw_union,
anatofuz
parents:
diff changeset
247 tok::kw_extern, Keywords.kw_interface))
anatofuz
parents:
diff changeset
248 return !Style.BraceWrapping.SplitEmptyRecord && EmptyBlock
anatofuz
parents:
diff changeset
249 ? tryMergeSimpleBlock(I, E, Limit)
anatofuz
parents:
diff changeset
250 : 0;
anatofuz
parents:
diff changeset
251 }
anatofuz
parents:
diff changeset
252
anatofuz
parents:
diff changeset
253 // FIXME: TheLine->Level != 0 might or might not be the right check to do.
anatofuz
parents:
diff changeset
254 // If necessary, change to something smarter.
anatofuz
parents:
diff changeset
255 bool MergeShortFunctions =
anatofuz
parents:
diff changeset
256 Style.AllowShortFunctionsOnASingleLine == FormatStyle::SFS_All ||
anatofuz
parents:
diff changeset
257 (Style.AllowShortFunctionsOnASingleLine >= FormatStyle::SFS_Empty &&
anatofuz
parents:
diff changeset
258 I[1]->First->is(tok::r_brace)) ||
anatofuz
parents:
diff changeset
259 (Style.AllowShortFunctionsOnASingleLine & FormatStyle::SFS_InlineOnly &&
anatofuz
parents:
diff changeset
260 TheLine->Level != 0);
anatofuz
parents:
diff changeset
261
anatofuz
parents:
diff changeset
262 if (Style.CompactNamespaces) {
anatofuz
parents:
diff changeset
263 if (auto nsToken = TheLine->First->getNamespaceToken()) {
anatofuz
parents:
diff changeset
264 int i = 0;
anatofuz
parents:
diff changeset
265 unsigned closingLine = TheLine->MatchingClosingBlockLineIndex - 1;
anatofuz
parents:
diff changeset
266 for (; I + 1 + i != E &&
anatofuz
parents:
diff changeset
267 nsToken->TokenText == getNamespaceTokenText(I[i + 1]) &&
anatofuz
parents:
diff changeset
268 closingLine == I[i + 1]->MatchingClosingBlockLineIndex &&
anatofuz
parents:
diff changeset
269 I[i + 1]->Last->TotalLength < Limit;
anatofuz
parents:
diff changeset
270 i++, closingLine--) {
anatofuz
parents:
diff changeset
271 // No extra indent for compacted namespaces
anatofuz
parents:
diff changeset
272 IndentTracker.skipLine(*I[i + 1]);
anatofuz
parents:
diff changeset
273
anatofuz
parents:
diff changeset
274 Limit -= I[i + 1]->Last->TotalLength;
anatofuz
parents:
diff changeset
275 }
anatofuz
parents:
diff changeset
276 return i;
anatofuz
parents:
diff changeset
277 }
anatofuz
parents:
diff changeset
278
anatofuz
parents:
diff changeset
279 if (auto nsToken = getMatchingNamespaceToken(TheLine, AnnotatedLines)) {
anatofuz
parents:
diff changeset
280 int i = 0;
anatofuz
parents:
diff changeset
281 unsigned openingLine = TheLine->MatchingOpeningBlockLineIndex - 1;
anatofuz
parents:
diff changeset
282 for (; I + 1 + i != E &&
anatofuz
parents:
diff changeset
283 nsToken->TokenText ==
anatofuz
parents:
diff changeset
284 getMatchingNamespaceTokenText(I[i + 1], AnnotatedLines) &&
anatofuz
parents:
diff changeset
285 openingLine == I[i + 1]->MatchingOpeningBlockLineIndex;
anatofuz
parents:
diff changeset
286 i++, openingLine--) {
anatofuz
parents:
diff changeset
287 // No space between consecutive braces
anatofuz
parents:
diff changeset
288 I[i + 1]->First->SpacesRequiredBefore = !I[i]->Last->is(tok::r_brace);
anatofuz
parents:
diff changeset
289
anatofuz
parents:
diff changeset
290 // Indent like the outer-most namespace
anatofuz
parents:
diff changeset
291 IndentTracker.nextLine(*I[i + 1]);
anatofuz
parents:
diff changeset
292 }
anatofuz
parents:
diff changeset
293 return i;
anatofuz
parents:
diff changeset
294 }
anatofuz
parents:
diff changeset
295 }
anatofuz
parents:
diff changeset
296
anatofuz
parents:
diff changeset
297 // Try to merge a function block with left brace unwrapped
anatofuz
parents:
diff changeset
298 if (TheLine->Last->is(TT_FunctionLBrace) &&
anatofuz
parents:
diff changeset
299 TheLine->First != TheLine->Last) {
anatofuz
parents:
diff changeset
300 return MergeShortFunctions ? tryMergeSimpleBlock(I, E, Limit) : 0;
anatofuz
parents:
diff changeset
301 }
anatofuz
parents:
diff changeset
302 // Try to merge a control statement block with left brace unwrapped
anatofuz
parents:
diff changeset
303 if (TheLine->Last->is(tok::l_brace) && TheLine->First != TheLine->Last &&
anatofuz
parents:
diff changeset
304 TheLine->First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_for)) {
anatofuz
parents:
diff changeset
305 return Style.AllowShortBlocksOnASingleLine != FormatStyle::SBS_Never
anatofuz
parents:
diff changeset
306 ? tryMergeSimpleBlock(I, E, Limit)
anatofuz
parents:
diff changeset
307 : 0;
anatofuz
parents:
diff changeset
308 }
anatofuz
parents:
diff changeset
309 // Try to merge a control statement block with left brace wrapped
anatofuz
parents:
diff changeset
310 if (I[1]->First->is(tok::l_brace) &&
anatofuz
parents:
diff changeset
311 (TheLine->First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_for,
anatofuz
parents:
diff changeset
312 tok::kw_switch, tok::kw_try, tok::kw_do) ||
anatofuz
parents:
diff changeset
313 (TheLine->First->is(tok::r_brace) && TheLine->First->Next &&
anatofuz
parents:
diff changeset
314 TheLine->First->Next->isOneOf(tok::kw_else, tok::kw_catch))) &&
anatofuz
parents:
diff changeset
315 Style.BraceWrapping.AfterControlStatement ==
anatofuz
parents:
diff changeset
316 FormatStyle::BWACS_MultiLine) {
anatofuz
parents:
diff changeset
317 // If possible, merge the next line's wrapped left brace with the current
anatofuz
parents:
diff changeset
318 // line. Otherwise, leave it on the next line, as this is a multi-line
anatofuz
parents:
diff changeset
319 // control statement.
anatofuz
parents:
diff changeset
320 return (Style.ColumnLimit == 0 ||
anatofuz
parents:
diff changeset
321 TheLine->Last->TotalLength <= Style.ColumnLimit)
anatofuz
parents:
diff changeset
322 ? 1
anatofuz
parents:
diff changeset
323 : 0;
anatofuz
parents:
diff changeset
324 } else if (I[1]->First->is(tok::l_brace) &&
anatofuz
parents:
diff changeset
325 TheLine->First->isOneOf(tok::kw_if, tok::kw_while,
anatofuz
parents:
diff changeset
326 tok::kw_for)) {
anatofuz
parents:
diff changeset
327 return (Style.BraceWrapping.AfterControlStatement ==
anatofuz
parents:
diff changeset
328 FormatStyle::BWACS_Always)
anatofuz
parents:
diff changeset
329 ? tryMergeSimpleBlock(I, E, Limit)
anatofuz
parents:
diff changeset
330 : 0;
anatofuz
parents:
diff changeset
331 } else if (I[1]->First->is(tok::l_brace) &&
anatofuz
parents:
diff changeset
332 TheLine->First->isOneOf(tok::kw_else, tok::kw_catch) &&
anatofuz
parents:
diff changeset
333 Style.BraceWrapping.AfterControlStatement ==
anatofuz
parents:
diff changeset
334 FormatStyle::BWACS_MultiLine) {
anatofuz
parents:
diff changeset
335 // This case if different from the upper BWACS_MultiLine processing
anatofuz
parents:
diff changeset
336 // in that a preceding r_brace is not on the same line as else/catch
anatofuz
parents:
diff changeset
337 // most likely because of BeforeElse/BeforeCatch set to true.
anatofuz
parents:
diff changeset
338 // If the line length doesn't fit ColumnLimit, leave l_brace on the
anatofuz
parents:
diff changeset
339 // next line to respect the BWACS_MultiLine.
anatofuz
parents:
diff changeset
340 return (Style.ColumnLimit == 0 ||
anatofuz
parents:
diff changeset
341 TheLine->Last->TotalLength <= Style.ColumnLimit)
anatofuz
parents:
diff changeset
342 ? 1
anatofuz
parents:
diff changeset
343 : 0;
anatofuz
parents:
diff changeset
344 }
anatofuz
parents:
diff changeset
345 // Try to merge either empty or one-line block if is precedeed by control
anatofuz
parents:
diff changeset
346 // statement token
anatofuz
parents:
diff changeset
347 if (TheLine->First->is(tok::l_brace) && TheLine->First == TheLine->Last &&
anatofuz
parents:
diff changeset
348 I != AnnotatedLines.begin() &&
anatofuz
parents:
diff changeset
349 I[-1]->First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_for)) {
anatofuz
parents:
diff changeset
350 unsigned MergedLines = 0;
anatofuz
parents:
diff changeset
351 if (Style.AllowShortBlocksOnASingleLine != FormatStyle::SBS_Never) {
anatofuz
parents:
diff changeset
352 MergedLines = tryMergeSimpleBlock(I - 1, E, Limit);
anatofuz
parents:
diff changeset
353 // If we managed to merge the block, discard the first merged line
anatofuz
parents:
diff changeset
354 // since we are merging starting from I.
anatofuz
parents:
diff changeset
355 if (MergedLines > 0)
anatofuz
parents:
diff changeset
356 --MergedLines;
anatofuz
parents:
diff changeset
357 }
anatofuz
parents:
diff changeset
358 return MergedLines;
anatofuz
parents:
diff changeset
359 }
anatofuz
parents:
diff changeset
360 // Don't merge block with left brace wrapped after ObjC special blocks
anatofuz
parents:
diff changeset
361 if (TheLine->First->is(tok::l_brace) && I != AnnotatedLines.begin() &&
anatofuz
parents:
diff changeset
362 I[-1]->First->is(tok::at) && I[-1]->First->Next) {
anatofuz
parents:
diff changeset
363 tok::ObjCKeywordKind kwId = I[-1]->First->Next->Tok.getObjCKeywordID();
anatofuz
parents:
diff changeset
364 if (kwId == clang::tok::objc_autoreleasepool ||
anatofuz
parents:
diff changeset
365 kwId == clang::tok::objc_synchronized)
anatofuz
parents:
diff changeset
366 return 0;
anatofuz
parents:
diff changeset
367 }
anatofuz
parents:
diff changeset
368 // Don't merge block with left brace wrapped after case labels
anatofuz
parents:
diff changeset
369 if (TheLine->First->is(tok::l_brace) && I != AnnotatedLines.begin() &&
anatofuz
parents:
diff changeset
370 I[-1]->First->isOneOf(tok::kw_case, tok::kw_default))
anatofuz
parents:
diff changeset
371 return 0;
anatofuz
parents:
diff changeset
372 // Try to merge a block with left brace wrapped that wasn't yet covered
anatofuz
parents:
diff changeset
373 if (TheLine->Last->is(tok::l_brace)) {
anatofuz
parents:
diff changeset
374 return !Style.BraceWrapping.AfterFunction ||
anatofuz
parents:
diff changeset
375 (I[1]->First->is(tok::r_brace) &&
anatofuz
parents:
diff changeset
376 !Style.BraceWrapping.SplitEmptyRecord)
anatofuz
parents:
diff changeset
377 ? tryMergeSimpleBlock(I, E, Limit)
anatofuz
parents:
diff changeset
378 : 0;
anatofuz
parents:
diff changeset
379 }
anatofuz
parents:
diff changeset
380 // Try to merge a function block with left brace wrapped
anatofuz
parents:
diff changeset
381 if (I[1]->First->is(TT_FunctionLBrace) &&
anatofuz
parents:
diff changeset
382 Style.BraceWrapping.AfterFunction) {
anatofuz
parents:
diff changeset
383 if (I[1]->Last->is(TT_LineComment))
anatofuz
parents:
diff changeset
384 return 0;
anatofuz
parents:
diff changeset
385
anatofuz
parents:
diff changeset
386 // Check for Limit <= 2 to account for the " {".
anatofuz
parents:
diff changeset
387 if (Limit <= 2 || (Style.ColumnLimit == 0 && containsMustBreak(TheLine)))
anatofuz
parents:
diff changeset
388 return 0;
anatofuz
parents:
diff changeset
389 Limit -= 2;
anatofuz
parents:
diff changeset
390
anatofuz
parents:
diff changeset
391 unsigned MergedLines = 0;
anatofuz
parents:
diff changeset
392 if (MergeShortFunctions ||
anatofuz
parents:
diff changeset
393 (Style.AllowShortFunctionsOnASingleLine >= FormatStyle::SFS_Empty &&
anatofuz
parents:
diff changeset
394 I[1]->First == I[1]->Last && I + 2 != E &&
anatofuz
parents:
diff changeset
395 I[2]->First->is(tok::r_brace))) {
anatofuz
parents:
diff changeset
396 MergedLines = tryMergeSimpleBlock(I + 1, E, Limit);
anatofuz
parents:
diff changeset
397 // If we managed to merge the block, count the function header, which is
anatofuz
parents:
diff changeset
398 // on a separate line.
anatofuz
parents:
diff changeset
399 if (MergedLines > 0)
anatofuz
parents:
diff changeset
400 ++MergedLines;
anatofuz
parents:
diff changeset
401 }
anatofuz
parents:
diff changeset
402 return MergedLines;
anatofuz
parents:
diff changeset
403 }
anatofuz
parents:
diff changeset
404 if (TheLine->First->is(tok::kw_if)) {
anatofuz
parents:
diff changeset
405 return Style.AllowShortIfStatementsOnASingleLine
anatofuz
parents:
diff changeset
406 ? tryMergeSimpleControlStatement(I, E, Limit)
anatofuz
parents:
diff changeset
407 : 0;
anatofuz
parents:
diff changeset
408 }
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
409 if (TheLine->First->isOneOf(tok::kw_for, tok::kw_while, tok::kw_do)) {
150
anatofuz
parents:
diff changeset
410 return Style.AllowShortLoopsOnASingleLine
anatofuz
parents:
diff changeset
411 ? tryMergeSimpleControlStatement(I, E, Limit)
anatofuz
parents:
diff changeset
412 : 0;
anatofuz
parents:
diff changeset
413 }
anatofuz
parents:
diff changeset
414 if (TheLine->First->isOneOf(tok::kw_case, tok::kw_default)) {
anatofuz
parents:
diff changeset
415 return Style.AllowShortCaseLabelsOnASingleLine
anatofuz
parents:
diff changeset
416 ? tryMergeShortCaseLabels(I, E, Limit)
anatofuz
parents:
diff changeset
417 : 0;
anatofuz
parents:
diff changeset
418 }
anatofuz
parents:
diff changeset
419 if (TheLine->InPPDirective &&
anatofuz
parents:
diff changeset
420 (TheLine->First->HasUnescapedNewline || TheLine->First->IsFirst)) {
anatofuz
parents:
diff changeset
421 return tryMergeSimplePPDirective(I, E, Limit);
anatofuz
parents:
diff changeset
422 }
anatofuz
parents:
diff changeset
423 return 0;
anatofuz
parents:
diff changeset
424 }
anatofuz
parents:
diff changeset
425
anatofuz
parents:
diff changeset
426 unsigned
anatofuz
parents:
diff changeset
427 tryMergeSimplePPDirective(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
anatofuz
parents:
diff changeset
428 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
anatofuz
parents:
diff changeset
429 unsigned Limit) {
anatofuz
parents:
diff changeset
430 if (Limit == 0)
anatofuz
parents:
diff changeset
431 return 0;
anatofuz
parents:
diff changeset
432 if (I + 2 != E && I[2]->InPPDirective && !I[2]->First->HasUnescapedNewline)
anatofuz
parents:
diff changeset
433 return 0;
anatofuz
parents:
diff changeset
434 if (1 + I[1]->Last->TotalLength > Limit)
anatofuz
parents:
diff changeset
435 return 0;
anatofuz
parents:
diff changeset
436 return 1;
anatofuz
parents:
diff changeset
437 }
anatofuz
parents:
diff changeset
438
anatofuz
parents:
diff changeset
439 unsigned tryMergeSimpleControlStatement(
anatofuz
parents:
diff changeset
440 SmallVectorImpl<AnnotatedLine *>::const_iterator I,
anatofuz
parents:
diff changeset
441 SmallVectorImpl<AnnotatedLine *>::const_iterator E, unsigned Limit) {
anatofuz
parents:
diff changeset
442 if (Limit == 0)
anatofuz
parents:
diff changeset
443 return 0;
anatofuz
parents:
diff changeset
444 if (Style.BraceWrapping.AfterControlStatement ==
anatofuz
parents:
diff changeset
445 FormatStyle::BWACS_Always &&
anatofuz
parents:
diff changeset
446 I[1]->First->is(tok::l_brace) &&
anatofuz
parents:
diff changeset
447 Style.AllowShortBlocksOnASingleLine == FormatStyle::SBS_Never)
anatofuz
parents:
diff changeset
448 return 0;
anatofuz
parents:
diff changeset
449 if (I[1]->InPPDirective != (*I)->InPPDirective ||
anatofuz
parents:
diff changeset
450 (I[1]->InPPDirective && I[1]->First->HasUnescapedNewline))
anatofuz
parents:
diff changeset
451 return 0;
anatofuz
parents:
diff changeset
452 Limit = limitConsideringMacros(I + 1, E, Limit);
anatofuz
parents:
diff changeset
453 AnnotatedLine &Line = **I;
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
454 if (!Line.First->is(tok::kw_do) && Line.Last->isNot(tok::r_paren))
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
455 return 0;
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
456 // Only merge do while if do is the only statement on the line.
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
457 if (Line.First->is(tok::kw_do) && !Line.Last->is(tok::kw_do))
150
anatofuz
parents:
diff changeset
458 return 0;
anatofuz
parents:
diff changeset
459 if (1 + I[1]->Last->TotalLength > Limit)
anatofuz
parents:
diff changeset
460 return 0;
anatofuz
parents:
diff changeset
461 if (I[1]->First->isOneOf(tok::semi, tok::kw_if, tok::kw_for, tok::kw_while,
anatofuz
parents:
diff changeset
462 TT_LineComment))
anatofuz
parents:
diff changeset
463 return 0;
anatofuz
parents:
diff changeset
464 // Only inline simple if's (no nested if or else), unless specified
anatofuz
parents:
diff changeset
465 if (Style.AllowShortIfStatementsOnASingleLine != FormatStyle::SIS_Always) {
anatofuz
parents:
diff changeset
466 if (I + 2 != E && Line.startsWith(tok::kw_if) &&
anatofuz
parents:
diff changeset
467 I[2]->First->is(tok::kw_else))
anatofuz
parents:
diff changeset
468 return 0;
anatofuz
parents:
diff changeset
469 }
anatofuz
parents:
diff changeset
470 return 1;
anatofuz
parents:
diff changeset
471 }
anatofuz
parents:
diff changeset
472
anatofuz
parents:
diff changeset
473 unsigned
anatofuz
parents:
diff changeset
474 tryMergeShortCaseLabels(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
anatofuz
parents:
diff changeset
475 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
anatofuz
parents:
diff changeset
476 unsigned Limit) {
anatofuz
parents:
diff changeset
477 if (Limit == 0 || I + 1 == E ||
anatofuz
parents:
diff changeset
478 I[1]->First->isOneOf(tok::kw_case, tok::kw_default))
anatofuz
parents:
diff changeset
479 return 0;
anatofuz
parents:
diff changeset
480 if (I[0]->Last->is(tok::l_brace) || I[1]->First->is(tok::l_brace))
anatofuz
parents:
diff changeset
481 return 0;
anatofuz
parents:
diff changeset
482 unsigned NumStmts = 0;
anatofuz
parents:
diff changeset
483 unsigned Length = 0;
anatofuz
parents:
diff changeset
484 bool EndsWithComment = false;
anatofuz
parents:
diff changeset
485 bool InPPDirective = I[0]->InPPDirective;
anatofuz
parents:
diff changeset
486 const unsigned Level = I[0]->Level;
anatofuz
parents:
diff changeset
487 for (; NumStmts < 3; ++NumStmts) {
anatofuz
parents:
diff changeset
488 if (I + 1 + NumStmts == E)
anatofuz
parents:
diff changeset
489 break;
anatofuz
parents:
diff changeset
490 const AnnotatedLine *Line = I[1 + NumStmts];
anatofuz
parents:
diff changeset
491 if (Line->InPPDirective != InPPDirective)
anatofuz
parents:
diff changeset
492 break;
anatofuz
parents:
diff changeset
493 if (Line->First->isOneOf(tok::kw_case, tok::kw_default, tok::r_brace))
anatofuz
parents:
diff changeset
494 break;
anatofuz
parents:
diff changeset
495 if (Line->First->isOneOf(tok::kw_if, tok::kw_for, tok::kw_switch,
anatofuz
parents:
diff changeset
496 tok::kw_while) ||
anatofuz
parents:
diff changeset
497 EndsWithComment)
anatofuz
parents:
diff changeset
498 return 0;
anatofuz
parents:
diff changeset
499 if (Line->First->is(tok::comment)) {
anatofuz
parents:
diff changeset
500 if (Level != Line->Level)
anatofuz
parents:
diff changeset
501 return 0;
anatofuz
parents:
diff changeset
502 SmallVectorImpl<AnnotatedLine *>::const_iterator J = I + 2 + NumStmts;
anatofuz
parents:
diff changeset
503 for (; J != E; ++J) {
anatofuz
parents:
diff changeset
504 Line = *J;
anatofuz
parents:
diff changeset
505 if (Line->InPPDirective != InPPDirective)
anatofuz
parents:
diff changeset
506 break;
anatofuz
parents:
diff changeset
507 if (Line->First->isOneOf(tok::kw_case, tok::kw_default, tok::r_brace))
anatofuz
parents:
diff changeset
508 break;
anatofuz
parents:
diff changeset
509 if (Line->First->isNot(tok::comment) || Level != Line->Level)
anatofuz
parents:
diff changeset
510 return 0;
anatofuz
parents:
diff changeset
511 }
anatofuz
parents:
diff changeset
512 break;
anatofuz
parents:
diff changeset
513 }
anatofuz
parents:
diff changeset
514 if (Line->Last->is(tok::comment))
anatofuz
parents:
diff changeset
515 EndsWithComment = true;
anatofuz
parents:
diff changeset
516 Length += I[1 + NumStmts]->Last->TotalLength + 1; // 1 for the space.
anatofuz
parents:
diff changeset
517 }
anatofuz
parents:
diff changeset
518 if (NumStmts == 0 || NumStmts == 3 || Length > Limit)
anatofuz
parents:
diff changeset
519 return 0;
anatofuz
parents:
diff changeset
520 return NumStmts;
anatofuz
parents:
diff changeset
521 }
anatofuz
parents:
diff changeset
522
anatofuz
parents:
diff changeset
523 unsigned
anatofuz
parents:
diff changeset
524 tryMergeSimpleBlock(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
anatofuz
parents:
diff changeset
525 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
anatofuz
parents:
diff changeset
526 unsigned Limit) {
anatofuz
parents:
diff changeset
527 AnnotatedLine &Line = **I;
anatofuz
parents:
diff changeset
528
anatofuz
parents:
diff changeset
529 // Don't merge ObjC @ keywords and methods.
anatofuz
parents:
diff changeset
530 // FIXME: If an option to allow short exception handling clauses on a single
anatofuz
parents:
diff changeset
531 // line is added, change this to not return for @try and friends.
anatofuz
parents:
diff changeset
532 if (Style.Language != FormatStyle::LK_Java &&
anatofuz
parents:
diff changeset
533 Line.First->isOneOf(tok::at, tok::minus, tok::plus))
anatofuz
parents:
diff changeset
534 return 0;
anatofuz
parents:
diff changeset
535
anatofuz
parents:
diff changeset
536 // Check that the current line allows merging. This depends on whether we
anatofuz
parents:
diff changeset
537 // are in a control flow statements as well as several style flags.
anatofuz
parents:
diff changeset
538 if (Line.First->isOneOf(tok::kw_else, tok::kw_case) ||
anatofuz
parents:
diff changeset
539 (Line.First->Next && Line.First->Next->is(tok::kw_else)))
anatofuz
parents:
diff changeset
540 return 0;
anatofuz
parents:
diff changeset
541 // default: in switch statement
anatofuz
parents:
diff changeset
542 if (Line.First->is(tok::kw_default)) {
anatofuz
parents:
diff changeset
543 const FormatToken *Tok = Line.First->getNextNonComment();
anatofuz
parents:
diff changeset
544 if (Tok && Tok->is(tok::colon))
anatofuz
parents:
diff changeset
545 return 0;
anatofuz
parents:
diff changeset
546 }
anatofuz
parents:
diff changeset
547 if (Line.First->isOneOf(tok::kw_if, tok::kw_while, tok::kw_do, tok::kw_try,
anatofuz
parents:
diff changeset
548 tok::kw___try, tok::kw_catch, tok::kw___finally,
anatofuz
parents:
diff changeset
549 tok::kw_for, tok::r_brace, Keywords.kw___except)) {
anatofuz
parents:
diff changeset
550 if (Style.AllowShortBlocksOnASingleLine == FormatStyle::SBS_Never)
anatofuz
parents:
diff changeset
551 return 0;
anatofuz
parents:
diff changeset
552 // Don't merge when we can't except the case when
anatofuz
parents:
diff changeset
553 // the control statement block is empty
anatofuz
parents:
diff changeset
554 if (!Style.AllowShortIfStatementsOnASingleLine &&
anatofuz
parents:
diff changeset
555 Line.startsWith(tok::kw_if) &&
anatofuz
parents:
diff changeset
556 !Style.BraceWrapping.AfterControlStatement &&
anatofuz
parents:
diff changeset
557 !I[1]->First->is(tok::r_brace))
anatofuz
parents:
diff changeset
558 return 0;
anatofuz
parents:
diff changeset
559 if (!Style.AllowShortIfStatementsOnASingleLine &&
anatofuz
parents:
diff changeset
560 Line.startsWith(tok::kw_if) &&
anatofuz
parents:
diff changeset
561 Style.BraceWrapping.AfterControlStatement ==
anatofuz
parents:
diff changeset
562 FormatStyle::BWACS_Always &&
anatofuz
parents:
diff changeset
563 I + 2 != E && !I[2]->First->is(tok::r_brace))
anatofuz
parents:
diff changeset
564 return 0;
anatofuz
parents:
diff changeset
565 if (!Style.AllowShortLoopsOnASingleLine &&
anatofuz
parents:
diff changeset
566 Line.First->isOneOf(tok::kw_while, tok::kw_do, tok::kw_for) &&
anatofuz
parents:
diff changeset
567 !Style.BraceWrapping.AfterControlStatement &&
anatofuz
parents:
diff changeset
568 !I[1]->First->is(tok::r_brace))
anatofuz
parents:
diff changeset
569 return 0;
anatofuz
parents:
diff changeset
570 if (!Style.AllowShortLoopsOnASingleLine &&
anatofuz
parents:
diff changeset
571 Line.First->isOneOf(tok::kw_while, tok::kw_do, tok::kw_for) &&
anatofuz
parents:
diff changeset
572 Style.BraceWrapping.AfterControlStatement ==
anatofuz
parents:
diff changeset
573 FormatStyle::BWACS_Always &&
anatofuz
parents:
diff changeset
574 I + 2 != E && !I[2]->First->is(tok::r_brace))
anatofuz
parents:
diff changeset
575 return 0;
anatofuz
parents:
diff changeset
576 // FIXME: Consider an option to allow short exception handling clauses on
anatofuz
parents:
diff changeset
577 // a single line.
anatofuz
parents:
diff changeset
578 // FIXME: This isn't covered by tests.
anatofuz
parents:
diff changeset
579 // FIXME: For catch, __except, __finally the first token on the line
anatofuz
parents:
diff changeset
580 // is '}', so this isn't correct here.
anatofuz
parents:
diff changeset
581 if (Line.First->isOneOf(tok::kw_try, tok::kw___try, tok::kw_catch,
anatofuz
parents:
diff changeset
582 Keywords.kw___except, tok::kw___finally))
anatofuz
parents:
diff changeset
583 return 0;
anatofuz
parents:
diff changeset
584 }
anatofuz
parents:
diff changeset
585
anatofuz
parents:
diff changeset
586 if (Line.Last->is(tok::l_brace)) {
anatofuz
parents:
diff changeset
587 FormatToken *Tok = I[1]->First;
anatofuz
parents:
diff changeset
588 if (Tok->is(tok::r_brace) && !Tok->MustBreakBefore &&
anatofuz
parents:
diff changeset
589 (Tok->getNextNonComment() == nullptr ||
anatofuz
parents:
diff changeset
590 Tok->getNextNonComment()->is(tok::semi))) {
anatofuz
parents:
diff changeset
591 // We merge empty blocks even if the line exceeds the column limit.
anatofuz
parents:
diff changeset
592 Tok->SpacesRequiredBefore = Style.SpaceInEmptyBlock ? 1 : 0;
anatofuz
parents:
diff changeset
593 Tok->CanBreakBefore = true;
anatofuz
parents:
diff changeset
594 return 1;
anatofuz
parents:
diff changeset
595 } else if (Limit != 0 && !Line.startsWithNamespace() &&
anatofuz
parents:
diff changeset
596 !startsExternCBlock(Line)) {
anatofuz
parents:
diff changeset
597 // We don't merge short records.
anatofuz
parents:
diff changeset
598 FormatToken *RecordTok = Line.First;
anatofuz
parents:
diff changeset
599 // Skip record modifiers.
anatofuz
parents:
diff changeset
600 while (RecordTok->Next &&
anatofuz
parents:
diff changeset
601 RecordTok->isOneOf(
anatofuz
parents:
diff changeset
602 tok::kw_typedef, tok::kw_export, Keywords.kw_declare,
anatofuz
parents:
diff changeset
603 Keywords.kw_abstract, tok::kw_default, tok::kw_public,
anatofuz
parents:
diff changeset
604 tok::kw_private, tok::kw_protected, Keywords.kw_internal))
anatofuz
parents:
diff changeset
605 RecordTok = RecordTok->Next;
anatofuz
parents:
diff changeset
606 if (RecordTok &&
anatofuz
parents:
diff changeset
607 RecordTok->isOneOf(tok::kw_class, tok::kw_union, tok::kw_struct,
anatofuz
parents:
diff changeset
608 Keywords.kw_interface))
anatofuz
parents:
diff changeset
609 return 0;
anatofuz
parents:
diff changeset
610
anatofuz
parents:
diff changeset
611 // Check that we still have three lines and they fit into the limit.
anatofuz
parents:
diff changeset
612 if (I + 2 == E || I[2]->Type == LT_Invalid)
anatofuz
parents:
diff changeset
613 return 0;
anatofuz
parents:
diff changeset
614 Limit = limitConsideringMacros(I + 2, E, Limit);
anatofuz
parents:
diff changeset
615
anatofuz
parents:
diff changeset
616 if (!nextTwoLinesFitInto(I, Limit))
anatofuz
parents:
diff changeset
617 return 0;
anatofuz
parents:
diff changeset
618
anatofuz
parents:
diff changeset
619 // Second, check that the next line does not contain any braces - if it
anatofuz
parents:
diff changeset
620 // does, readability declines when putting it into a single line.
anatofuz
parents:
diff changeset
621 if (I[1]->Last->is(TT_LineComment))
anatofuz
parents:
diff changeset
622 return 0;
anatofuz
parents:
diff changeset
623 do {
anatofuz
parents:
diff changeset
624 if (Tok->is(tok::l_brace) && Tok->BlockKind != BK_BracedInit)
anatofuz
parents:
diff changeset
625 return 0;
anatofuz
parents:
diff changeset
626 Tok = Tok->Next;
anatofuz
parents:
diff changeset
627 } while (Tok);
anatofuz
parents:
diff changeset
628
anatofuz
parents:
diff changeset
629 // Last, check that the third line starts with a closing brace.
anatofuz
parents:
diff changeset
630 Tok = I[2]->First;
anatofuz
parents:
diff changeset
631 if (Tok->isNot(tok::r_brace))
anatofuz
parents:
diff changeset
632 return 0;
anatofuz
parents:
diff changeset
633
anatofuz
parents:
diff changeset
634 // Don't merge "if (a) { .. } else {".
anatofuz
parents:
diff changeset
635 if (Tok->Next && Tok->Next->is(tok::kw_else))
anatofuz
parents:
diff changeset
636 return 0;
anatofuz
parents:
diff changeset
637
anatofuz
parents:
diff changeset
638 // Don't merge a trailing multi-line control statement block like:
anatofuz
parents:
diff changeset
639 // } else if (foo &&
anatofuz
parents:
diff changeset
640 // bar)
anatofuz
parents:
diff changeset
641 // { <-- current Line
anatofuz
parents:
diff changeset
642 // baz();
anatofuz
parents:
diff changeset
643 // }
anatofuz
parents:
diff changeset
644 if (Line.First == Line.Last &&
anatofuz
parents:
diff changeset
645 Style.BraceWrapping.AfterControlStatement ==
anatofuz
parents:
diff changeset
646 FormatStyle::BWACS_MultiLine)
anatofuz
parents:
diff changeset
647 return 0;
anatofuz
parents:
diff changeset
648
anatofuz
parents:
diff changeset
649 return 2;
anatofuz
parents:
diff changeset
650 }
anatofuz
parents:
diff changeset
651 } else if (I[1]->First->is(tok::l_brace)) {
anatofuz
parents:
diff changeset
652 if (I[1]->Last->is(TT_LineComment))
anatofuz
parents:
diff changeset
653 return 0;
anatofuz
parents:
diff changeset
654
anatofuz
parents:
diff changeset
655 // Check for Limit <= 2 to account for the " {".
anatofuz
parents:
diff changeset
656 if (Limit <= 2 || (Style.ColumnLimit == 0 && containsMustBreak(*I)))
anatofuz
parents:
diff changeset
657 return 0;
anatofuz
parents:
diff changeset
658 Limit -= 2;
anatofuz
parents:
diff changeset
659 unsigned MergedLines = 0;
anatofuz
parents:
diff changeset
660 if (Style.AllowShortBlocksOnASingleLine != FormatStyle::SBS_Never ||
anatofuz
parents:
diff changeset
661 (I[1]->First == I[1]->Last && I + 2 != E &&
anatofuz
parents:
diff changeset
662 I[2]->First->is(tok::r_brace))) {
anatofuz
parents:
diff changeset
663 MergedLines = tryMergeSimpleBlock(I + 1, E, Limit);
anatofuz
parents:
diff changeset
664 // If we managed to merge the block, count the statement header, which
anatofuz
parents:
diff changeset
665 // is on a separate line.
anatofuz
parents:
diff changeset
666 if (MergedLines > 0)
anatofuz
parents:
diff changeset
667 ++MergedLines;
anatofuz
parents:
diff changeset
668 }
anatofuz
parents:
diff changeset
669 return MergedLines;
anatofuz
parents:
diff changeset
670 }
anatofuz
parents:
diff changeset
671 return 0;
anatofuz
parents:
diff changeset
672 }
anatofuz
parents:
diff changeset
673
anatofuz
parents:
diff changeset
674 /// Returns the modified column limit for \p I if it is inside a macro and
anatofuz
parents:
diff changeset
675 /// needs a trailing '\'.
anatofuz
parents:
diff changeset
676 unsigned
anatofuz
parents:
diff changeset
677 limitConsideringMacros(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
anatofuz
parents:
diff changeset
678 SmallVectorImpl<AnnotatedLine *>::const_iterator E,
anatofuz
parents:
diff changeset
679 unsigned Limit) {
anatofuz
parents:
diff changeset
680 if (I[0]->InPPDirective && I + 1 != E &&
anatofuz
parents:
diff changeset
681 !I[1]->First->HasUnescapedNewline && !I[1]->First->is(tok::eof)) {
anatofuz
parents:
diff changeset
682 return Limit < 2 ? 0 : Limit - 2;
anatofuz
parents:
diff changeset
683 }
anatofuz
parents:
diff changeset
684 return Limit;
anatofuz
parents:
diff changeset
685 }
anatofuz
parents:
diff changeset
686
anatofuz
parents:
diff changeset
687 bool nextTwoLinesFitInto(SmallVectorImpl<AnnotatedLine *>::const_iterator I,
anatofuz
parents:
diff changeset
688 unsigned Limit) {
anatofuz
parents:
diff changeset
689 if (I[1]->First->MustBreakBefore || I[2]->First->MustBreakBefore)
anatofuz
parents:
diff changeset
690 return false;
anatofuz
parents:
diff changeset
691 return 1 + I[1]->Last->TotalLength + 1 + I[2]->Last->TotalLength <= Limit;
anatofuz
parents:
diff changeset
692 }
anatofuz
parents:
diff changeset
693
anatofuz
parents:
diff changeset
694 bool containsMustBreak(const AnnotatedLine *Line) {
anatofuz
parents:
diff changeset
695 for (const FormatToken *Tok = Line->First; Tok; Tok = Tok->Next) {
anatofuz
parents:
diff changeset
696 if (Tok->MustBreakBefore)
anatofuz
parents:
diff changeset
697 return true;
anatofuz
parents:
diff changeset
698 }
anatofuz
parents:
diff changeset
699 return false;
anatofuz
parents:
diff changeset
700 }
anatofuz
parents:
diff changeset
701
anatofuz
parents:
diff changeset
702 void join(AnnotatedLine &A, const AnnotatedLine &B) {
anatofuz
parents:
diff changeset
703 assert(!A.Last->Next);
anatofuz
parents:
diff changeset
704 assert(!B.First->Previous);
anatofuz
parents:
diff changeset
705 if (B.Affected)
anatofuz
parents:
diff changeset
706 A.Affected = true;
anatofuz
parents:
diff changeset
707 A.Last->Next = B.First;
anatofuz
parents:
diff changeset
708 B.First->Previous = A.Last;
anatofuz
parents:
diff changeset
709 B.First->CanBreakBefore = true;
anatofuz
parents:
diff changeset
710 unsigned LengthA = A.Last->TotalLength + B.First->SpacesRequiredBefore;
anatofuz
parents:
diff changeset
711 for (FormatToken *Tok = B.First; Tok; Tok = Tok->Next) {
anatofuz
parents:
diff changeset
712 Tok->TotalLength += LengthA;
anatofuz
parents:
diff changeset
713 A.Last = Tok;
anatofuz
parents:
diff changeset
714 }
anatofuz
parents:
diff changeset
715 }
anatofuz
parents:
diff changeset
716
anatofuz
parents:
diff changeset
717 const FormatStyle &Style;
anatofuz
parents:
diff changeset
718 const AdditionalKeywords &Keywords;
anatofuz
parents:
diff changeset
719 const SmallVectorImpl<AnnotatedLine *>::const_iterator End;
anatofuz
parents:
diff changeset
720
anatofuz
parents:
diff changeset
721 SmallVectorImpl<AnnotatedLine *>::const_iterator Next;
anatofuz
parents:
diff changeset
722 const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines;
anatofuz
parents:
diff changeset
723 };
anatofuz
parents:
diff changeset
724
anatofuz
parents:
diff changeset
725 static void markFinalized(FormatToken *Tok) {
anatofuz
parents:
diff changeset
726 for (; Tok; Tok = Tok->Next) {
anatofuz
parents:
diff changeset
727 Tok->Finalized = true;
anatofuz
parents:
diff changeset
728 for (AnnotatedLine *Child : Tok->Children)
anatofuz
parents:
diff changeset
729 markFinalized(Child->First);
anatofuz
parents:
diff changeset
730 }
anatofuz
parents:
diff changeset
731 }
anatofuz
parents:
diff changeset
732
anatofuz
parents:
diff changeset
733 #ifndef NDEBUG
anatofuz
parents:
diff changeset
734 static void printLineState(const LineState &State) {
anatofuz
parents:
diff changeset
735 llvm::dbgs() << "State: ";
anatofuz
parents:
diff changeset
736 for (const ParenState &P : State.Stack) {
anatofuz
parents:
diff changeset
737 llvm::dbgs() << (P.Tok ? P.Tok->TokenText : "F") << "|" << P.Indent << "|"
anatofuz
parents:
diff changeset
738 << P.LastSpace << "|" << P.NestedBlockIndent << " ";
anatofuz
parents:
diff changeset
739 }
anatofuz
parents:
diff changeset
740 llvm::dbgs() << State.NextToken->TokenText << "\n";
anatofuz
parents:
diff changeset
741 }
anatofuz
parents:
diff changeset
742 #endif
anatofuz
parents:
diff changeset
743
anatofuz
parents:
diff changeset
744 /// Base class for classes that format one \c AnnotatedLine.
anatofuz
parents:
diff changeset
745 class LineFormatter {
anatofuz
parents:
diff changeset
746 public:
anatofuz
parents:
diff changeset
747 LineFormatter(ContinuationIndenter *Indenter, WhitespaceManager *Whitespaces,
anatofuz
parents:
diff changeset
748 const FormatStyle &Style,
anatofuz
parents:
diff changeset
749 UnwrappedLineFormatter *BlockFormatter)
anatofuz
parents:
diff changeset
750 : Indenter(Indenter), Whitespaces(Whitespaces), Style(Style),
anatofuz
parents:
diff changeset
751 BlockFormatter(BlockFormatter) {}
anatofuz
parents:
diff changeset
752 virtual ~LineFormatter() {}
anatofuz
parents:
diff changeset
753
anatofuz
parents:
diff changeset
754 /// Formats an \c AnnotatedLine and returns the penalty.
anatofuz
parents:
diff changeset
755 ///
anatofuz
parents:
diff changeset
756 /// If \p DryRun is \c false, directly applies the changes.
anatofuz
parents:
diff changeset
757 virtual unsigned formatLine(const AnnotatedLine &Line, unsigned FirstIndent,
anatofuz
parents:
diff changeset
758 unsigned FirstStartColumn, bool DryRun) = 0;
anatofuz
parents:
diff changeset
759
anatofuz
parents:
diff changeset
760 protected:
anatofuz
parents:
diff changeset
761 /// If the \p State's next token is an r_brace closing a nested block,
anatofuz
parents:
diff changeset
762 /// format the nested block before it.
anatofuz
parents:
diff changeset
763 ///
anatofuz
parents:
diff changeset
764 /// Returns \c true if all children could be placed successfully and adapts
anatofuz
parents:
diff changeset
765 /// \p Penalty as well as \p State. If \p DryRun is false, also directly
anatofuz
parents:
diff changeset
766 /// creates changes using \c Whitespaces.
anatofuz
parents:
diff changeset
767 ///
anatofuz
parents:
diff changeset
768 /// The crucial idea here is that children always get formatted upon
anatofuz
parents:
diff changeset
769 /// encountering the closing brace right after the nested block. Now, if we
anatofuz
parents:
diff changeset
770 /// are currently trying to keep the "}" on the same line (i.e. \p NewLine is
anatofuz
parents:
diff changeset
771 /// \c false), the entire block has to be kept on the same line (which is only
anatofuz
parents:
diff changeset
772 /// possible if it fits on the line, only contains a single statement, etc.
anatofuz
parents:
diff changeset
773 ///
anatofuz
parents:
diff changeset
774 /// If \p NewLine is true, we format the nested block on separate lines, i.e.
anatofuz
parents:
diff changeset
775 /// break after the "{", format all lines with correct indentation and the put
anatofuz
parents:
diff changeset
776 /// the closing "}" on yet another new line.
anatofuz
parents:
diff changeset
777 ///
anatofuz
parents:
diff changeset
778 /// This enables us to keep the simple structure of the
anatofuz
parents:
diff changeset
779 /// \c UnwrappedLineFormatter, where we only have two options for each token:
anatofuz
parents:
diff changeset
780 /// break or don't break.
anatofuz
parents:
diff changeset
781 bool formatChildren(LineState &State, bool NewLine, bool DryRun,
anatofuz
parents:
diff changeset
782 unsigned &Penalty) {
anatofuz
parents:
diff changeset
783 const FormatToken *LBrace = State.NextToken->getPreviousNonComment();
anatofuz
parents:
diff changeset
784 FormatToken &Previous = *State.NextToken->Previous;
anatofuz
parents:
diff changeset
785 if (!LBrace || LBrace->isNot(tok::l_brace) ||
anatofuz
parents:
diff changeset
786 LBrace->BlockKind != BK_Block || Previous.Children.size() == 0)
anatofuz
parents:
diff changeset
787 // The previous token does not open a block. Nothing to do. We don't
anatofuz
parents:
diff changeset
788 // assert so that we can simply call this function for all tokens.
anatofuz
parents:
diff changeset
789 return true;
anatofuz
parents:
diff changeset
790
anatofuz
parents:
diff changeset
791 if (NewLine) {
anatofuz
parents:
diff changeset
792 int AdditionalIndent = State.Stack.back().Indent -
anatofuz
parents:
diff changeset
793 Previous.Children[0]->Level * Style.IndentWidth;
anatofuz
parents:
diff changeset
794
anatofuz
parents:
diff changeset
795 Penalty +=
anatofuz
parents:
diff changeset
796 BlockFormatter->format(Previous.Children, DryRun, AdditionalIndent,
anatofuz
parents:
diff changeset
797 /*FixBadIndentation=*/true);
anatofuz
parents:
diff changeset
798 return true;
anatofuz
parents:
diff changeset
799 }
anatofuz
parents:
diff changeset
800
anatofuz
parents:
diff changeset
801 if (Previous.Children[0]->First->MustBreakBefore)
anatofuz
parents:
diff changeset
802 return false;
anatofuz
parents:
diff changeset
803
anatofuz
parents:
diff changeset
804 // Cannot merge into one line if this line ends on a comment.
anatofuz
parents:
diff changeset
805 if (Previous.is(tok::comment))
anatofuz
parents:
diff changeset
806 return false;
anatofuz
parents:
diff changeset
807
anatofuz
parents:
diff changeset
808 // Cannot merge multiple statements into a single line.
anatofuz
parents:
diff changeset
809 if (Previous.Children.size() > 1)
anatofuz
parents:
diff changeset
810 return false;
anatofuz
parents:
diff changeset
811
anatofuz
parents:
diff changeset
812 const AnnotatedLine *Child = Previous.Children[0];
anatofuz
parents:
diff changeset
813 // We can't put the closing "}" on a line with a trailing comment.
anatofuz
parents:
diff changeset
814 if (Child->Last->isTrailingComment())
anatofuz
parents:
diff changeset
815 return false;
anatofuz
parents:
diff changeset
816
anatofuz
parents:
diff changeset
817 // If the child line exceeds the column limit, we wouldn't want to merge it.
anatofuz
parents:
diff changeset
818 // We add +2 for the trailing " }".
anatofuz
parents:
diff changeset
819 if (Style.ColumnLimit > 0 &&
anatofuz
parents:
diff changeset
820 Child->Last->TotalLength + State.Column + 2 > Style.ColumnLimit)
anatofuz
parents:
diff changeset
821 return false;
anatofuz
parents:
diff changeset
822
anatofuz
parents:
diff changeset
823 if (!DryRun) {
anatofuz
parents:
diff changeset
824 Whitespaces->replaceWhitespace(
anatofuz
parents:
diff changeset
825 *Child->First, /*Newlines=*/0, /*Spaces=*/1,
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
826 /*StartOfTokenColumn=*/State.Column, /*IsAligned=*/false,
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
827 State.Line->InPPDirective);
150
anatofuz
parents:
diff changeset
828 }
anatofuz
parents:
diff changeset
829 Penalty +=
anatofuz
parents:
diff changeset
830 formatLine(*Child, State.Column + 1, /*FirstStartColumn=*/0, DryRun);
anatofuz
parents:
diff changeset
831
anatofuz
parents:
diff changeset
832 State.Column += 1 + Child->Last->TotalLength;
anatofuz
parents:
diff changeset
833 return true;
anatofuz
parents:
diff changeset
834 }
anatofuz
parents:
diff changeset
835
anatofuz
parents:
diff changeset
836 ContinuationIndenter *Indenter;
anatofuz
parents:
diff changeset
837
anatofuz
parents:
diff changeset
838 private:
anatofuz
parents:
diff changeset
839 WhitespaceManager *Whitespaces;
anatofuz
parents:
diff changeset
840 const FormatStyle &Style;
anatofuz
parents:
diff changeset
841 UnwrappedLineFormatter *BlockFormatter;
anatofuz
parents:
diff changeset
842 };
anatofuz
parents:
diff changeset
843
anatofuz
parents:
diff changeset
844 /// Formatter that keeps the existing line breaks.
anatofuz
parents:
diff changeset
845 class NoColumnLimitLineFormatter : public LineFormatter {
anatofuz
parents:
diff changeset
846 public:
anatofuz
parents:
diff changeset
847 NoColumnLimitLineFormatter(ContinuationIndenter *Indenter,
anatofuz
parents:
diff changeset
848 WhitespaceManager *Whitespaces,
anatofuz
parents:
diff changeset
849 const FormatStyle &Style,
anatofuz
parents:
diff changeset
850 UnwrappedLineFormatter *BlockFormatter)
anatofuz
parents:
diff changeset
851 : LineFormatter(Indenter, Whitespaces, Style, BlockFormatter) {}
anatofuz
parents:
diff changeset
852
anatofuz
parents:
diff changeset
853 /// Formats the line, simply keeping all of the input's line breaking
anatofuz
parents:
diff changeset
854 /// decisions.
anatofuz
parents:
diff changeset
855 unsigned formatLine(const AnnotatedLine &Line, unsigned FirstIndent,
anatofuz
parents:
diff changeset
856 unsigned FirstStartColumn, bool DryRun) override {
anatofuz
parents:
diff changeset
857 assert(!DryRun);
anatofuz
parents:
diff changeset
858 LineState State = Indenter->getInitialState(FirstIndent, FirstStartColumn,
anatofuz
parents:
diff changeset
859 &Line, /*DryRun=*/false);
anatofuz
parents:
diff changeset
860 while (State.NextToken) {
anatofuz
parents:
diff changeset
861 bool Newline =
anatofuz
parents:
diff changeset
862 Indenter->mustBreak(State) ||
anatofuz
parents:
diff changeset
863 (Indenter->canBreak(State) && State.NextToken->NewlinesBefore > 0);
anatofuz
parents:
diff changeset
864 unsigned Penalty = 0;
anatofuz
parents:
diff changeset
865 formatChildren(State, Newline, /*DryRun=*/false, Penalty);
anatofuz
parents:
diff changeset
866 Indenter->addTokenToState(State, Newline, /*DryRun=*/false);
anatofuz
parents:
diff changeset
867 }
anatofuz
parents:
diff changeset
868 return 0;
anatofuz
parents:
diff changeset
869 }
anatofuz
parents:
diff changeset
870 };
anatofuz
parents:
diff changeset
871
anatofuz
parents:
diff changeset
872 /// Formatter that puts all tokens into a single line without breaks.
anatofuz
parents:
diff changeset
873 class NoLineBreakFormatter : public LineFormatter {
anatofuz
parents:
diff changeset
874 public:
anatofuz
parents:
diff changeset
875 NoLineBreakFormatter(ContinuationIndenter *Indenter,
anatofuz
parents:
diff changeset
876 WhitespaceManager *Whitespaces, const FormatStyle &Style,
anatofuz
parents:
diff changeset
877 UnwrappedLineFormatter *BlockFormatter)
anatofuz
parents:
diff changeset
878 : LineFormatter(Indenter, Whitespaces, Style, BlockFormatter) {}
anatofuz
parents:
diff changeset
879
anatofuz
parents:
diff changeset
880 /// Puts all tokens into a single line.
anatofuz
parents:
diff changeset
881 unsigned formatLine(const AnnotatedLine &Line, unsigned FirstIndent,
anatofuz
parents:
diff changeset
882 unsigned FirstStartColumn, bool DryRun) override {
anatofuz
parents:
diff changeset
883 unsigned Penalty = 0;
anatofuz
parents:
diff changeset
884 LineState State =
anatofuz
parents:
diff changeset
885 Indenter->getInitialState(FirstIndent, FirstStartColumn, &Line, DryRun);
anatofuz
parents:
diff changeset
886 while (State.NextToken) {
anatofuz
parents:
diff changeset
887 formatChildren(State, /*NewLine=*/false, DryRun, Penalty);
anatofuz
parents:
diff changeset
888 Indenter->addTokenToState(
anatofuz
parents:
diff changeset
889 State, /*Newline=*/State.NextToken->MustBreakBefore, DryRun);
anatofuz
parents:
diff changeset
890 }
anatofuz
parents:
diff changeset
891 return Penalty;
anatofuz
parents:
diff changeset
892 }
anatofuz
parents:
diff changeset
893 };
anatofuz
parents:
diff changeset
894
anatofuz
parents:
diff changeset
895 /// Finds the best way to break lines.
anatofuz
parents:
diff changeset
896 class OptimizingLineFormatter : public LineFormatter {
anatofuz
parents:
diff changeset
897 public:
anatofuz
parents:
diff changeset
898 OptimizingLineFormatter(ContinuationIndenter *Indenter,
anatofuz
parents:
diff changeset
899 WhitespaceManager *Whitespaces,
anatofuz
parents:
diff changeset
900 const FormatStyle &Style,
anatofuz
parents:
diff changeset
901 UnwrappedLineFormatter *BlockFormatter)
anatofuz
parents:
diff changeset
902 : LineFormatter(Indenter, Whitespaces, Style, BlockFormatter) {}
anatofuz
parents:
diff changeset
903
anatofuz
parents:
diff changeset
904 /// Formats the line by finding the best line breaks with line lengths
anatofuz
parents:
diff changeset
905 /// below the column limit.
anatofuz
parents:
diff changeset
906 unsigned formatLine(const AnnotatedLine &Line, unsigned FirstIndent,
anatofuz
parents:
diff changeset
907 unsigned FirstStartColumn, bool DryRun) override {
anatofuz
parents:
diff changeset
908 LineState State =
anatofuz
parents:
diff changeset
909 Indenter->getInitialState(FirstIndent, FirstStartColumn, &Line, DryRun);
anatofuz
parents:
diff changeset
910
anatofuz
parents:
diff changeset
911 // If the ObjC method declaration does not fit on a line, we should format
anatofuz
parents:
diff changeset
912 // it with one arg per line.
anatofuz
parents:
diff changeset
913 if (State.Line->Type == LT_ObjCMethodDecl)
anatofuz
parents:
diff changeset
914 State.Stack.back().BreakBeforeParameter = true;
anatofuz
parents:
diff changeset
915
anatofuz
parents:
diff changeset
916 // Find best solution in solution space.
anatofuz
parents:
diff changeset
917 return analyzeSolutionSpace(State, DryRun);
anatofuz
parents:
diff changeset
918 }
anatofuz
parents:
diff changeset
919
anatofuz
parents:
diff changeset
920 private:
anatofuz
parents:
diff changeset
921 struct CompareLineStatePointers {
anatofuz
parents:
diff changeset
922 bool operator()(LineState *obj1, LineState *obj2) const {
anatofuz
parents:
diff changeset
923 return *obj1 < *obj2;
anatofuz
parents:
diff changeset
924 }
anatofuz
parents:
diff changeset
925 };
anatofuz
parents:
diff changeset
926
anatofuz
parents:
diff changeset
927 /// A pair of <penalty, count> that is used to prioritize the BFS on.
anatofuz
parents:
diff changeset
928 ///
anatofuz
parents:
diff changeset
929 /// In case of equal penalties, we want to prefer states that were inserted
anatofuz
parents:
diff changeset
930 /// first. During state generation we make sure that we insert states first
anatofuz
parents:
diff changeset
931 /// that break the line as late as possible.
anatofuz
parents:
diff changeset
932 typedef std::pair<unsigned, unsigned> OrderedPenalty;
anatofuz
parents:
diff changeset
933
anatofuz
parents:
diff changeset
934 /// An edge in the solution space from \c Previous->State to \c State,
anatofuz
parents:
diff changeset
935 /// inserting a newline dependent on the \c NewLine.
anatofuz
parents:
diff changeset
936 struct StateNode {
anatofuz
parents:
diff changeset
937 StateNode(const LineState &State, bool NewLine, StateNode *Previous)
anatofuz
parents:
diff changeset
938 : State(State), NewLine(NewLine), Previous(Previous) {}
anatofuz
parents:
diff changeset
939 LineState State;
anatofuz
parents:
diff changeset
940 bool NewLine;
anatofuz
parents:
diff changeset
941 StateNode *Previous;
anatofuz
parents:
diff changeset
942 };
anatofuz
parents:
diff changeset
943
anatofuz
parents:
diff changeset
944 /// An item in the prioritized BFS search queue. The \c StateNode's
anatofuz
parents:
diff changeset
945 /// \c State has the given \c OrderedPenalty.
anatofuz
parents:
diff changeset
946 typedef std::pair<OrderedPenalty, StateNode *> QueueItem;
anatofuz
parents:
diff changeset
947
anatofuz
parents:
diff changeset
948 /// The BFS queue type.
anatofuz
parents:
diff changeset
949 typedef std::priority_queue<QueueItem, std::vector<QueueItem>,
anatofuz
parents:
diff changeset
950 std::greater<QueueItem>>
anatofuz
parents:
diff changeset
951 QueueType;
anatofuz
parents:
diff changeset
952
anatofuz
parents:
diff changeset
953 /// Analyze the entire solution space starting from \p InitialState.
anatofuz
parents:
diff changeset
954 ///
anatofuz
parents:
diff changeset
955 /// This implements a variant of Dijkstra's algorithm on the graph that spans
anatofuz
parents:
diff changeset
956 /// the solution space (\c LineStates are the nodes). The algorithm tries to
anatofuz
parents:
diff changeset
957 /// find the shortest path (the one with lowest penalty) from \p InitialState
anatofuz
parents:
diff changeset
958 /// to a state where all tokens are placed. Returns the penalty.
anatofuz
parents:
diff changeset
959 ///
anatofuz
parents:
diff changeset
960 /// If \p DryRun is \c false, directly applies the changes.
anatofuz
parents:
diff changeset
961 unsigned analyzeSolutionSpace(LineState &InitialState, bool DryRun) {
anatofuz
parents:
diff changeset
962 std::set<LineState *, CompareLineStatePointers> Seen;
anatofuz
parents:
diff changeset
963
anatofuz
parents:
diff changeset
964 // Increasing count of \c StateNode items we have created. This is used to
anatofuz
parents:
diff changeset
965 // create a deterministic order independent of the container.
anatofuz
parents:
diff changeset
966 unsigned Count = 0;
anatofuz
parents:
diff changeset
967 QueueType Queue;
anatofuz
parents:
diff changeset
968
anatofuz
parents:
diff changeset
969 // Insert start element into queue.
anatofuz
parents:
diff changeset
970 StateNode *Node =
anatofuz
parents:
diff changeset
971 new (Allocator.Allocate()) StateNode(InitialState, false, nullptr);
anatofuz
parents:
diff changeset
972 Queue.push(QueueItem(OrderedPenalty(0, Count), Node));
anatofuz
parents:
diff changeset
973 ++Count;
anatofuz
parents:
diff changeset
974
anatofuz
parents:
diff changeset
975 unsigned Penalty = 0;
anatofuz
parents:
diff changeset
976
anatofuz
parents:
diff changeset
977 // While not empty, take first element and follow edges.
anatofuz
parents:
diff changeset
978 while (!Queue.empty()) {
anatofuz
parents:
diff changeset
979 Penalty = Queue.top().first.first;
anatofuz
parents:
diff changeset
980 StateNode *Node = Queue.top().second;
anatofuz
parents:
diff changeset
981 if (!Node->State.NextToken) {
anatofuz
parents:
diff changeset
982 LLVM_DEBUG(llvm::dbgs()
anatofuz
parents:
diff changeset
983 << "\n---\nPenalty for line: " << Penalty << "\n");
anatofuz
parents:
diff changeset
984 break;
anatofuz
parents:
diff changeset
985 }
anatofuz
parents:
diff changeset
986 Queue.pop();
anatofuz
parents:
diff changeset
987
anatofuz
parents:
diff changeset
988 // Cut off the analysis of certain solutions if the analysis gets too
anatofuz
parents:
diff changeset
989 // complex. See description of IgnoreStackForComparison.
anatofuz
parents:
diff changeset
990 if (Count > 50000)
anatofuz
parents:
diff changeset
991 Node->State.IgnoreStackForComparison = true;
anatofuz
parents:
diff changeset
992
anatofuz
parents:
diff changeset
993 if (!Seen.insert(&Node->State).second)
anatofuz
parents:
diff changeset
994 // State already examined with lower penalty.
anatofuz
parents:
diff changeset
995 continue;
anatofuz
parents:
diff changeset
996
anatofuz
parents:
diff changeset
997 FormatDecision LastFormat = Node->State.NextToken->Decision;
anatofuz
parents:
diff changeset
998 if (LastFormat == FD_Unformatted || LastFormat == FD_Continue)
anatofuz
parents:
diff changeset
999 addNextStateToQueue(Penalty, Node, /*NewLine=*/false, &Count, &Queue);
anatofuz
parents:
diff changeset
1000 if (LastFormat == FD_Unformatted || LastFormat == FD_Break)
anatofuz
parents:
diff changeset
1001 addNextStateToQueue(Penalty, Node, /*NewLine=*/true, &Count, &Queue);
anatofuz
parents:
diff changeset
1002 }
anatofuz
parents:
diff changeset
1003
anatofuz
parents:
diff changeset
1004 if (Queue.empty()) {
anatofuz
parents:
diff changeset
1005 // We were unable to find a solution, do nothing.
anatofuz
parents:
diff changeset
1006 // FIXME: Add diagnostic?
anatofuz
parents:
diff changeset
1007 LLVM_DEBUG(llvm::dbgs() << "Could not find a solution.\n");
anatofuz
parents:
diff changeset
1008 return 0;
anatofuz
parents:
diff changeset
1009 }
anatofuz
parents:
diff changeset
1010
anatofuz
parents:
diff changeset
1011 // Reconstruct the solution.
anatofuz
parents:
diff changeset
1012 if (!DryRun)
anatofuz
parents:
diff changeset
1013 reconstructPath(InitialState, Queue.top().second);
anatofuz
parents:
diff changeset
1014
anatofuz
parents:
diff changeset
1015 LLVM_DEBUG(llvm::dbgs()
anatofuz
parents:
diff changeset
1016 << "Total number of analyzed states: " << Count << "\n");
anatofuz
parents:
diff changeset
1017 LLVM_DEBUG(llvm::dbgs() << "---\n");
anatofuz
parents:
diff changeset
1018
anatofuz
parents:
diff changeset
1019 return Penalty;
anatofuz
parents:
diff changeset
1020 }
anatofuz
parents:
diff changeset
1021
anatofuz
parents:
diff changeset
1022 /// Add the following state to the analysis queue \c Queue.
anatofuz
parents:
diff changeset
1023 ///
anatofuz
parents:
diff changeset
1024 /// Assume the current state is \p PreviousNode and has been reached with a
anatofuz
parents:
diff changeset
1025 /// penalty of \p Penalty. Insert a line break if \p NewLine is \c true.
anatofuz
parents:
diff changeset
1026 void addNextStateToQueue(unsigned Penalty, StateNode *PreviousNode,
anatofuz
parents:
diff changeset
1027 bool NewLine, unsigned *Count, QueueType *Queue) {
anatofuz
parents:
diff changeset
1028 if (NewLine && !Indenter->canBreak(PreviousNode->State))
anatofuz
parents:
diff changeset
1029 return;
anatofuz
parents:
diff changeset
1030 if (!NewLine && Indenter->mustBreak(PreviousNode->State))
anatofuz
parents:
diff changeset
1031 return;
anatofuz
parents:
diff changeset
1032
anatofuz
parents:
diff changeset
1033 StateNode *Node = new (Allocator.Allocate())
anatofuz
parents:
diff changeset
1034 StateNode(PreviousNode->State, NewLine, PreviousNode);
anatofuz
parents:
diff changeset
1035 if (!formatChildren(Node->State, NewLine, /*DryRun=*/true, Penalty))
anatofuz
parents:
diff changeset
1036 return;
anatofuz
parents:
diff changeset
1037
anatofuz
parents:
diff changeset
1038 Penalty += Indenter->addTokenToState(Node->State, NewLine, true);
anatofuz
parents:
diff changeset
1039
anatofuz
parents:
diff changeset
1040 Queue->push(QueueItem(OrderedPenalty(Penalty, *Count), Node));
anatofuz
parents:
diff changeset
1041 ++(*Count);
anatofuz
parents:
diff changeset
1042 }
anatofuz
parents:
diff changeset
1043
anatofuz
parents:
diff changeset
1044 /// Applies the best formatting by reconstructing the path in the
anatofuz
parents:
diff changeset
1045 /// solution space that leads to \c Best.
anatofuz
parents:
diff changeset
1046 void reconstructPath(LineState &State, StateNode *Best) {
anatofuz
parents:
diff changeset
1047 std::deque<StateNode *> Path;
anatofuz
parents:
diff changeset
1048 // We do not need a break before the initial token.
anatofuz
parents:
diff changeset
1049 while (Best->Previous) {
anatofuz
parents:
diff changeset
1050 Path.push_front(Best);
anatofuz
parents:
diff changeset
1051 Best = Best->Previous;
anatofuz
parents:
diff changeset
1052 }
anatofuz
parents:
diff changeset
1053 for (auto I = Path.begin(), E = Path.end(); I != E; ++I) {
anatofuz
parents:
diff changeset
1054 unsigned Penalty = 0;
anatofuz
parents:
diff changeset
1055 formatChildren(State, (*I)->NewLine, /*DryRun=*/false, Penalty);
anatofuz
parents:
diff changeset
1056 Penalty += Indenter->addTokenToState(State, (*I)->NewLine, false);
anatofuz
parents:
diff changeset
1057
anatofuz
parents:
diff changeset
1058 LLVM_DEBUG({
anatofuz
parents:
diff changeset
1059 printLineState((*I)->Previous->State);
anatofuz
parents:
diff changeset
1060 if ((*I)->NewLine) {
anatofuz
parents:
diff changeset
1061 llvm::dbgs() << "Penalty for placing "
anatofuz
parents:
diff changeset
1062 << (*I)->Previous->State.NextToken->Tok.getName()
anatofuz
parents:
diff changeset
1063 << " on a new line: " << Penalty << "\n";
anatofuz
parents:
diff changeset
1064 }
anatofuz
parents:
diff changeset
1065 });
anatofuz
parents:
diff changeset
1066 }
anatofuz
parents:
diff changeset
1067 }
anatofuz
parents:
diff changeset
1068
anatofuz
parents:
diff changeset
1069 llvm::SpecificBumpPtrAllocator<StateNode> Allocator;
anatofuz
parents:
diff changeset
1070 };
anatofuz
parents:
diff changeset
1071
anatofuz
parents:
diff changeset
1072 } // anonymous namespace
anatofuz
parents:
diff changeset
1073
anatofuz
parents:
diff changeset
1074 unsigned UnwrappedLineFormatter::format(
anatofuz
parents:
diff changeset
1075 const SmallVectorImpl<AnnotatedLine *> &Lines, bool DryRun,
anatofuz
parents:
diff changeset
1076 int AdditionalIndent, bool FixBadIndentation, unsigned FirstStartColumn,
anatofuz
parents:
diff changeset
1077 unsigned NextStartColumn, unsigned LastStartColumn) {
anatofuz
parents:
diff changeset
1078 LineJoiner Joiner(Style, Keywords, Lines);
anatofuz
parents:
diff changeset
1079
anatofuz
parents:
diff changeset
1080 // Try to look up already computed penalty in DryRun-mode.
anatofuz
parents:
diff changeset
1081 std::pair<const SmallVectorImpl<AnnotatedLine *> *, unsigned> CacheKey(
anatofuz
parents:
diff changeset
1082 &Lines, AdditionalIndent);
anatofuz
parents:
diff changeset
1083 auto CacheIt = PenaltyCache.find(CacheKey);
anatofuz
parents:
diff changeset
1084 if (DryRun && CacheIt != PenaltyCache.end())
anatofuz
parents:
diff changeset
1085 return CacheIt->second;
anatofuz
parents:
diff changeset
1086
anatofuz
parents:
diff changeset
1087 assert(!Lines.empty());
anatofuz
parents:
diff changeset
1088 unsigned Penalty = 0;
anatofuz
parents:
diff changeset
1089 LevelIndentTracker IndentTracker(Style, Keywords, Lines[0]->Level,
anatofuz
parents:
diff changeset
1090 AdditionalIndent);
anatofuz
parents:
diff changeset
1091 const AnnotatedLine *PreviousLine = nullptr;
anatofuz
parents:
diff changeset
1092 const AnnotatedLine *NextLine = nullptr;
anatofuz
parents:
diff changeset
1093
anatofuz
parents:
diff changeset
1094 // The minimum level of consecutive lines that have been formatted.
anatofuz
parents:
diff changeset
1095 unsigned RangeMinLevel = UINT_MAX;
anatofuz
parents:
diff changeset
1096
anatofuz
parents:
diff changeset
1097 bool FirstLine = true;
anatofuz
parents:
diff changeset
1098 for (const AnnotatedLine *Line =
anatofuz
parents:
diff changeset
1099 Joiner.getNextMergedLine(DryRun, IndentTracker);
anatofuz
parents:
diff changeset
1100 Line; Line = NextLine, FirstLine = false) {
anatofuz
parents:
diff changeset
1101 const AnnotatedLine &TheLine = *Line;
anatofuz
parents:
diff changeset
1102 unsigned Indent = IndentTracker.getIndent();
anatofuz
parents:
diff changeset
1103
anatofuz
parents:
diff changeset
1104 // We continue formatting unchanged lines to adjust their indent, e.g. if a
anatofuz
parents:
diff changeset
1105 // scope was added. However, we need to carefully stop doing this when we
anatofuz
parents:
diff changeset
1106 // exit the scope of affected lines to prevent indenting a the entire
anatofuz
parents:
diff changeset
1107 // remaining file if it currently missing a closing brace.
anatofuz
parents:
diff changeset
1108 bool PreviousRBrace =
anatofuz
parents:
diff changeset
1109 PreviousLine && PreviousLine->startsWith(tok::r_brace);
anatofuz
parents:
diff changeset
1110 bool ContinueFormatting =
anatofuz
parents:
diff changeset
1111 TheLine.Level > RangeMinLevel ||
anatofuz
parents:
diff changeset
1112 (TheLine.Level == RangeMinLevel && !PreviousRBrace &&
anatofuz
parents:
diff changeset
1113 !TheLine.startsWith(tok::r_brace));
anatofuz
parents:
diff changeset
1114
anatofuz
parents:
diff changeset
1115 bool FixIndentation = (FixBadIndentation || ContinueFormatting) &&
anatofuz
parents:
diff changeset
1116 Indent != TheLine.First->OriginalColumn;
anatofuz
parents:
diff changeset
1117 bool ShouldFormat = TheLine.Affected || FixIndentation;
anatofuz
parents:
diff changeset
1118 // We cannot format this line; if the reason is that the line had a
anatofuz
parents:
diff changeset
1119 // parsing error, remember that.
anatofuz
parents:
diff changeset
1120 if (ShouldFormat && TheLine.Type == LT_Invalid && Status) {
anatofuz
parents:
diff changeset
1121 Status->FormatComplete = false;
anatofuz
parents:
diff changeset
1122 Status->Line =
anatofuz
parents:
diff changeset
1123 SourceMgr.getSpellingLineNumber(TheLine.First->Tok.getLocation());
anatofuz
parents:
diff changeset
1124 }
anatofuz
parents:
diff changeset
1125
anatofuz
parents:
diff changeset
1126 if (ShouldFormat && TheLine.Type != LT_Invalid) {
anatofuz
parents:
diff changeset
1127 if (!DryRun) {
anatofuz
parents:
diff changeset
1128 bool LastLine = Line->First->is(tok::eof);
anatofuz
parents:
diff changeset
1129 formatFirstToken(TheLine, PreviousLine, Lines, Indent,
anatofuz
parents:
diff changeset
1130 LastLine ? LastStartColumn : NextStartColumn + Indent);
anatofuz
parents:
diff changeset
1131 }
anatofuz
parents:
diff changeset
1132
anatofuz
parents:
diff changeset
1133 NextLine = Joiner.getNextMergedLine(DryRun, IndentTracker);
anatofuz
parents:
diff changeset
1134 unsigned ColumnLimit = getColumnLimit(TheLine.InPPDirective, NextLine);
anatofuz
parents:
diff changeset
1135 bool FitsIntoOneLine =
anatofuz
parents:
diff changeset
1136 TheLine.Last->TotalLength + Indent <= ColumnLimit ||
anatofuz
parents:
diff changeset
1137 (TheLine.Type == LT_ImportStatement &&
anatofuz
parents:
diff changeset
1138 (Style.Language != FormatStyle::LK_JavaScript ||
anatofuz
parents:
diff changeset
1139 !Style.JavaScriptWrapImports)) ||
anatofuz
parents:
diff changeset
1140 (Style.isCSharp() &&
anatofuz
parents:
diff changeset
1141 TheLine.InPPDirective); // don't split #regions in C#
anatofuz
parents:
diff changeset
1142 if (Style.ColumnLimit == 0)
anatofuz
parents:
diff changeset
1143 NoColumnLimitLineFormatter(Indenter, Whitespaces, Style, this)
anatofuz
parents:
diff changeset
1144 .formatLine(TheLine, NextStartColumn + Indent,
anatofuz
parents:
diff changeset
1145 FirstLine ? FirstStartColumn : 0, DryRun);
anatofuz
parents:
diff changeset
1146 else if (FitsIntoOneLine)
anatofuz
parents:
diff changeset
1147 Penalty += NoLineBreakFormatter(Indenter, Whitespaces, Style, this)
anatofuz
parents:
diff changeset
1148 .formatLine(TheLine, NextStartColumn + Indent,
anatofuz
parents:
diff changeset
1149 FirstLine ? FirstStartColumn : 0, DryRun);
anatofuz
parents:
diff changeset
1150 else
anatofuz
parents:
diff changeset
1151 Penalty += OptimizingLineFormatter(Indenter, Whitespaces, Style, this)
anatofuz
parents:
diff changeset
1152 .formatLine(TheLine, NextStartColumn + Indent,
anatofuz
parents:
diff changeset
1153 FirstLine ? FirstStartColumn : 0, DryRun);
anatofuz
parents:
diff changeset
1154 RangeMinLevel = std::min(RangeMinLevel, TheLine.Level);
anatofuz
parents:
diff changeset
1155 } else {
anatofuz
parents:
diff changeset
1156 // If no token in the current line is affected, we still need to format
anatofuz
parents:
diff changeset
1157 // affected children.
anatofuz
parents:
diff changeset
1158 if (TheLine.ChildrenAffected)
anatofuz
parents:
diff changeset
1159 for (const FormatToken *Tok = TheLine.First; Tok; Tok = Tok->Next)
anatofuz
parents:
diff changeset
1160 if (!Tok->Children.empty())
anatofuz
parents:
diff changeset
1161 format(Tok->Children, DryRun);
anatofuz
parents:
diff changeset
1162
anatofuz
parents:
diff changeset
1163 // Adapt following lines on the current indent level to the same level
anatofuz
parents:
diff changeset
1164 // unless the current \c AnnotatedLine is not at the beginning of a line.
anatofuz
parents:
diff changeset
1165 bool StartsNewLine =
anatofuz
parents:
diff changeset
1166 TheLine.First->NewlinesBefore > 0 || TheLine.First->IsFirst;
anatofuz
parents:
diff changeset
1167 if (StartsNewLine)
anatofuz
parents:
diff changeset
1168 IndentTracker.adjustToUnmodifiedLine(TheLine);
anatofuz
parents:
diff changeset
1169 if (!DryRun) {
anatofuz
parents:
diff changeset
1170 bool ReformatLeadingWhitespace =
anatofuz
parents:
diff changeset
1171 StartsNewLine && ((PreviousLine && PreviousLine->Affected) ||
anatofuz
parents:
diff changeset
1172 TheLine.LeadingEmptyLinesAffected);
anatofuz
parents:
diff changeset
1173 // Format the first token.
anatofuz
parents:
diff changeset
1174 if (ReformatLeadingWhitespace)
anatofuz
parents:
diff changeset
1175 formatFirstToken(TheLine, PreviousLine, Lines,
anatofuz
parents:
diff changeset
1176 TheLine.First->OriginalColumn,
anatofuz
parents:
diff changeset
1177 TheLine.First->OriginalColumn);
anatofuz
parents:
diff changeset
1178 else
anatofuz
parents:
diff changeset
1179 Whitespaces->addUntouchableToken(*TheLine.First,
anatofuz
parents:
diff changeset
1180 TheLine.InPPDirective);
anatofuz
parents:
diff changeset
1181
anatofuz
parents:
diff changeset
1182 // Notify the WhitespaceManager about the unchanged whitespace.
anatofuz
parents:
diff changeset
1183 for (FormatToken *Tok = TheLine.First->Next; Tok; Tok = Tok->Next)
anatofuz
parents:
diff changeset
1184 Whitespaces->addUntouchableToken(*Tok, TheLine.InPPDirective);
anatofuz
parents:
diff changeset
1185 }
anatofuz
parents:
diff changeset
1186 NextLine = Joiner.getNextMergedLine(DryRun, IndentTracker);
anatofuz
parents:
diff changeset
1187 RangeMinLevel = UINT_MAX;
anatofuz
parents:
diff changeset
1188 }
anatofuz
parents:
diff changeset
1189 if (!DryRun)
anatofuz
parents:
diff changeset
1190 markFinalized(TheLine.First);
anatofuz
parents:
diff changeset
1191 PreviousLine = &TheLine;
anatofuz
parents:
diff changeset
1192 }
anatofuz
parents:
diff changeset
1193 PenaltyCache[CacheKey] = Penalty;
anatofuz
parents:
diff changeset
1194 return Penalty;
anatofuz
parents:
diff changeset
1195 }
anatofuz
parents:
diff changeset
1196
anatofuz
parents:
diff changeset
1197 void UnwrappedLineFormatter::formatFirstToken(
anatofuz
parents:
diff changeset
1198 const AnnotatedLine &Line, const AnnotatedLine *PreviousLine,
anatofuz
parents:
diff changeset
1199 const SmallVectorImpl<AnnotatedLine *> &Lines, unsigned Indent,
anatofuz
parents:
diff changeset
1200 unsigned NewlineIndent) {
anatofuz
parents:
diff changeset
1201 FormatToken &RootToken = *Line.First;
anatofuz
parents:
diff changeset
1202 if (RootToken.is(tok::eof)) {
anatofuz
parents:
diff changeset
1203 unsigned Newlines = std::min(RootToken.NewlinesBefore, 1u);
anatofuz
parents:
diff changeset
1204 unsigned TokenIndent = Newlines ? NewlineIndent : 0;
anatofuz
parents:
diff changeset
1205 Whitespaces->replaceWhitespace(RootToken, Newlines, TokenIndent,
anatofuz
parents:
diff changeset
1206 TokenIndent);
anatofuz
parents:
diff changeset
1207 return;
anatofuz
parents:
diff changeset
1208 }
anatofuz
parents:
diff changeset
1209 unsigned Newlines =
anatofuz
parents:
diff changeset
1210 std::min(RootToken.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1);
anatofuz
parents:
diff changeset
1211 // Remove empty lines before "}" where applicable.
anatofuz
parents:
diff changeset
1212 if (RootToken.is(tok::r_brace) &&
anatofuz
parents:
diff changeset
1213 (!RootToken.Next ||
anatofuz
parents:
diff changeset
1214 (RootToken.Next->is(tok::semi) && !RootToken.Next->Next)) &&
anatofuz
parents:
diff changeset
1215 // Do not remove empty lines before namespace closing "}".
anatofuz
parents:
diff changeset
1216 !getNamespaceToken(&Line, Lines))
anatofuz
parents:
diff changeset
1217 Newlines = std::min(Newlines, 1u);
anatofuz
parents:
diff changeset
1218 // Remove empty lines at the start of nested blocks (lambdas/arrow functions)
anatofuz
parents:
diff changeset
1219 if (PreviousLine == nullptr && Line.Level > 0)
anatofuz
parents:
diff changeset
1220 Newlines = std::min(Newlines, 1u);
anatofuz
parents:
diff changeset
1221 if (Newlines == 0 && !RootToken.IsFirst)
anatofuz
parents:
diff changeset
1222 Newlines = 1;
anatofuz
parents:
diff changeset
1223 if (RootToken.IsFirst && !RootToken.HasUnescapedNewline)
anatofuz
parents:
diff changeset
1224 Newlines = 0;
anatofuz
parents:
diff changeset
1225
anatofuz
parents:
diff changeset
1226 // Remove empty lines after "{".
anatofuz
parents:
diff changeset
1227 if (!Style.KeepEmptyLinesAtTheStartOfBlocks && PreviousLine &&
anatofuz
parents:
diff changeset
1228 PreviousLine->Last->is(tok::l_brace) &&
anatofuz
parents:
diff changeset
1229 !PreviousLine->startsWithNamespace() &&
anatofuz
parents:
diff changeset
1230 !startsExternCBlock(*PreviousLine))
anatofuz
parents:
diff changeset
1231 Newlines = 1;
anatofuz
parents:
diff changeset
1232
anatofuz
parents:
diff changeset
1233 // Insert extra new line before access specifiers.
anatofuz
parents:
diff changeset
1234 if (PreviousLine && PreviousLine->Last->isOneOf(tok::semi, tok::r_brace) &&
anatofuz
parents:
diff changeset
1235 RootToken.isAccessSpecifier() && RootToken.NewlinesBefore == 1)
anatofuz
parents:
diff changeset
1236 ++Newlines;
anatofuz
parents:
diff changeset
1237
anatofuz
parents:
diff changeset
1238 // Remove empty lines after access specifiers.
anatofuz
parents:
diff changeset
1239 if (PreviousLine && PreviousLine->First->isAccessSpecifier() &&
anatofuz
parents:
diff changeset
1240 (!PreviousLine->InPPDirective || !RootToken.HasUnescapedNewline))
anatofuz
parents:
diff changeset
1241 Newlines = std::min(1u, Newlines);
anatofuz
parents:
diff changeset
1242
anatofuz
parents:
diff changeset
1243 if (Newlines)
anatofuz
parents:
diff changeset
1244 Indent = NewlineIndent;
anatofuz
parents:
diff changeset
1245
anatofuz
parents:
diff changeset
1246 // If in Whitemsmiths mode, indent start and end of blocks
anatofuz
parents:
diff changeset
1247 if (Style.BreakBeforeBraces == FormatStyle::BS_Whitesmiths) {
anatofuz
parents:
diff changeset
1248 if (RootToken.isOneOf(tok::l_brace, tok::r_brace, tok::kw_case))
anatofuz
parents:
diff changeset
1249 Indent += Style.IndentWidth;
anatofuz
parents:
diff changeset
1250 }
anatofuz
parents:
diff changeset
1251
anatofuz
parents:
diff changeset
1252 // Preprocessor directives get indented before the hash only if specified
anatofuz
parents:
diff changeset
1253 if (Style.IndentPPDirectives != FormatStyle::PPDIS_BeforeHash &&
anatofuz
parents:
diff changeset
1254 (Line.Type == LT_PreprocessorDirective ||
anatofuz
parents:
diff changeset
1255 Line.Type == LT_ImportStatement))
anatofuz
parents:
diff changeset
1256 Indent = 0;
anatofuz
parents:
diff changeset
1257
anatofuz
parents:
diff changeset
1258 Whitespaces->replaceWhitespace(RootToken, Newlines, Indent, Indent,
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
1259 /*IsAligned=*/false,
150
anatofuz
parents:
diff changeset
1260 Line.InPPDirective &&
anatofuz
parents:
diff changeset
1261 !RootToken.HasUnescapedNewline);
anatofuz
parents:
diff changeset
1262 }
anatofuz
parents:
diff changeset
1263
anatofuz
parents:
diff changeset
1264 unsigned
anatofuz
parents:
diff changeset
1265 UnwrappedLineFormatter::getColumnLimit(bool InPPDirective,
anatofuz
parents:
diff changeset
1266 const AnnotatedLine *NextLine) const {
anatofuz
parents:
diff changeset
1267 // In preprocessor directives reserve two chars for trailing " \" if the
anatofuz
parents:
diff changeset
1268 // next line continues the preprocessor directive.
anatofuz
parents:
diff changeset
1269 bool ContinuesPPDirective =
anatofuz
parents:
diff changeset
1270 InPPDirective &&
anatofuz
parents:
diff changeset
1271 // If there is no next line, this is likely a child line and the parent
anatofuz
parents:
diff changeset
1272 // continues the preprocessor directive.
anatofuz
parents:
diff changeset
1273 (!NextLine ||
anatofuz
parents:
diff changeset
1274 (NextLine->InPPDirective &&
anatofuz
parents:
diff changeset
1275 // If there is an unescaped newline between this line and the next, the
anatofuz
parents:
diff changeset
1276 // next line starts a new preprocessor directive.
anatofuz
parents:
diff changeset
1277 !NextLine->First->HasUnescapedNewline));
anatofuz
parents:
diff changeset
1278 return Style.ColumnLimit - (ContinuesPPDirective ? 2 : 0);
anatofuz
parents:
diff changeset
1279 }
anatofuz
parents:
diff changeset
1280
anatofuz
parents:
diff changeset
1281 } // namespace format
anatofuz
parents:
diff changeset
1282 } // namespace clang