16 #include "llvm/ADT/STLExtras.h"
24 C1.OriginalWhitespaceRange.getBegin(),
25 C2.OriginalWhitespaceRange.getBegin());
28 WhitespaceManager::Change::Change(
29 bool CreateReplacement,
const SourceRange &OriginalWhitespaceRange,
30 unsigned IndentLevel,
int Spaces,
unsigned StartOfTokenColumn,
31 unsigned NewlinesBefore, StringRef PreviousLinePostfix,
33 : CreateReplacement(CreateReplacement),
34 OriginalWhitespaceRange(OriginalWhitespaceRange),
35 StartOfTokenColumn(StartOfTokenColumn), NewlinesBefore(NewlinesBefore),
36 PreviousLinePostfix(PreviousLinePostfix),
37 CurrentLinePrefix(CurrentLinePrefix), Kind(Kind),
38 ContinuesPPDirective(ContinuesPPDirective), IndentLevel(IndentLevel),
39 Spaces(Spaces), IsTrailingComment(
false), TokenLength(0),
40 PreviousEndOfTokenColumn(0), EscapedNewlineColumn(0),
41 StartOfBlockComment(nullptr), IndentationOffset(0) {}
49 unsigned IndentLevel,
unsigned Spaces,
50 unsigned StartOfTokenColumn,
55 Changes.push_back(Change(
true, Tok.
WhitespaceRange, IndentLevel, Spaces,
56 StartOfTokenColumn, Newlines,
"",
"",
67 InPPDirective && !Tok.
IsFirst));
72 StringRef PreviousPostfix, StringRef CurrentPrefix,
bool InPPDirective,
73 unsigned Newlines,
unsigned IndentLevel,
int Spaces) {
77 Changes.push_back(Change(
79 IndentLevel, Spaces, std::max(0, Spaces), Newlines, PreviousPostfix,
86 Tok.
is(TT_LineComment) && Newlines > 0 ? tok::comment : tok::unknown,
87 InPPDirective && !Tok.
IsFirst));
95 calculateLineBreakInformation();
96 alignConsecutiveAssignments();
97 alignTrailingComments();
98 alignEscapedNewlines();
104 void WhitespaceManager::calculateLineBreakInformation() {
105 Changes[0].PreviousEndOfTokenColumn = 0;
106 for (
unsigned i = 1, e = Changes.size(); i != e; ++i) {
107 unsigned OriginalWhitespaceStart =
108 SourceMgr.getFileOffset(Changes[i].OriginalWhitespaceRange.getBegin());
109 unsigned PreviousOriginalWhitespaceEnd =
SourceMgr.getFileOffset(
110 Changes[i - 1].OriginalWhitespaceRange.getEnd());
111 Changes[i - 1].TokenLength = OriginalWhitespaceStart -
112 PreviousOriginalWhitespaceEnd +
113 Changes[i].PreviousLinePostfix.size() +
114 Changes[i - 1].CurrentLinePrefix.size();
116 Changes[i].PreviousEndOfTokenColumn =
117 Changes[i - 1].StartOfTokenColumn + Changes[i - 1].TokenLength;
119 Changes[i - 1].IsTrailingComment =
120 (Changes[i].NewlinesBefore > 0 || Changes[i].Kind ==
tok::eof) &&
121 Changes[i - 1].
Kind == tok::comment;
125 Changes.back().TokenLength = 0;
126 Changes.back().IsTrailingComment = Changes.back().Kind == tok::comment;
128 const WhitespaceManager::Change *LastBlockComment =
nullptr;
129 for (
auto &Change : Changes) {
130 Change.StartOfBlockComment =
nullptr;
131 Change.IndentationOffset = 0;
132 if (Change.Kind == tok::comment) {
133 LastBlockComment = &Change;
134 }
else if (Change.Kind == tok::unknown) {
135 if ((Change.StartOfBlockComment = LastBlockComment))
136 Change.IndentationOffset =
137 Change.StartOfTokenColumn -
138 Change.StartOfBlockComment->StartOfTokenColumn;
140 LastBlockComment =
nullptr;
150 void WhitespaceManager::alignConsecutiveAssignments() {
151 if (!
Style.AlignConsecutiveAssignments)
154 unsigned MinColumn = 0;
155 unsigned StartOfSequence = 0;
156 unsigned EndOfSequence = 0;
157 bool FoundAssignmentOnLine =
false;
158 bool FoundLeftParenOnLine =
false;
159 unsigned CurrentLine = 0;
161 auto AlignSequence = [&] {
162 alignConsecutiveAssignments(StartOfSequence, EndOfSequence, MinColumn);
168 for (
unsigned i = 0, e = Changes.size(); i != e; ++i) {
169 if (Changes[i].NewlinesBefore != 0) {
170 CurrentLine += Changes[i].NewlinesBefore;
171 if (StartOfSequence > 0 &&
172 (Changes[i].NewlinesBefore > 1 || !FoundAssignmentOnLine)) {
176 FoundAssignmentOnLine =
false;
177 FoundLeftParenOnLine =
false;
180 if ((Changes[i].
Kind == tok::equal &&
181 (FoundAssignmentOnLine || ((Changes[i].NewlinesBefore > 0 ||
182 Changes[i + 1].NewlinesBefore > 0)))) ||
183 (!FoundLeftParenOnLine && Changes[i].
Kind == tok::r_paren)) {
184 if (StartOfSequence > 0)
186 }
else if (Changes[i].
Kind == tok::l_paren) {
187 FoundLeftParenOnLine =
true;
188 if (!FoundAssignmentOnLine && StartOfSequence > 0)
190 }
else if (!FoundAssignmentOnLine && !FoundLeftParenOnLine &&
191 Changes[i].
Kind == tok::equal) {
192 FoundAssignmentOnLine =
true;
194 if (StartOfSequence == 0)
197 unsigned ChangeMinColumn = Changes[i].StartOfTokenColumn;
198 MinColumn = std::max(MinColumn, ChangeMinColumn);
202 if (StartOfSequence > 0) {
203 EndOfSequence = Changes.size();
208 void WhitespaceManager::alignConsecutiveAssignments(
unsigned Start,
211 bool AlignedAssignment =
false;
212 int PreviousShift = 0;
213 for (
unsigned i = Start; i !=
End; ++i) {
215 if (Changes[i].NewlinesBefore > 0)
216 AlignedAssignment =
false;
217 if (!AlignedAssignment && Changes[i].
Kind == tok::equal) {
218 Shift = Column - Changes[i].StartOfTokenColumn;
219 AlignedAssignment =
true;
220 PreviousShift =
Shift;
223 Changes[i].Spaces +=
Shift;
224 if (i + 1 != Changes.size())
225 Changes[i + 1].PreviousEndOfTokenColumn += Shift;
226 Changes[i].StartOfTokenColumn +=
Shift;
227 if (AlignedAssignment) {
228 Changes[i].StartOfTokenColumn += PreviousShift;
229 if (i + 1 != Changes.size())
230 Changes[i + 1].PreviousEndOfTokenColumn += PreviousShift;
235 void WhitespaceManager::alignTrailingComments() {
236 unsigned MinColumn = 0;
238 unsigned StartOfSequence = 0;
239 bool BreakBeforeNext =
false;
240 unsigned Newlines = 0;
241 for (
unsigned i = 0, e = Changes.size(); i != e; ++i) {
242 if (Changes[i].StartOfBlockComment)
244 Newlines += Changes[i].NewlinesBefore;
245 if (!Changes[i].IsTrailingComment)
248 unsigned ChangeMinColumn = Changes[i].StartOfTokenColumn;
249 unsigned ChangeMaxColumn =
Style.ColumnLimit - Changes[i].TokenLength;
250 if (i + 1 != e && Changes[i + 1].ContinuesPPDirective)
251 ChangeMaxColumn -= 2;
254 bool FollowsRBraceInColumn0 = i > 0 && Changes[i].NewlinesBefore == 0 &&
255 Changes[i - 1].Kind == tok::r_brace &&
256 Changes[i - 1].StartOfTokenColumn == 0;
257 bool WasAlignedWithStartOfNextLine =
false;
258 if (Changes[i].NewlinesBefore == 1) {
259 unsigned CommentColumn =
SourceMgr.getSpellingColumnNumber(
260 Changes[i].OriginalWhitespaceRange.getEnd());
261 for (
unsigned j = i + 1; j != e; ++j) {
262 if (Changes[j].
Kind != tok::comment) {
263 unsigned NextColumn =
SourceMgr.getSpellingColumnNumber(
264 Changes[j].OriginalWhitespaceRange.getEnd());
267 WasAlignedWithStartOfNextLine =
268 CommentColumn == NextColumn ||
269 CommentColumn == NextColumn +
Style.IndentWidth;
274 if (!
Style.AlignTrailingComments || FollowsRBraceInColumn0) {
275 alignTrailingComments(StartOfSequence, i, MinColumn);
276 MinColumn = ChangeMinColumn;
277 MaxColumn = ChangeMinColumn;
279 }
else if (BreakBeforeNext || Newlines > 1 ||
280 (ChangeMinColumn > MaxColumn || ChangeMaxColumn < MinColumn) ||
283 (Changes[i].NewlinesBefore == 1 && i > 0 &&
284 !Changes[i - 1].IsTrailingComment) ||
285 WasAlignedWithStartOfNextLine) {
286 alignTrailingComments(StartOfSequence, i, MinColumn);
287 MinColumn = ChangeMinColumn;
288 MaxColumn = ChangeMaxColumn;
291 MinColumn = std::max(MinColumn, ChangeMinColumn);
292 MaxColumn = std::min(MaxColumn, ChangeMaxColumn);
295 (i == 0) || (Changes[i].NewlinesBefore > 1) ||
298 (Changes[i].NewlinesBefore == 1 && StartOfSequence == i);
301 alignTrailingComments(StartOfSequence, Changes.size(), MinColumn);
304 void WhitespaceManager::alignTrailingComments(
unsigned Start,
unsigned End,
306 for (
unsigned i = Start; i !=
End; ++i) {
308 if (Changes[i].IsTrailingComment) {
309 Shift = Column - Changes[i].StartOfTokenColumn;
311 if (Changes[i].StartOfBlockComment) {
312 Shift = Changes[i].IndentationOffset +
313 Changes[i].StartOfBlockComment->StartOfTokenColumn -
314 Changes[i].StartOfTokenColumn;
317 Changes[i].Spaces +=
Shift;
319 Changes[i + 1].PreviousEndOfTokenColumn +=
Shift;
320 Changes[i].StartOfTokenColumn +=
Shift;
324 void WhitespaceManager::alignEscapedNewlines() {
325 unsigned MaxEndOfLine =
326 Style.AlignEscapedNewlinesLeft ? 0 :
Style.ColumnLimit;
327 unsigned StartOfMacro = 0;
328 for (
unsigned i = 1, e = Changes.size(); i < e; ++i) {
329 Change &
C = Changes[i];
330 if (C.NewlinesBefore > 0) {
331 if (C.ContinuesPPDirective) {
332 MaxEndOfLine = std::max(C.PreviousEndOfTokenColumn + 2, MaxEndOfLine);
334 alignEscapedNewlines(StartOfMacro + 1, i, MaxEndOfLine);
335 MaxEndOfLine =
Style.AlignEscapedNewlinesLeft ? 0 :
Style.ColumnLimit;
340 alignEscapedNewlines(StartOfMacro + 1, Changes.size(), MaxEndOfLine);
343 void WhitespaceManager::alignEscapedNewlines(
unsigned Start,
unsigned End,
345 for (
unsigned i = Start; i <
End; ++i) {
346 Change &C = Changes[i];
347 if (C.NewlinesBefore > 0) {
348 assert(C.ContinuesPPDirective);
349 if (C.PreviousEndOfTokenColumn + 1 > Column)
350 C.EscapedNewlineColumn = 0;
352 C.EscapedNewlineColumn =
Column;
357 void WhitespaceManager::generateChanges() {
358 for (
unsigned i = 0, e = Changes.size(); i != e; ++i) {
359 const Change &C = Changes[i];
361 assert(Changes[i - 1].OriginalWhitespaceRange.getBegin() !=
362 C.OriginalWhitespaceRange.getBegin() &&
363 "Generating two replacements for the same location");
365 if (C.CreateReplacement) {
366 std::string ReplacementText = C.PreviousLinePostfix;
367 if (C.ContinuesPPDirective)
368 appendNewlineText(ReplacementText, C.NewlinesBefore,
369 C.PreviousEndOfTokenColumn, C.EscapedNewlineColumn);
371 appendNewlineText(ReplacementText, C.NewlinesBefore);
372 appendIndentText(ReplacementText, C.IndentLevel, std::max(0, C.Spaces),
373 C.StartOfTokenColumn - std::max(0, C.Spaces));
374 ReplacementText.append(C.CurrentLinePrefix);
375 storeReplacement(C.OriginalWhitespaceRange, ReplacementText);
380 void WhitespaceManager::storeReplacement(
const SourceRange &Range,
382 unsigned WhitespaceLength =
SourceMgr.getFileOffset(Range.getEnd()) -
383 SourceMgr.getFileOffset(Range.getBegin());
385 if (StringRef(
SourceMgr.getCharacterData(Range.getBegin()),
386 WhitespaceLength) == Text)
388 Replaces.insert(tooling::Replacement(
392 void WhitespaceManager::appendNewlineText(std::string &Text,
394 for (
unsigned i = 0; i < Newlines; ++i)
395 Text.append(UseCRLF ?
"\r\n" :
"\n");
398 void WhitespaceManager::appendNewlineText(std::string &Text,
unsigned Newlines,
399 unsigned PreviousEndOfTokenColumn,
400 unsigned EscapedNewlineColumn) {
403 std::min<int>(EscapedNewlineColumn - 1, PreviousEndOfTokenColumn);
404 for (
unsigned i = 0; i < Newlines; ++i) {
405 Text.append(EscapedNewlineColumn - Offset - 1,
' ');
406 Text.append(UseCRLF ?
"\\\r\n" :
"\\\n");
412 void WhitespaceManager::appendIndentText(std::string &Text,
413 unsigned IndentLevel,
unsigned Spaces,
414 unsigned WhitespaceStartColumn) {
415 switch (
Style.UseTab) {
417 Text.append(Spaces,
' ');
420 unsigned FirstTabWidth =
421 Style.TabWidth - WhitespaceStartColumn %
Style.TabWidth;
423 if (FirstTabWidth +
Style.TabWidth <= Spaces) {
424 Spaces -= FirstTabWidth;
427 Text.append(Spaces /
Style.TabWidth,
'\t');
428 Text.append(Spaces %
Style.TabWidth,
' ');
432 if (WhitespaceStartColumn == 0) {
433 unsigned Indentation = IndentLevel *
Style.IndentWidth;
436 if (Indentation > Spaces)
437 Indentation = Spaces;
438 unsigned Tabs = Indentation /
Style.TabWidth;
439 Text.append(Tabs,
'\t');
440 Spaces -= Tabs *
Style.TabWidth;
442 Text.append(Spaces,
' ');
SourceLocation getLocWithOffset(int Offset) const
Return a source location with the specified offset from this SourceLocation.
tok::TokenKind getKind() const
WhitespaceManager class manages whitespace around tokens and their replacements.
bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const
Determines the order of 2 source locations in the translation unit.
static CharSourceRange getCharRange(SourceRange R)
Encodes a location in the source. The SourceManager can decode this to get at the full include stack...
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
A trivial tuple used to represent a source range.