blob: e3ca32c1865281d6f4b02eb72de5ea511932d7cc [file] [log] [blame]
Alexander Kornienko70ce7882013-04-15 14:28:00 +00001//===--- WhitespaceManager.cpp - Format C++ code --------------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// \brief This file implements WhitespaceManager class.
12///
13//===----------------------------------------------------------------------===//
14
15#include "WhitespaceManager.h"
16#include "llvm/ADT/STLExtras.h"
17
18namespace clang {
19namespace format {
20
Manuel Klimeke573c3f2013-05-22 12:51:29 +000021bool
22WhitespaceManager::Change::IsBeforeInFile::operator()(const Change &C1,
23 const Change &C2) const {
24 return SourceMgr.isBeforeInTranslationUnit(
25 C1.OriginalWhitespaceRange.getBegin(),
26 C2.OriginalWhitespaceRange.getBegin());
27}
Daniel Jasper2972d042013-04-25 08:56:26 +000028
Manuel Klimeke573c3f2013-05-22 12:51:29 +000029WhitespaceManager::Change::Change(
30 bool CreateReplacement, const SourceRange &OriginalWhitespaceRange,
31 unsigned Spaces, unsigned StartOfTokenColumn, unsigned NewlinesBefore,
32 StringRef PreviousLinePostfix, StringRef CurrentLinePrefix,
33 tok::TokenKind Kind, bool ContinuesPPDirective)
34 : CreateReplacement(CreateReplacement),
35 OriginalWhitespaceRange(OriginalWhitespaceRange),
36 StartOfTokenColumn(StartOfTokenColumn), NewlinesBefore(NewlinesBefore),
37 PreviousLinePostfix(PreviousLinePostfix),
38 CurrentLinePrefix(CurrentLinePrefix), Kind(Kind),
39 ContinuesPPDirective(ContinuesPPDirective), Spaces(Spaces) {}
40
Manuel Klimekb3987012013-05-29 14:47:47 +000041void WhitespaceManager::replaceWhitespace(const FormatToken &Tok,
Manuel Klimeke573c3f2013-05-22 12:51:29 +000042 unsigned Newlines, unsigned Spaces,
43 unsigned StartOfTokenColumn,
44 bool InPPDirective) {
Manuel Klimekdcb3f2a2013-05-28 13:42:28 +000045 Changes.push_back(
Manuel Klimekb3987012013-05-29 14:47:47 +000046 Change(true, Tok.WhitespaceRange, Spaces, StartOfTokenColumn, Newlines,
47 "", "", Tok.Tok.getKind(), InPPDirective && !Tok.IsFirst));
Alexander Kornienko70ce7882013-04-15 14:28:00 +000048}
49
Manuel Klimeke573c3f2013-05-22 12:51:29 +000050void WhitespaceManager::addUntouchableToken(const FormatToken &Tok,
51 bool InPPDirective) {
Manuel Klimekad3094b2013-05-23 10:56:37 +000052 Changes.push_back(
53 Change(false, Tok.WhitespaceRange, /*Spaces=*/0,
54 SourceMgr.getSpellingColumnNumber(Tok.Tok.getLocation()) - 1,
55 Tok.NewlinesBefore, "", "", Tok.Tok.getKind(),
56 InPPDirective && !Tok.IsFirst));
Alexander Kornienko70ce7882013-04-15 14:28:00 +000057}
58
Alexander Kornienko2b2faa52013-06-11 16:01:49 +000059void WhitespaceManager::replaceWhitespaceInToken(
60 const FormatToken &Tok, unsigned Offset, unsigned ReplaceChars,
61 StringRef PreviousPostfix, StringRef CurrentPrefix, bool InPPDirective,
62 unsigned Newlines, unsigned Spaces) {
Manuel Klimeke573c3f2013-05-22 12:51:29 +000063 Changes.push_back(Change(
64 true, SourceRange(Tok.getStartOfNonWhitespace().getLocWithOffset(Offset),
65 Tok.getStartOfNonWhitespace().getLocWithOffset(
66 Offset + ReplaceChars)),
Alexander Kornienko2b2faa52013-06-11 16:01:49 +000067 Spaces, Spaces, Newlines, PreviousPostfix, CurrentPrefix,
Manuel Klimeke573c3f2013-05-22 12:51:29 +000068 // FIXME: Unify token adjustment, so we don't split it between
69 // BreakableToken and the WhitespaceManager. That would also allow us to
70 // correctly store a tok::TokenKind instead of rolling our own enum.
71 tok::unknown, InPPDirective && !Tok.IsFirst));
Alexander Kornienko70ce7882013-04-15 14:28:00 +000072}
73
Manuel Klimeke573c3f2013-05-22 12:51:29 +000074const tooling::Replacements &WhitespaceManager::generateReplacements() {
75 if (Changes.empty())
76 return Replaces;
77
78 std::sort(Changes.begin(), Changes.end(), Change::IsBeforeInFile(SourceMgr));
79 calculateLineBreakInformation();
80 alignTrailingComments();
81 alignEscapedNewlines();
82 generateChanges();
83
84 return Replaces;
85}
86
87void WhitespaceManager::calculateLineBreakInformation() {
88 Changes[0].PreviousEndOfTokenColumn = 0;
89 for (unsigned i = 1, e = Changes.size(); i != e; ++i) {
90 unsigned OriginalWhitespaceStart =
91 SourceMgr.getFileOffset(Changes[i].OriginalWhitespaceRange.getBegin());
92 unsigned PreviousOriginalWhitespaceEnd = SourceMgr.getFileOffset(
93 Changes[i - 1].OriginalWhitespaceRange.getEnd());
94 Changes[i - 1].TokenLength =
95 OriginalWhitespaceStart - PreviousOriginalWhitespaceEnd +
96 Changes[i].PreviousLinePostfix.size() +
97 Changes[i - 1].CurrentLinePrefix.size();
98
99 Changes[i].PreviousEndOfTokenColumn =
100 Changes[i - 1].StartOfTokenColumn + Changes[i - 1].TokenLength;
101
102 Changes[i - 1].IsTrailingComment =
103 (Changes[i].NewlinesBefore > 0 || Changes[i].Kind == tok::eof) &&
104 Changes[i - 1].Kind == tok::comment;
105 }
Manuel Klimek0cd57b52013-05-22 14:01:08 +0000106 // FIXME: The last token is currently not always an eof token; in those
107 // cases, setting TokenLength of the last token to 0 is wrong.
108 Changes.back().TokenLength = 0;
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000109 Changes.back().IsTrailingComment = Changes.back().Kind == tok::comment;
110}
111
112void WhitespaceManager::alignTrailingComments() {
113 unsigned MinColumn = 0;
114 unsigned MaxColumn = UINT_MAX;
115 unsigned StartOfSequence = 0;
116 bool BreakBeforeNext = false;
117 unsigned Newlines = 0;
118 for (unsigned i = 0, e = Changes.size(); i != e; ++i) {
119 unsigned ChangeMinColumn = Changes[i].StartOfTokenColumn;
120 // FIXME: Correctly handle ChangeMaxColumn in PP directives.
121 unsigned ChangeMaxColumn = Style.ColumnLimit - Changes[i].TokenLength;
122 Newlines += Changes[i].NewlinesBefore;
123 if (Changes[i].IsTrailingComment) {
Manuel Klimekebfb88c2013-05-23 11:42:52 +0000124 bool WasAlignedWithStartOfNextLine =
125 // A comment on its own line.
126 Changes[i].NewlinesBefore == 1 &&
127 // Not the last line.
128 i + 1 != e &&
129 // The start of the next token was previously aligned with
130 // the start of this comment.
131 (SourceMgr.getSpellingColumnNumber(
132 Changes[i].OriginalWhitespaceRange.getEnd()) ==
133 SourceMgr.getSpellingColumnNumber(
134 Changes[i + 1].OriginalWhitespaceRange.getEnd())) &&
135 // Which is not a comment itself.
136 Changes[i + 1].Kind != tok::comment;
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000137 if (BreakBeforeNext || Newlines > 1 ||
138 (ChangeMinColumn > MaxColumn || ChangeMaxColumn < MinColumn) ||
139 // Break the comment sequence if the previous line did not end
140 // in a trailing comment.
141 (Changes[i].NewlinesBefore == 1 && i > 0 &&
Manuel Klimekebfb88c2013-05-23 11:42:52 +0000142 !Changes[i - 1].IsTrailingComment) ||
143 WasAlignedWithStartOfNextLine) {
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000144 alignTrailingComments(StartOfSequence, i, MinColumn);
145 MinColumn = ChangeMinColumn;
146 MaxColumn = ChangeMaxColumn;
147 StartOfSequence = i;
148 } else {
149 MinColumn = std::max(MinColumn, ChangeMinColumn);
150 MaxColumn = std::min(MaxColumn, ChangeMaxColumn);
151 }
Manuel Klimek854ca792013-05-23 20:46:07 +0000152 BreakBeforeNext =
153 (i == 0) || (Changes[i].NewlinesBefore > 1) ||
154 // Never start a sequence with a comment at the beginning of
155 // the line.
156 (Changes[i].NewlinesBefore == 1 && StartOfSequence == i);
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000157 Newlines = 0;
158 }
159 }
160 alignTrailingComments(StartOfSequence, Changes.size(), MinColumn);
161}
162
163void WhitespaceManager::alignTrailingComments(unsigned Start, unsigned End,
164 unsigned Column) {
165 for (unsigned i = Start; i != End; ++i) {
166 if (Changes[i].IsTrailingComment) {
167 assert(Column >= Changes[i].StartOfTokenColumn);
168 Changes[i].Spaces += Column - Changes[i].StartOfTokenColumn;
169 Changes[i].StartOfTokenColumn = Column;
170 }
171 }
172}
173
174void WhitespaceManager::alignEscapedNewlines() {
175 unsigned MaxEndOfLine = 0;
176 unsigned StartOfMacro = 0;
177 for (unsigned i = 1, e = Changes.size(); i < e; ++i) {
178 Change &C = Changes[i];
179 if (C.NewlinesBefore > 0) {
180 if (C.ContinuesPPDirective) {
181 if (Style.AlignEscapedNewlinesLeft)
182 MaxEndOfLine = std::max(C.PreviousEndOfTokenColumn + 2, MaxEndOfLine);
183 else
184 MaxEndOfLine = Style.ColumnLimit;
185 } else {
186 alignEscapedNewlines(StartOfMacro + 1, i, MaxEndOfLine);
187 MaxEndOfLine = 0;
188 StartOfMacro = i;
189 }
190 }
191 }
192 alignEscapedNewlines(StartOfMacro + 1, Changes.size(), MaxEndOfLine);
193}
194
195void WhitespaceManager::alignEscapedNewlines(unsigned Start, unsigned End,
196 unsigned Column) {
197 for (unsigned i = Start; i < End; ++i) {
198 Change &C = Changes[i];
199 if (C.NewlinesBefore > 0) {
200 assert(C.ContinuesPPDirective);
201 if (C.PreviousEndOfTokenColumn + 1 > Column)
202 C.EscapedNewlineColumn = 0;
203 else
204 C.EscapedNewlineColumn = Column;
205 }
206 }
207}
208
209void WhitespaceManager::generateChanges() {
210 for (unsigned i = 0, e = Changes.size(); i != e; ++i) {
211 const Change &C = Changes[i];
212 if (C.CreateReplacement) {
213 std::string ReplacementText =
214 C.PreviousLinePostfix +
215 (C.ContinuesPPDirective
Alexander Kornienko2b2faa52013-06-11 16:01:49 +0000216 ? getNewlineText(C.NewlinesBefore, C.Spaces,
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000217 C.PreviousEndOfTokenColumn,
218 C.EscapedNewlineColumn)
Alexander Kornienko2b2faa52013-06-11 16:01:49 +0000219 : getNewlineText(C.NewlinesBefore, C.Spaces)) +
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000220 C.CurrentLinePrefix;
221 storeReplacement(C.OriginalWhitespaceRange, ReplacementText);
222 }
223 }
224}
225
226void WhitespaceManager::storeReplacement(const SourceRange &Range,
227 StringRef Text) {
228 unsigned WhitespaceLength = SourceMgr.getFileOffset(Range.getEnd()) -
229 SourceMgr.getFileOffset(Range.getBegin());
230 // Don't create a replacement, if it does not change anything.
231 if (StringRef(SourceMgr.getCharacterData(Range.getBegin()),
232 WhitespaceLength) ==
233 Text)
234 return;
235 Replaces.insert(tooling::Replacement(
236 SourceMgr, CharSourceRange::getCharRange(Range), Text));
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000237}
238
Alexander Kornienko2b2faa52013-06-11 16:01:49 +0000239std::string WhitespaceManager::getNewlineText(unsigned Newlines,
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000240 unsigned Spaces) {
Alexander Kornienko2b2faa52013-06-11 16:01:49 +0000241 return std::string(Newlines, '\n') + getIndentText(Spaces);
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000242}
243
Alexander Kornienko2b2faa52013-06-11 16:01:49 +0000244std::string WhitespaceManager::getNewlineText(unsigned Newlines,
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000245 unsigned Spaces,
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000246 unsigned PreviousEndOfTokenColumn,
Daniel Jasper2972d042013-04-25 08:56:26 +0000247 unsigned EscapedNewlineColumn) {
Alexander Kornienko2b2faa52013-06-11 16:01:49 +0000248 std::string NewlineText;
249 if (Newlines > 0) {
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000250 unsigned Offset =
Manuel Klimeke573c3f2013-05-22 12:51:29 +0000251 std::min<int>(EscapedNewlineColumn - 1, PreviousEndOfTokenColumn);
Alexander Kornienko2b2faa52013-06-11 16:01:49 +0000252 for (unsigned i = 0; i < Newlines; ++i) {
253 NewlineText += std::string(EscapedNewlineColumn - Offset - 1, ' ');
254 NewlineText += "\\\n";
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000255 Offset = 0;
256 }
257 }
Alexander Kornienko2b2faa52013-06-11 16:01:49 +0000258 return NewlineText + getIndentText(Spaces);
Manuel Klimek7c9a93e2013-05-13 09:22:11 +0000259}
260
261std::string WhitespaceManager::getIndentText(unsigned Spaces) {
Manuel Klimek967d9e92013-05-13 12:53:04 +0000262 if (!Style.UseTab)
Manuel Klimek7c9a93e2013-05-13 09:22:11 +0000263 return std::string(Spaces, ' ');
Manuel Klimek967d9e92013-05-13 12:53:04 +0000264
Manuel Klimek7c9a93e2013-05-13 09:22:11 +0000265 return std::string(Spaces / Style.IndentWidth, '\t') +
266 std::string(Spaces % Style.IndentWidth, ' ');
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000267}
268
Alexander Kornienko70ce7882013-04-15 14:28:00 +0000269} // namespace format
270} // namespace clang