Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1 | //===--- Format.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 functions declared in Format.h. This will be |
| 12 | /// split into separate files as we go. |
| 13 | /// |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 14 | //===----------------------------------------------------------------------===// |
| 15 | |
Manuel Klimek | 2499810 | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 16 | #define DEBUG_TYPE "format-formatter" |
| 17 | |
Daniel Jasper | 7a6d09b | 2013-01-29 21:01:14 +0000 | [diff] [blame] | 18 | #include "TokenAnnotator.h" |
Chandler Carruth | 3a02247 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 19 | #include "UnwrappedLineParser.h" |
Alexander Kornienko | 5b7157a | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 20 | #include "clang/Basic/Diagnostic.h" |
Daniel Jasper | ab7654e | 2012-12-21 10:20:02 +0000 | [diff] [blame] | 21 | #include "clang/Basic/OperatorPrecedence.h" |
Chandler Carruth | 44eb4f6 | 2013-01-02 10:28:36 +0000 | [diff] [blame] | 22 | #include "clang/Basic/SourceManager.h" |
Manuel Klimek | 2499810 | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 23 | #include "clang/Format/Format.h" |
Alexander Kornienko | 5b7157a | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 24 | #include "clang/Frontend/TextDiagnosticPrinter.h" |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 25 | #include "clang/Lex/Lexer.h" |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 26 | #include "llvm/ADT/STLExtras.h" |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 27 | #include "llvm/Support/Allocator.h" |
Manuel Klimek | 2499810 | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 28 | #include "llvm/Support/Debug.h" |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 29 | #include <queue> |
Daniel Jasper | 8b52971 | 2012-12-04 13:02:32 +0000 | [diff] [blame] | 30 | #include <string> |
| 31 | |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 32 | namespace clang { |
| 33 | namespace format { |
| 34 | |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 35 | FormatStyle getLLVMStyle() { |
| 36 | FormatStyle LLVMStyle; |
| 37 | LLVMStyle.ColumnLimit = 80; |
| 38 | LLVMStyle.MaxEmptyLinesToKeep = 1; |
Daniel Jasper | 7fce3ab | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 39 | LLVMStyle.PointerBindsToType = false; |
| 40 | LLVMStyle.DerivePointerBinding = false; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 41 | LLVMStyle.AccessModifierOffset = -2; |
Daniel Jasper | 7fce3ab | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 42 | LLVMStyle.Standard = FormatStyle::LS_Cpp03; |
Alexander Kornienko | 578fdd8 | 2012-12-06 18:03:27 +0000 | [diff] [blame] | 43 | LLVMStyle.IndentCaseLabels = false; |
Daniel Jasper | 5ad1e19 | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 44 | LLVMStyle.SpacesBeforeTrailingComments = 1; |
Daniel Jasper | 9278eb9 | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 45 | LLVMStyle.BinPackParameters = true; |
Daniel Jasper | f7db433 | 2013-01-29 16:03:49 +0000 | [diff] [blame] | 46 | LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true; |
Daniel Jasper | 2408a8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 47 | LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false; |
Daniel Jasper | 1b750ed | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 48 | LLVMStyle.AllowShortIfStatementsOnASingleLine = false; |
Nico Weber | a608775 | 2013-01-10 20:12:55 +0000 | [diff] [blame] | 49 | LLVMStyle.ObjCSpaceBeforeProtocolList = true; |
Daniel Jasper | 3a9370c | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 50 | LLVMStyle.PenaltyExcessCharacter = 1000000; |
Daniel Jasper | b9caeac | 2013-02-13 20:33:44 +0000 | [diff] [blame] | 51 | LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 5; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 52 | return LLVMStyle; |
| 53 | } |
| 54 | |
| 55 | FormatStyle getGoogleStyle() { |
| 56 | FormatStyle GoogleStyle; |
| 57 | GoogleStyle.ColumnLimit = 80; |
| 58 | GoogleStyle.MaxEmptyLinesToKeep = 1; |
Daniel Jasper | 7fce3ab | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 59 | GoogleStyle.PointerBindsToType = true; |
| 60 | GoogleStyle.DerivePointerBinding = true; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 61 | GoogleStyle.AccessModifierOffset = -1; |
Daniel Jasper | 7fce3ab | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 62 | GoogleStyle.Standard = FormatStyle::LS_Auto; |
Alexander Kornienko | 578fdd8 | 2012-12-06 18:03:27 +0000 | [diff] [blame] | 63 | GoogleStyle.IndentCaseLabels = true; |
Daniel Jasper | 5ad1e19 | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 64 | GoogleStyle.SpacesBeforeTrailingComments = 2; |
Daniel Jasper | 2cf17bf | 2013-02-27 09:47:53 +0000 | [diff] [blame] | 65 | GoogleStyle.BinPackParameters = true; |
Daniel Jasper | f7db433 | 2013-01-29 16:03:49 +0000 | [diff] [blame] | 66 | GoogleStyle.AllowAllParametersOfDeclarationOnNextLine = true; |
Daniel Jasper | 2408a8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 67 | GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true; |
Daniel Jasper | ced17f8 | 2013-01-16 15:44:34 +0000 | [diff] [blame] | 68 | GoogleStyle.AllowShortIfStatementsOnASingleLine = false; |
Nico Weber | a608775 | 2013-01-10 20:12:55 +0000 | [diff] [blame] | 69 | GoogleStyle.ObjCSpaceBeforeProtocolList = false; |
Daniel Jasper | 3a9370c | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 70 | GoogleStyle.PenaltyExcessCharacter = 1000000; |
Daniel Jasper | b9caeac | 2013-02-13 20:33:44 +0000 | [diff] [blame] | 71 | GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 100; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 72 | return GoogleStyle; |
| 73 | } |
| 74 | |
Daniel Jasper | 1b750ed | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 75 | FormatStyle getChromiumStyle() { |
| 76 | FormatStyle ChromiumStyle = getGoogleStyle(); |
Daniel Jasper | f7db433 | 2013-01-29 16:03:49 +0000 | [diff] [blame] | 77 | ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false; |
Daniel Jasper | 2cf17bf | 2013-02-27 09:47:53 +0000 | [diff] [blame] | 78 | ChromiumStyle.BinPackParameters = false; |
Daniel Jasper | 7fce3ab | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 79 | ChromiumStyle.Standard = FormatStyle::LS_Cpp03; |
| 80 | ChromiumStyle.DerivePointerBinding = false; |
Daniel Jasper | 1b750ed | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 81 | return ChromiumStyle; |
| 82 | } |
| 83 | |
Daniel Jasper | 94f0e13 | 2013-02-06 20:07:35 +0000 | [diff] [blame] | 84 | static bool isTrailingComment(const AnnotatedToken &Tok) { |
| 85 | return Tok.is(tok::comment) && |
| 86 | (Tok.Children.empty() || Tok.Children[0].MustBreakBefore); |
| 87 | } |
| 88 | |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 89 | // Returns the length of everything up to the first possible line break after |
| 90 | // the ), ], } or > matching \c Tok. |
| 91 | static unsigned getLengthToMatchingParen(const AnnotatedToken &Tok) { |
| 92 | if (Tok.MatchingParen == NULL) |
| 93 | return 0; |
| 94 | AnnotatedToken *End = Tok.MatchingParen; |
| 95 | while (!End->Children.empty() && !End->Children[0].CanBreakBefore) { |
| 96 | End = &End->Children[0]; |
| 97 | } |
| 98 | return End->TotalLength - Tok.TotalLength + 1; |
| 99 | } |
| 100 | |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 101 | static size_t |
| 102 | calculateColumnLimit(const FormatStyle &Style, bool InPPDirective) { |
| 103 | // In preprocessor directives reserve two chars for trailing " \" |
| 104 | return Style.ColumnLimit - (InPPDirective ? 2 : 0); |
| 105 | } |
| 106 | |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 107 | /// \brief Manages the whitespaces around tokens and their replacements. |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 108 | /// |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 109 | /// This includes special handling for certain constructs, e.g. the alignment of |
| 110 | /// trailing line comments. |
| 111 | class WhitespaceManager { |
| 112 | public: |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 113 | WhitespaceManager(SourceManager &SourceMgr, const FormatStyle &Style) |
| 114 | : SourceMgr(SourceMgr), Style(Style) {} |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 115 | |
| 116 | /// \brief Replaces the whitespace in front of \p Tok. Only call once for |
| 117 | /// each \c AnnotatedToken. |
| 118 | void replaceWhitespace(const AnnotatedToken &Tok, unsigned NewLines, |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 119 | unsigned Spaces, unsigned WhitespaceStartColumn) { |
Daniel Jasper | 304a986 | 2013-01-21 22:49:20 +0000 | [diff] [blame] | 120 | // 2+ newlines mean an empty line separating logic scopes. |
| 121 | if (NewLines >= 2) |
| 122 | alignComments(); |
| 123 | |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 124 | SourceLocation TokenLoc = Tok.FormatTok.Tok.getLocation(); |
| 125 | bool LineExceedsColumnLimit = Spaces + WhitespaceStartColumn + |
| 126 | Tok.FormatTok.TokenLength > Style.ColumnLimit; |
| 127 | |
Daniel Jasper | 304a986 | 2013-01-21 22:49:20 +0000 | [diff] [blame] | 128 | // Align line comments if they are trailing or if they continue other |
| 129 | // trailing comments. |
Daniel Jasper | 3324cbe | 2013-03-01 16:45:59 +0000 | [diff] [blame] | 130 | if (isTrailingComment(Tok)) { |
| 131 | // Remove the comment's trailing whitespace. |
| 132 | if (Tok.FormatTok.Tok.getLength() != Tok.FormatTok.TokenLength) |
| 133 | Replaces.insert(tooling::Replacement( |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 134 | SourceMgr, TokenLoc.getLocWithOffset(Tok.FormatTok.TokenLength), |
Daniel Jasper | 3324cbe | 2013-03-01 16:45:59 +0000 | [diff] [blame] | 135 | Tok.FormatTok.Tok.getLength() - Tok.FormatTok.TokenLength, "")); |
| 136 | |
| 137 | // Align comment with other comments. |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 138 | if ((Tok.Parent != NULL || !Comments.empty()) && |
| 139 | !LineExceedsColumnLimit) { |
| 140 | StoredComment Comment; |
| 141 | Comment.Tok = Tok.FormatTok; |
| 142 | Comment.Spaces = Spaces; |
| 143 | Comment.NewLines = NewLines; |
| 144 | Comment.MinColumn = |
| 145 | NewLines > 0 ? Spaces : WhitespaceStartColumn + Spaces; |
| 146 | Comment.MaxColumn = Style.ColumnLimit - Tok.FormatTok.TokenLength; |
| 147 | Comment.Untouchable = false; |
| 148 | Comments.push_back(Comment); |
| 149 | return; |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 150 | } |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 151 | } |
Daniel Jasper | 304a986 | 2013-01-21 22:49:20 +0000 | [diff] [blame] | 152 | |
| 153 | // If this line does not have a trailing comment, align the stored comments. |
Daniel Jasper | 94f0e13 | 2013-02-06 20:07:35 +0000 | [diff] [blame] | 154 | if (Tok.Children.empty() && !isTrailingComment(Tok)) |
Daniel Jasper | 304a986 | 2013-01-21 22:49:20 +0000 | [diff] [blame] | 155 | alignComments(); |
Alexander Kornienko | dd8ed85 | 2013-03-14 16:10:54 +0000 | [diff] [blame] | 156 | |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 157 | if (Tok.Type == TT_BlockComment) { |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 158 | indentBlockComment(Tok, Spaces, WhitespaceStartColumn, NewLines, false); |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 159 | } else if (Tok.Type == TT_LineComment && LineExceedsColumnLimit) { |
| 160 | StringRef Line(SourceMgr.getCharacterData(TokenLoc), |
| 161 | Tok.FormatTok.TokenLength); |
| 162 | int StartColumn = Spaces + (NewLines == 0 ? WhitespaceStartColumn : 0); |
| 163 | StringRef Prefix = getLineCommentPrefix(Line); |
| 164 | std::string NewPrefix = std::string(StartColumn, ' ') + Prefix.str(); |
| 165 | splitLineInComment(Tok.FormatTok, Line.substr(Prefix.size()), |
| 166 | StartColumn + Prefix.size(), NewPrefix, |
| 167 | /*InPPDirective=*/ false, |
| 168 | /*CommentHasMoreLines=*/ false); |
| 169 | } |
Alexander Kornienko | dd8ed85 | 2013-03-14 16:10:54 +0000 | [diff] [blame] | 170 | |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 171 | storeReplacement(Tok.FormatTok, getNewLineText(NewLines, Spaces)); |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | /// \brief Like \c replaceWhitespace, but additionally adds right-aligned |
| 175 | /// backslashes to escape newlines inside a preprocessor directive. |
| 176 | /// |
| 177 | /// This function and \c replaceWhitespace have the same behavior if |
| 178 | /// \c Newlines == 0. |
| 179 | void replacePPWhitespace(const AnnotatedToken &Tok, unsigned NewLines, |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 180 | unsigned Spaces, unsigned WhitespaceStartColumn) { |
| 181 | if (Tok.Type == TT_BlockComment) |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 182 | indentBlockComment(Tok, Spaces, WhitespaceStartColumn, NewLines, true); |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 183 | |
| 184 | storeReplacement(Tok.FormatTok, |
| 185 | getNewLineText(NewLines, Spaces, WhitespaceStartColumn)); |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 186 | } |
| 187 | |
| 188 | /// \brief Inserts a line break into the middle of a token. |
| 189 | /// |
| 190 | /// Will break at \p Offset inside \p Tok, putting \p Prefix before the line |
| 191 | /// break and \p Postfix before the rest of the token starts in the next line. |
| 192 | /// |
| 193 | /// \p InPPDirective, \p Spaces, \p WhitespaceStartColumn and \p Style are |
| 194 | /// used to generate the correct line break. |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 195 | void breakToken(const FormatToken &Tok, unsigned Offset, |
| 196 | unsigned ReplaceChars, StringRef Prefix, StringRef Postfix, |
| 197 | bool InPPDirective, unsigned Spaces, |
| 198 | unsigned WhitespaceStartColumn) { |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 199 | std::string NewLineText; |
| 200 | if (!InPPDirective) |
| 201 | NewLineText = getNewLineText(1, Spaces); |
| 202 | else |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 203 | NewLineText = getNewLineText(1, Spaces, WhitespaceStartColumn); |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 204 | std::string ReplacementText = (Prefix + NewLineText + Postfix).str(); |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 205 | SourceLocation Location = Tok.Tok.getLocation().getLocWithOffset(Offset); |
| 206 | Replaces.insert(tooling::Replacement(SourceMgr, Location, ReplaceChars, |
| 207 | ReplacementText)); |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 208 | } |
| 209 | |
| 210 | /// \brief Returns all the \c Replacements created during formatting. |
| 211 | const tooling::Replacements &generateReplacements() { |
| 212 | alignComments(); |
| 213 | return Replaces; |
| 214 | } |
| 215 | |
Daniel Jasper | bc0fa39 | 2013-03-22 16:25:51 +0000 | [diff] [blame] | 216 | void addUntouchableComment(unsigned Column) { |
| 217 | StoredComment Comment; |
| 218 | Comment.MinColumn = Column; |
| 219 | Comment.MaxColumn = Column; |
| 220 | Comment.Untouchable = true; |
| 221 | Comments.push_back(Comment); |
| 222 | } |
| 223 | |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 224 | private: |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 225 | static StringRef getLineCommentPrefix(StringRef Comment) { |
| 226 | const char *KnownPrefixes[] = { "/// ", "///", "// ", "//" }; |
| 227 | for (size_t i = 0; i < llvm::array_lengthof(KnownPrefixes); ++i) |
| 228 | if (Comment.startswith(KnownPrefixes[i])) |
| 229 | return KnownPrefixes[i]; |
| 230 | return ""; |
| 231 | } |
| 232 | |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 233 | /// \brief Finds a common prefix of lines of a block comment to properly |
| 234 | /// indent (and possibly decorate with '*'s) added lines. |
| 235 | /// |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 236 | /// The first line is ignored (it's special and starts with /*). The number of |
| 237 | /// lines should be more than one. |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 238 | static StringRef findCommentLinesPrefix(ArrayRef<StringRef> Lines, |
| 239 | const char *PrefixChars = " *") { |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 240 | assert(Lines.size() > 1); |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 241 | StringRef Prefix(Lines[1].data(), Lines[1].find_first_not_of(PrefixChars)); |
| 242 | for (size_t i = 2; i < Lines.size(); ++i) { |
| 243 | for (size_t j = 0; j < Prefix.size() && j < Lines[i].size(); ++j) { |
| 244 | if (Prefix[j] != Lines[i][j]) { |
| 245 | Prefix = Prefix.substr(0, j); |
| 246 | break; |
| 247 | } |
| 248 | } |
| 249 | } |
| 250 | return Prefix; |
| 251 | } |
| 252 | |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 253 | /// \brief Splits one line in a line or block comment, if it doesn't fit to |
| 254 | /// provided column limit. Removes trailing whitespace in each line. |
| 255 | /// |
| 256 | /// \param Line points to the line contents without leading // or /*. |
| 257 | /// |
| 258 | /// \param StartColumn is the column where the first character of Line will be |
| 259 | /// located after formatting. |
| 260 | /// |
| 261 | /// \param LinePrefix is inserted after each line break. |
| 262 | /// |
| 263 | /// When \param InPPDirective is true, each line break will be preceded by a |
| 264 | /// backslash in the last column to make line breaks inside the comment |
| 265 | /// visually consistent with line breaks outside the comment. This only makes |
| 266 | /// sense for block comments. |
| 267 | /// |
| 268 | /// When \param CommentHasMoreLines is false, no line breaks/trailing |
| 269 | /// backslashes will be inserted after it. |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 270 | void splitLineInComment(const FormatToken &Tok, StringRef Line, |
| 271 | size_t StartColumn, StringRef LinePrefix, |
| 272 | bool InPPDirective, bool CommentHasMoreLines, |
| 273 | const char *WhiteSpaceChars = " ") { |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 274 | size_t ColumnLimit = calculateColumnLimit(Style, InPPDirective); |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 275 | const char *TokenStart = SourceMgr.getCharacterData(Tok.Tok.getLocation()); |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 276 | |
| 277 | StringRef TrimmedLine = Line.rtrim(); |
| 278 | int TrailingSpaceLength = Line.size() - TrimmedLine.size(); |
| 279 | |
| 280 | // Don't touch leading whitespace. |
| 281 | Line = TrimmedLine.ltrim(); |
| 282 | StartColumn += TrimmedLine.size() - Line.size(); |
| 283 | |
| 284 | while (Line.size() + StartColumn > ColumnLimit) { |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 285 | // Try to break at the last whitespace before the column limit. |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 286 | size_t SpacePos = |
| 287 | Line.find_last_of(WhiteSpaceChars, ColumnLimit - StartColumn + 1); |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 288 | if (SpacePos == StringRef::npos) { |
| 289 | // Try to find any whitespace in the line. |
| 290 | SpacePos = Line.find_first_of(WhiteSpaceChars); |
| 291 | if (SpacePos == StringRef::npos) // No whitespace found, give up. |
| 292 | break; |
| 293 | } |
| 294 | |
| 295 | StringRef NextCut = Line.substr(0, SpacePos).rtrim(); |
| 296 | StringRef RemainingLine = Line.substr(SpacePos).ltrim(); |
| 297 | if (RemainingLine.empty()) |
| 298 | break; |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 299 | |
| 300 | if (RemainingLine == "*/" && LinePrefix.endswith("* ")) |
| 301 | LinePrefix = LinePrefix.substr(0, LinePrefix.size() - 2); |
| 302 | |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 303 | Line = RemainingLine; |
| 304 | |
| 305 | size_t ReplaceChars = Line.begin() - NextCut.end(); |
| 306 | breakToken(Tok, NextCut.end() - TokenStart, ReplaceChars, "", LinePrefix, |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 307 | InPPDirective, 0, NextCut.size() + StartColumn); |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 308 | StartColumn = LinePrefix.size(); |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 309 | } |
| 310 | |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 311 | if (TrailingSpaceLength > 0 || (InPPDirective && CommentHasMoreLines)) { |
| 312 | // Remove trailing whitespace/insert backslash. + 1 is for \n |
| 313 | breakToken(Tok, Line.end() - TokenStart, TrailingSpaceLength + 1, "", "", |
| 314 | InPPDirective, 0, Line.size() + StartColumn); |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 315 | } |
| 316 | } |
| 317 | |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 318 | /// \brief Changes indentation of all lines in a block comment by Indent, |
| 319 | /// removes trailing whitespace from each line, splits lines that end up |
| 320 | /// exceeding the column limit. |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 321 | void indentBlockComment(const AnnotatedToken &Tok, int Indent, |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 322 | int WhitespaceStartColumn, int NewLines, |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 323 | bool InPPDirective) { |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 324 | assert(Tok.Type == TT_BlockComment); |
| 325 | int StartColumn = Indent + (NewLines == 0 ? WhitespaceStartColumn : 0); |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 326 | const SourceLocation TokenLoc = Tok.FormatTok.Tok.getLocation(); |
| 327 | const int CurrentIndent = SourceMgr.getSpellingColumnNumber(TokenLoc) - 1; |
| 328 | const int IndentDelta = Indent - CurrentIndent; |
| 329 | const StringRef Text(SourceMgr.getCharacterData(TokenLoc), |
| 330 | Tok.FormatTok.TokenLength); |
| 331 | assert(Text.startswith("/*") && Text.endswith("*/")); |
| 332 | |
| 333 | SmallVector<StringRef, 16> Lines; |
| 334 | Text.split(Lines, "\n"); |
| 335 | |
| 336 | if (IndentDelta > 0) { |
| 337 | std::string WhiteSpace(IndentDelta, ' '); |
| 338 | for (size_t i = 1; i < Lines.size(); ++i) { |
| 339 | Replaces.insert(tooling::Replacement( |
| 340 | SourceMgr, TokenLoc.getLocWithOffset(Lines[i].data() - Text.data()), |
| 341 | 0, WhiteSpace)); |
| 342 | } |
| 343 | } else if (IndentDelta < 0) { |
| 344 | std::string WhiteSpace(-IndentDelta, ' '); |
| 345 | // Check that the line is indented enough. |
| 346 | for (size_t i = 1; i < Lines.size(); ++i) { |
| 347 | if (!Lines[i].startswith(WhiteSpace)) |
| 348 | return; |
| 349 | } |
| 350 | for (size_t i = 1; i < Lines.size(); ++i) { |
| 351 | Replaces.insert(tooling::Replacement( |
| 352 | SourceMgr, TokenLoc.getLocWithOffset(Lines[i].data() - Text.data()), |
| 353 | -IndentDelta, "")); |
Alexander Kornienko | dd8ed85 | 2013-03-14 16:10:54 +0000 | [diff] [blame] | 354 | } |
| 355 | } |
Alexander Kornienko | 79d6c72 | 2013-03-15 13:42:02 +0000 | [diff] [blame] | 356 | |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 357 | // Split long lines in comments. |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 358 | size_t OldPrefixSize = 0; |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 359 | std::string NewPrefix; |
| 360 | if (Lines.size() > 1) { |
| 361 | StringRef CurrentPrefix = findCommentLinesPrefix(Lines); |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 362 | OldPrefixSize = CurrentPrefix.size(); |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 363 | NewPrefix = (IndentDelta < 0) |
| 364 | ? CurrentPrefix.substr(-IndentDelta).str() |
| 365 | : std::string(IndentDelta, ' ') + CurrentPrefix.str(); |
| 366 | if (CurrentPrefix.endswith("*")) { |
| 367 | NewPrefix += " "; |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 368 | ++OldPrefixSize; |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 369 | } |
| 370 | } else if (Tok.Parent == 0) { |
| 371 | NewPrefix = std::string(StartColumn, ' ') + " * "; |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 372 | } |
| 373 | |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 374 | StartColumn += 2; |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 375 | for (size_t i = 0; i < Lines.size(); ++i) { |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 376 | StringRef Line = Lines[i].substr(i == 0 ? 2 : OldPrefixSize); |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 377 | splitLineInComment(Tok.FormatTok, Line, StartColumn, NewPrefix, |
| 378 | InPPDirective, i != Lines.size() - 1); |
Alexander Kornienko | 547a9f52 | 2013-03-21 12:28:10 +0000 | [diff] [blame] | 379 | StartColumn = NewPrefix.size(); |
Alexander Kornienko | 79d6c72 | 2013-03-15 13:42:02 +0000 | [diff] [blame] | 380 | } |
Alexander Kornienko | dd8ed85 | 2013-03-14 16:10:54 +0000 | [diff] [blame] | 381 | } |
| 382 | |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 383 | std::string getNewLineText(unsigned NewLines, unsigned Spaces) { |
| 384 | return std::string(NewLines, '\n') + std::string(Spaces, ' '); |
| 385 | } |
| 386 | |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 387 | std::string getNewLineText(unsigned NewLines, unsigned Spaces, |
| 388 | unsigned WhitespaceStartColumn) { |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 389 | std::string NewLineText; |
| 390 | if (NewLines > 0) { |
Daniel Jasper | bbc8415 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 391 | unsigned Offset = |
| 392 | std::min<int>(Style.ColumnLimit - 1, WhitespaceStartColumn); |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 393 | for (unsigned i = 0; i < NewLines; ++i) { |
| 394 | NewLineText += std::string(Style.ColumnLimit - Offset - 1, ' '); |
| 395 | NewLineText += "\\\n"; |
| 396 | Offset = 0; |
| 397 | } |
| 398 | } |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 399 | return NewLineText + std::string(Spaces, ' '); |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 400 | } |
| 401 | |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 402 | /// \brief Structure to store a comment for later layout and alignment. |
| 403 | struct StoredComment { |
| 404 | FormatToken Tok; |
| 405 | unsigned MinColumn; |
| 406 | unsigned MaxColumn; |
| 407 | unsigned NewLines; |
| 408 | unsigned Spaces; |
Daniel Jasper | bc0fa39 | 2013-03-22 16:25:51 +0000 | [diff] [blame] | 409 | bool Untouchable; |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 410 | }; |
| 411 | SmallVector<StoredComment, 16> Comments; |
| 412 | typedef SmallVector<StoredComment, 16>::iterator comment_iterator; |
| 413 | |
| 414 | /// \brief Try to align all stashed comments. |
| 415 | void alignComments() { |
| 416 | unsigned MinColumn = 0; |
| 417 | unsigned MaxColumn = UINT_MAX; |
| 418 | comment_iterator Start = Comments.begin(); |
Alexander Kornienko | dd8ed85 | 2013-03-14 16:10:54 +0000 | [diff] [blame] | 419 | for (comment_iterator I = Start, E = Comments.end(); I != E; ++I) { |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 420 | if (I->MinColumn > MaxColumn || I->MaxColumn < MinColumn) { |
| 421 | alignComments(Start, I, MinColumn); |
| 422 | MinColumn = I->MinColumn; |
| 423 | MaxColumn = I->MaxColumn; |
| 424 | Start = I; |
| 425 | } else { |
| 426 | MinColumn = std::max(MinColumn, I->MinColumn); |
| 427 | MaxColumn = std::min(MaxColumn, I->MaxColumn); |
| 428 | } |
| 429 | } |
| 430 | alignComments(Start, Comments.end(), MinColumn); |
| 431 | Comments.clear(); |
| 432 | } |
| 433 | |
| 434 | /// \brief Put all the comments between \p I and \p E into \p Column. |
| 435 | void alignComments(comment_iterator I, comment_iterator E, unsigned Column) { |
| 436 | while (I != E) { |
Daniel Jasper | bc0fa39 | 2013-03-22 16:25:51 +0000 | [diff] [blame] | 437 | if (!I->Untouchable) { |
| 438 | unsigned Spaces = I->Spaces + Column - I->MinColumn; |
Alexander Kornienko | fd43336 | 2013-03-27 17:08:02 +0000 | [diff] [blame] | 439 | storeReplacement(I->Tok, getNewLineText(I->NewLines, Spaces)); |
Daniel Jasper | bc0fa39 | 2013-03-22 16:25:51 +0000 | [diff] [blame] | 440 | } |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 441 | ++I; |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 442 | } |
| 443 | } |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 444 | |
| 445 | /// \brief Stores \p Text as the replacement for the whitespace in front of |
| 446 | /// \p Tok. |
| 447 | void storeReplacement(const FormatToken &Tok, const std::string Text) { |
Daniel Jasper | 7b038a2 | 2013-01-30 09:46:12 +0000 | [diff] [blame] | 448 | // Don't create a replacement, if it does not change anything. |
| 449 | if (StringRef(SourceMgr.getCharacterData(Tok.WhiteSpaceStart), |
| 450 | Tok.WhiteSpaceLength) == Text) |
| 451 | return; |
| 452 | |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 453 | Replaces.insert(tooling::Replacement(SourceMgr, Tok.WhiteSpaceStart, |
| 454 | Tok.WhiteSpaceLength, Text)); |
| 455 | } |
| 456 | |
| 457 | SourceManager &SourceMgr; |
| 458 | tooling::Replacements Replaces; |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 459 | const FormatStyle &Style; |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 460 | }; |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 461 | |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 462 | class UnwrappedLineFormatter { |
| 463 | public: |
Manuel Klimek | b2c6dbe | 2013-01-10 19:17:33 +0000 | [diff] [blame] | 464 | UnwrappedLineFormatter(const FormatStyle &Style, SourceManager &SourceMgr, |
Daniel Jasper | f1e4b7d | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 465 | const AnnotatedLine &Line, unsigned FirstIndent, |
Daniel Jasper | a67a8f0 | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 466 | const AnnotatedToken &RootToken, |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 467 | WhitespaceManager &Whitespaces, bool StructuralError) |
Daniel Jasper | 2af6bbe | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 468 | : Style(Style), SourceMgr(SourceMgr), Line(Line), |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 469 | FirstIndent(FirstIndent), RootToken(RootToken), |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 470 | Whitespaces(Whitespaces), Count(0) {} |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 471 | |
Manuel Klimek | 1abf789 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 472 | /// \brief Formats an \c UnwrappedLine. |
| 473 | /// |
| 474 | /// \returns The column after the last token in the last line of the |
| 475 | /// \c UnwrappedLine. |
Daniel Jasper | c22f5b4 | 2013-02-28 11:05:57 +0000 | [diff] [blame] | 476 | unsigned format(const AnnotatedLine *NextLine) { |
Daniel Jasper | e9de260 | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 477 | // Initialize state dependent on indent. |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 478 | LineState State; |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 479 | State.Column = FirstIndent; |
Daniel Jasper | 7c85fde | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 480 | State.NextToken = &RootToken; |
Daniel Jasper | 97b8948 | 2013-03-13 07:49:51 +0000 | [diff] [blame] | 481 | State.Stack.push_back( |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 482 | ParenState(FirstIndent, FirstIndent, !Style.BinPackParameters, |
Daniel Jasper | 97b8948 | 2013-03-13 07:49:51 +0000 | [diff] [blame] | 483 | /*HasMultiParameterLine=*/ false)); |
Daniel Jasper | fbde69e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 484 | State.LineContainsContinuedForLoopSection = false; |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 485 | State.ParenLevel = 0; |
Manuel Klimek | 02f640a | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 486 | State.StartOfStringLiteral = 0; |
Daniel Jasper | 40c36c5 | 2013-02-18 11:05:07 +0000 | [diff] [blame] | 487 | State.StartOfLineLevel = State.ParenLevel; |
Daniel Jasper | e9de260 | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 488 | |
| 489 | // The first token has already been indented and thus consumed. |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 490 | moveStateToNextToken(State, /*DryRun=*/ false); |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 491 | |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 492 | // If everything fits on a single line, just put it there. |
Daniel Jasper | c22f5b4 | 2013-02-28 11:05:57 +0000 | [diff] [blame] | 493 | unsigned ColumnLimit = Style.ColumnLimit; |
| 494 | if (NextLine && NextLine->InPPDirective && |
| 495 | !NextLine->First.FormatTok.HasUnescapedNewline) |
| 496 | ColumnLimit = getColumnLimit(); |
| 497 | if (Line.Last->TotalLength <= ColumnLimit - FirstIndent) { |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 498 | while (State.NextToken != NULL) { |
Daniel Jasper | 2af6bbe | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 499 | addTokenToState(false, false, State); |
Daniel Jasper | 2af6bbe | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 500 | } |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 501 | return State.Column; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 502 | } |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 503 | |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 504 | // If the ObjC method declaration does not fit on a line, we should format |
| 505 | // it with one arg per line. |
| 506 | if (Line.Type == LT_ObjCMethodDecl) |
| 507 | State.Stack.back().BreakBeforeParameter = true; |
| 508 | |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 509 | // Find best solution in solution space. |
| 510 | return analyzeSolutionSpace(State); |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 511 | } |
| 512 | |
| 513 | private: |
Manuel Klimek | 2499810 | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 514 | void DebugTokenState(const AnnotatedToken &AnnotatedTok) { |
| 515 | const Token &Tok = AnnotatedTok.FormatTok.Tok; |
Daniel Jasper | bbc8415 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 516 | llvm::errs() << StringRef(SourceMgr.getCharacterData(Tok.getLocation()), |
| 517 | Tok.getLength()); |
Manuel Klimek | 2499810 | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 518 | llvm::errs(); |
| 519 | } |
| 520 | |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 521 | struct ParenState { |
Daniel Jasper | b9ebd5d | 2013-02-05 09:41:21 +0000 | [diff] [blame] | 522 | ParenState(unsigned Indent, unsigned LastSpace, bool AvoidBinPacking, |
| 523 | bool HasMultiParameterLine) |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 524 | : Indent(Indent), LastSpace(LastSpace), FirstLessLess(0), |
| 525 | BreakBeforeClosingBrace(false), QuestionColumn(0), |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 526 | AvoidBinPacking(AvoidBinPacking), BreakBeforeParameter(false), |
Daniel Jasper | f9a84b5 | 2013-03-01 16:48:32 +0000 | [diff] [blame] | 527 | HasMultiParameterLine(HasMultiParameterLine), ColonPos(0), |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 528 | StartOfFunctionCall(0), NestedNameSpecifierContinuation(0), |
Daniel Jasper | a628c98 | 2013-04-03 13:36:17 +0000 | [diff] [blame] | 529 | CallContinuation(0), VariablePos(0) {} |
Daniel Jasper | 6d82272 | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 530 | |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 531 | /// \brief The position to which a specific parenthesis level needs to be |
| 532 | /// indented. |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 533 | unsigned Indent; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 534 | |
Daniel Jasper | e9de260 | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 535 | /// \brief The position of the last space on each level. |
| 536 | /// |
| 537 | /// Used e.g. to break like: |
| 538 | /// functionCall(Parameter, otherCall( |
| 539 | /// OtherParameter)); |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 540 | unsigned LastSpace; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 541 | |
Daniel Jasper | e9de260 | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 542 | /// \brief The position the first "<<" operator encountered on each level. |
| 543 | /// |
| 544 | /// Used to align "<<" operators. 0 if no such operator has been encountered |
| 545 | /// on a level. |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 546 | unsigned FirstLessLess; |
Daniel Jasper | e9de260 | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 547 | |
Manuel Klimek | 0ddd57a | 2013-01-10 15:58:26 +0000 | [diff] [blame] | 548 | /// \brief Whether a newline needs to be inserted before the block's closing |
| 549 | /// brace. |
| 550 | /// |
| 551 | /// We only want to insert a newline before the closing brace if there also |
| 552 | /// was a newline after the beginning left brace. |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 553 | bool BreakBeforeClosingBrace; |
| 554 | |
Daniel Jasper | ca6623b | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 555 | /// \brief The column of a \c ? in a conditional expression; |
| 556 | unsigned QuestionColumn; |
| 557 | |
Daniel Jasper | 8a8ce24 | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 558 | /// \brief Avoid bin packing, i.e. multiple parameters/elements on multiple |
| 559 | /// lines, in this context. |
| 560 | bool AvoidBinPacking; |
| 561 | |
| 562 | /// \brief Break after the next comma (or all the commas in this context if |
| 563 | /// \c AvoidBinPacking is \c true). |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 564 | bool BreakBeforeParameter; |
Daniel Jasper | 8a8ce24 | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 565 | |
| 566 | /// \brief This context already has a line with more than one parameter. |
Daniel Jasper | 9278eb9 | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 567 | bool HasMultiParameterLine; |
Daniel Jasper | 2408a8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 568 | |
Daniel Jasper | 1ac3e05 | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 569 | /// \brief The position of the colon in an ObjC method declaration/call. |
| 570 | unsigned ColonPos; |
Daniel Jasper | dc7d581 | 2013-02-20 12:56:39 +0000 | [diff] [blame] | 571 | |
Daniel Jasper | f9a84b5 | 2013-03-01 16:48:32 +0000 | [diff] [blame] | 572 | /// \brief The start of the most recent function in a builder-type call. |
| 573 | unsigned StartOfFunctionCall; |
| 574 | |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 575 | /// \brief If a nested name specifier was broken over multiple lines, this |
| 576 | /// contains the start column of the second line. Otherwise 0. |
| 577 | unsigned NestedNameSpecifierContinuation; |
| 578 | |
| 579 | /// \brief If a call expression was broken over multiple lines, this |
| 580 | /// contains the start column of the second line. Otherwise 0. |
| 581 | unsigned CallContinuation; |
| 582 | |
Daniel Jasper | a628c98 | 2013-04-03 13:36:17 +0000 | [diff] [blame] | 583 | /// \brief The column of the first variable name in a variable declaration. |
| 584 | /// |
| 585 | /// Used to align further variables if necessary. |
| 586 | unsigned VariablePos; |
| 587 | |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 588 | bool operator<(const ParenState &Other) const { |
| 589 | if (Indent != Other.Indent) |
Daniel Jasper | fd8c4b1 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 590 | return Indent < Other.Indent; |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 591 | if (LastSpace != Other.LastSpace) |
| 592 | return LastSpace < Other.LastSpace; |
| 593 | if (FirstLessLess != Other.FirstLessLess) |
| 594 | return FirstLessLess < Other.FirstLessLess; |
Daniel Jasper | 2408a8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 595 | if (BreakBeforeClosingBrace != Other.BreakBeforeClosingBrace) |
| 596 | return BreakBeforeClosingBrace; |
Daniel Jasper | ca6623b | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 597 | if (QuestionColumn != Other.QuestionColumn) |
| 598 | return QuestionColumn < Other.QuestionColumn; |
Daniel Jasper | 8a8ce24 | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 599 | if (AvoidBinPacking != Other.AvoidBinPacking) |
| 600 | return AvoidBinPacking; |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 601 | if (BreakBeforeParameter != Other.BreakBeforeParameter) |
| 602 | return BreakBeforeParameter; |
Daniel Jasper | 9278eb9 | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 603 | if (HasMultiParameterLine != Other.HasMultiParameterLine) |
| 604 | return HasMultiParameterLine; |
Daniel Jasper | 1ac3e05 | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 605 | if (ColonPos != Other.ColonPos) |
| 606 | return ColonPos < Other.ColonPos; |
Daniel Jasper | f9a84b5 | 2013-03-01 16:48:32 +0000 | [diff] [blame] | 607 | if (StartOfFunctionCall != Other.StartOfFunctionCall) |
| 608 | return StartOfFunctionCall < Other.StartOfFunctionCall; |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 609 | if (NestedNameSpecifierContinuation != |
| 610 | Other.NestedNameSpecifierContinuation) |
| 611 | return NestedNameSpecifierContinuation < |
| 612 | Other.NestedNameSpecifierContinuation; |
| 613 | if (CallContinuation != Other.CallContinuation) |
| 614 | return CallContinuation < Other.CallContinuation; |
Daniel Jasper | a628c98 | 2013-04-03 13:36:17 +0000 | [diff] [blame] | 615 | if (VariablePos != Other.VariablePos) |
| 616 | return VariablePos < Other.VariablePos; |
Daniel Jasper | 7b7877a | 2013-01-12 07:36:22 +0000 | [diff] [blame] | 617 | return false; |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 618 | } |
| 619 | }; |
| 620 | |
| 621 | /// \brief The current state when indenting a unwrapped line. |
| 622 | /// |
| 623 | /// As the indenting tries different combinations this is copied by value. |
| 624 | struct LineState { |
| 625 | /// \brief The number of used columns in the current line. |
| 626 | unsigned Column; |
| 627 | |
| 628 | /// \brief The token that needs to be next formatted. |
| 629 | const AnnotatedToken *NextToken; |
| 630 | |
Daniel Jasper | fbde69e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 631 | /// \brief \c true if this line contains a continued for-loop section. |
| 632 | bool LineContainsContinuedForLoopSection; |
| 633 | |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 634 | /// \brief The level of nesting inside (), [], <> and {}. |
| 635 | unsigned ParenLevel; |
| 636 | |
Daniel Jasper | 40c36c5 | 2013-02-18 11:05:07 +0000 | [diff] [blame] | 637 | /// \brief The \c ParenLevel at the start of this line. |
| 638 | unsigned StartOfLineLevel; |
| 639 | |
Manuel Klimek | 02f640a | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 640 | /// \brief The start column of the string literal, if we're in a string |
| 641 | /// literal sequence, 0 otherwise. |
| 642 | unsigned StartOfStringLiteral; |
| 643 | |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 644 | /// \brief A stack keeping track of properties applying to parenthesis |
| 645 | /// levels. |
| 646 | std::vector<ParenState> Stack; |
| 647 | |
| 648 | /// \brief Comparison operator to be able to used \c LineState in \c map. |
| 649 | bool operator<(const LineState &Other) const { |
Daniel Jasper | 58f427e | 2013-02-19 09:28:55 +0000 | [diff] [blame] | 650 | if (NextToken != Other.NextToken) |
| 651 | return NextToken < Other.NextToken; |
| 652 | if (Column != Other.Column) |
| 653 | return Column < Other.Column; |
Daniel Jasper | 58f427e | 2013-02-19 09:28:55 +0000 | [diff] [blame] | 654 | if (LineContainsContinuedForLoopSection != |
Daniel Jasper | d1ae358 | 2013-03-20 12:37:50 +0000 | [diff] [blame] | 655 | Other.LineContainsContinuedForLoopSection) |
Daniel Jasper | fbde69e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 656 | return LineContainsContinuedForLoopSection; |
Daniel Jasper | 58f427e | 2013-02-19 09:28:55 +0000 | [diff] [blame] | 657 | if (ParenLevel != Other.ParenLevel) |
| 658 | return ParenLevel < Other.ParenLevel; |
| 659 | if (StartOfLineLevel != Other.StartOfLineLevel) |
| 660 | return StartOfLineLevel < Other.StartOfLineLevel; |
Manuel Klimek | 02f640a | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 661 | if (StartOfStringLiteral != Other.StartOfStringLiteral) |
| 662 | return StartOfStringLiteral < Other.StartOfStringLiteral; |
Daniel Jasper | 58f427e | 2013-02-19 09:28:55 +0000 | [diff] [blame] | 663 | return Stack < Other.Stack; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 664 | } |
| 665 | }; |
| 666 | |
Daniel Jasper | 6021c4a | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 667 | /// \brief Appends the next token to \p State and updates information |
| 668 | /// necessary for indentation. |
| 669 | /// |
| 670 | /// Puts the token on the current line if \p Newline is \c true and adds a |
| 671 | /// line break and necessary indentation otherwise. |
| 672 | /// |
| 673 | /// If \p DryRun is \c false, also creates and stores the required |
| 674 | /// \c Replacement. |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 675 | unsigned addTokenToState(bool Newline, bool DryRun, LineState &State) { |
Daniel Jasper | 399d24b | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 676 | const AnnotatedToken &Current = *State.NextToken; |
| 677 | const AnnotatedToken &Previous = *State.NextToken->Parent; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 678 | |
Daniel Jasper | 291f936 | 2013-03-20 15:58:10 +0000 | [diff] [blame] | 679 | if (State.Stack.size() == 0 || Current.Type == TT_ImplicitStringLiteral) { |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 680 | State.Column += State.NextToken->FormatTok.WhiteSpaceLength + |
| 681 | State.NextToken->FormatTok.TokenLength; |
| 682 | if (State.NextToken->Children.empty()) |
| 683 | State.NextToken = NULL; |
| 684 | else |
| 685 | State.NextToken = &State.NextToken->Children[0]; |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 686 | return 0; |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 687 | } |
| 688 | |
Daniel Jasper | 5188e6b | 2013-04-03 07:21:51 +0000 | [diff] [blame] | 689 | // If we are continuing an expression, we want to indent an extra 4 spaces. |
| 690 | unsigned ContinuationIndent = |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 691 | std::max(State.Stack.back().LastSpace, State.Stack.back().Indent) + 4; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 692 | if (Newline) { |
Manuel Klimek | b69e3c6 | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 693 | unsigned WhitespaceStartColumn = State.Column; |
Manuel Klimek | 8e07a1b | 2013-01-10 11:52:21 +0000 | [diff] [blame] | 694 | if (Current.is(tok::r_brace)) { |
| 695 | State.Column = Line.Level * 2; |
Daniel Jasper | 399d24b | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 696 | } else if (Current.is(tok::string_literal) && |
Manuel Klimek | 02f640a | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 697 | State.StartOfStringLiteral != 0) { |
| 698 | State.Column = State.StartOfStringLiteral; |
Daniel Jasper | 2ec3ffb8 | 2013-02-18 11:59:17 +0000 | [diff] [blame] | 699 | State.Stack.back().BreakBeforeParameter = true; |
Daniel Jasper | 399d24b | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 700 | } else if (Current.is(tok::lessless) && |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 701 | State.Stack.back().FirstLessLess != 0) { |
| 702 | State.Column = State.Stack.back().FirstLessLess; |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 703 | } else if (Previous.is(tok::coloncolon)) { |
Daniel Jasper | 5188e6b | 2013-04-03 07:21:51 +0000 | [diff] [blame] | 704 | if (State.Stack.back().NestedNameSpecifierContinuation == 0) { |
| 705 | State.Column = ContinuationIndent; |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 706 | State.Stack.back().NestedNameSpecifierContinuation = State.Column; |
Daniel Jasper | 5188e6b | 2013-04-03 07:21:51 +0000 | [diff] [blame] | 707 | } else { |
| 708 | State.Column = State.Stack.back().NestedNameSpecifierContinuation; |
| 709 | } |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 710 | } else if (Current.isOneOf(tok::period, tok::arrow)) { |
Daniel Jasper | 5188e6b | 2013-04-03 07:21:51 +0000 | [diff] [blame] | 711 | if (State.Stack.back().CallContinuation == 0) { |
| 712 | State.Column = ContinuationIndent; |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 713 | State.Stack.back().CallContinuation = State.Column; |
Daniel Jasper | 5188e6b | 2013-04-03 07:21:51 +0000 | [diff] [blame] | 714 | } else { |
| 715 | State.Column = State.Stack.back().CallContinuation; |
| 716 | } |
Daniel Jasper | ca6623b | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 717 | } else if (Current.Type == TT_ConditionalExpr) { |
| 718 | State.Column = State.Stack.back().QuestionColumn; |
Daniel Jasper | a628c98 | 2013-04-03 13:36:17 +0000 | [diff] [blame] | 719 | } else if (Previous.is(tok::comma) && |
| 720 | State.Stack.back().VariablePos != 0) { |
| 721 | State.Column = State.Stack.back().VariablePos; |
Daniel Jasper | 26d1b1d | 2013-02-24 18:54:32 +0000 | [diff] [blame] | 722 | } else if (Previous.ClosesTemplateDeclaration || |
| 723 | (Current.Type == TT_StartOfName && State.ParenLevel == 0)) { |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 724 | State.Column = State.Stack.back().Indent; |
Daniel Jasper | 1ac3e05 | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 725 | } else if (Current.Type == TT_ObjCSelectorName) { |
| 726 | if (State.Stack.back().ColonPos > Current.FormatTok.TokenLength) { |
| 727 | State.Column = |
| 728 | State.Stack.back().ColonPos - Current.FormatTok.TokenLength; |
| 729 | } else { |
| 730 | State.Column = State.Stack.back().Indent; |
| 731 | State.Stack.back().ColonPos = |
| 732 | State.Column + Current.FormatTok.TokenLength; |
| 733 | } |
Daniel Jasper | 6bee682 | 2013-04-08 20:33:42 +0000 | [diff] [blame^] | 734 | } else if (Current.Type == TT_StartOfName || Previous.is(tok::equal) || |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 735 | Previous.Type == TT_ObjCMethodExpr) { |
Daniel Jasper | 5188e6b | 2013-04-03 07:21:51 +0000 | [diff] [blame] | 736 | State.Column = ContinuationIndent; |
Daniel Jasper | fbde69e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 737 | } else { |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 738 | State.Column = State.Stack.back().Indent; |
Daniel Jasper | 5188e6b | 2013-04-03 07:21:51 +0000 | [diff] [blame] | 739 | // Ensure that we fall back to indenting 4 spaces instead of just |
| 740 | // flushing continuations left. |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 741 | if (State.Column == FirstIndent) |
| 742 | State.Column += 4; |
Daniel Jasper | fbde69e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 743 | } |
| 744 | |
Daniel Jasper | 54a8602 | 2013-02-15 11:07:25 +0000 | [diff] [blame] | 745 | if (Current.is(tok::question)) |
Daniel Jasper | cd8599e | 2013-02-23 21:01:55 +0000 | [diff] [blame] | 746 | State.Stack.back().BreakBeforeParameter = true; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 747 | if (Previous.isOneOf(tok::comma, tok::semi) && |
Daniel Jasper | cd8599e | 2013-02-23 21:01:55 +0000 | [diff] [blame] | 748 | !State.Stack.back().AvoidBinPacking) |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 749 | State.Stack.back().BreakBeforeParameter = false; |
Daniel Jasper | 8a8ce24 | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 750 | |
Manuel Klimek | b69e3c6 | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 751 | if (!DryRun) { |
Daniel Jasper | fb5e241 | 2013-02-26 13:10:34 +0000 | [diff] [blame] | 752 | unsigned NewLines = 1; |
| 753 | if (Current.Type == TT_LineComment) |
| 754 | NewLines = |
| 755 | std::max(NewLines, std::min(Current.FormatTok.NewlinesBefore, |
| 756 | Style.MaxEmptyLinesToKeep + 1)); |
Manuel Klimek | b69e3c6 | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 757 | if (!Line.InPPDirective) |
Daniel Jasper | dc7d581 | 2013-02-20 12:56:39 +0000 | [diff] [blame] | 758 | Whitespaces.replaceWhitespace(Current, NewLines, State.Column, |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 759 | WhitespaceStartColumn); |
Manuel Klimek | b69e3c6 | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 760 | else |
Daniel Jasper | dc7d581 | 2013-02-20 12:56:39 +0000 | [diff] [blame] | 761 | Whitespaces.replacePPWhitespace(Current, NewLines, State.Column, |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 762 | WhitespaceStartColumn); |
Manuel Klimek | b69e3c6 | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 763 | } |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 764 | |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 765 | State.Stack.back().LastSpace = State.Column; |
Daniel Jasper | 40c36c5 | 2013-02-18 11:05:07 +0000 | [diff] [blame] | 766 | State.StartOfLineLevel = State.ParenLevel; |
Daniel Jasper | cd8599e | 2013-02-23 21:01:55 +0000 | [diff] [blame] | 767 | |
| 768 | // Any break on this level means that the parent level has been broken |
| 769 | // and we need to avoid bin packing there. |
| 770 | for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { |
| 771 | State.Stack[i].BreakBeforeParameter = true; |
| 772 | } |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 773 | if (Current.isOneOf(tok::period, tok::arrow)) |
Daniel Jasper | 2cf17bf | 2013-02-27 09:47:53 +0000 | [diff] [blame] | 774 | State.Stack.back().BreakBeforeParameter = true; |
| 775 | |
Daniel Jasper | cd8599e | 2013-02-23 21:01:55 +0000 | [diff] [blame] | 776 | // If we break after {, we should also break before the corresponding }. |
| 777 | if (Previous.is(tok::l_brace)) |
| 778 | State.Stack.back().BreakBeforeClosingBrace = true; |
| 779 | |
| 780 | if (State.Stack.back().AvoidBinPacking) { |
| 781 | // If we are breaking after '(', '{', '<', this is not bin packing |
| 782 | // unless AllowAllParametersOfDeclarationOnNextLine is false. |
Daniel Jasper | 26d1b1d | 2013-02-24 18:54:32 +0000 | [diff] [blame] | 783 | if ((Previous.isNot(tok::l_paren) && Previous.isNot(tok::l_brace)) || |
Daniel Jasper | cd8599e | 2013-02-23 21:01:55 +0000 | [diff] [blame] | 784 | (!Style.AllowAllParametersOfDeclarationOnNextLine && |
| 785 | Line.MustBeDeclaration)) |
| 786 | State.Stack.back().BreakBeforeParameter = true; |
| 787 | } |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 788 | } else { |
Daniel Jasper | 62e6817 | 2013-02-25 15:59:54 +0000 | [diff] [blame] | 789 | if (Current.is(tok::equal) && |
Daniel Jasper | 31c96b9 | 2013-04-05 09:38:50 +0000 | [diff] [blame] | 790 | (RootToken.is(tok::kw_for) || State.ParenLevel == 0) && |
| 791 | State.Stack.back().VariablePos == 0) { |
| 792 | State.Stack.back().VariablePos = State.Column; |
| 793 | // Move over * and & if they are bound to the variable name. |
| 794 | const AnnotatedToken *Tok = &Previous; |
| 795 | while (Tok && |
| 796 | State.Stack.back().VariablePos >= Tok->FormatTok.TokenLength) { |
| 797 | State.Stack.back().VariablePos -= Tok->FormatTok.TokenLength; |
| 798 | if (Tok->SpacesRequiredBefore != 0) |
| 799 | break; |
| 800 | Tok = Tok->Parent; |
| 801 | } |
Daniel Jasper | a628c98 | 2013-04-03 13:36:17 +0000 | [diff] [blame] | 802 | if (Previous.PartOfMultiVariableDeclStmt) |
| 803 | State.Stack.back().LastSpace = State.Stack.back().VariablePos; |
| 804 | } |
Daniel Jasper | fbde69e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 805 | |
Daniel Jasper | eef3049 | 2013-02-11 12:36:37 +0000 | [diff] [blame] | 806 | unsigned Spaces = State.NextToken->SpacesRequiredBefore; |
Daniel Jasper | 6021c4a | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 807 | |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 808 | if (!DryRun) |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 809 | Whitespaces.replaceWhitespace(Current, 0, Spaces, State.Column); |
Daniel Jasper | 6021c4a | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 810 | |
Daniel Jasper | 1ac3e05 | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 811 | if (Current.Type == TT_ObjCSelectorName && |
| 812 | State.Stack.back().ColonPos == 0) { |
| 813 | if (State.Stack.back().Indent + Current.LongestObjCSelectorName > |
Daniel Jasper | d1ae358 | 2013-03-20 12:37:50 +0000 | [diff] [blame] | 814 | State.Column + Spaces + Current.FormatTok.TokenLength) |
Daniel Jasper | 1ac3e05 | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 815 | State.Stack.back().ColonPos = |
| 816 | State.Stack.back().Indent + Current.LongestObjCSelectorName; |
| 817 | else |
| 818 | State.Stack.back().ColonPos = |
Daniel Jasper | c485b4e | 2013-02-06 16:00:26 +0000 | [diff] [blame] | 819 | State.Column + Spaces + Current.FormatTok.TokenLength; |
Daniel Jasper | 1ac3e05 | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 820 | } |
| 821 | |
Daniel Jasper | 6bee682 | 2013-04-08 20:33:42 +0000 | [diff] [blame^] | 822 | if (opensScope(Previous) && Previous.Type != TT_ObjCMethodExpr && |
| 823 | Current.Type != TT_LineComment) |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 824 | State.Stack.back().Indent = State.Column + Spaces; |
Daniel Jasper | 14e40ec | 2013-02-04 08:34:57 +0000 | [diff] [blame] | 825 | if (Previous.is(tok::comma) && !isTrailingComment(Current)) |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 826 | State.Stack.back().HasMultiParameterLine = true; |
Daniel Jasper | 9278eb9 | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 827 | |
Daniel Jasper | e9de260 | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 828 | State.Column += Spaces; |
Daniel Jasper | a628c98 | 2013-04-03 13:36:17 +0000 | [diff] [blame] | 829 | if (Current.is(tok::l_paren) && Previous.isOneOf(tok::kw_if, tok::kw_for)) |
Daniel Jasper | 39e2738 | 2013-01-23 20:41:06 +0000 | [diff] [blame] | 830 | // Treat the condition inside an if as if it was a second function |
| 831 | // parameter, i.e. let nested calls have an indent of 4. |
| 832 | State.Stack.back().LastSpace = State.Column + 1; // 1 is length of "(". |
Daniel Jasper | d1ae358 | 2013-03-20 12:37:50 +0000 | [diff] [blame] | 833 | else if (Previous.is(tok::comma)) |
Daniel Jasper | 39e2738 | 2013-01-23 20:41:06 +0000 | [diff] [blame] | 834 | State.Stack.back().LastSpace = State.Column; |
Daniel Jasper | ca6623b | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 835 | else if ((Previous.Type == TT_BinaryOperator || |
Daniel Jasper | 65585ed | 2013-01-28 13:31:35 +0000 | [diff] [blame] | 836 | Previous.Type == TT_ConditionalExpr || |
| 837 | Previous.Type == TT_CtorInitializerColon) && |
Daniel Jasper | 20b09ef | 2013-01-28 09:35:24 +0000 | [diff] [blame] | 838 | getPrecedence(Previous) != prec::Assignment) |
| 839 | State.Stack.back().LastSpace = State.Column; |
Daniel Jasper | eead02b | 2013-02-14 08:42:54 +0000 | [diff] [blame] | 840 | else if (Previous.Type == TT_InheritanceColon) |
| 841 | State.Stack.back().Indent = State.Column; |
Daniel Jasper | 6bee682 | 2013-04-08 20:33:42 +0000 | [diff] [blame^] | 842 | else if (opensScope(Previous) && Previous.ParameterCount > 1) |
Daniel Jasper | 7b5773e9 | 2013-01-28 07:35:34 +0000 | [diff] [blame] | 843 | // If this function has multiple parameters, indent nested calls from |
| 844 | // the start of the first parameter. |
| 845 | State.Stack.back().LastSpace = State.Column; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 846 | } |
Daniel Jasper | 9278eb9 | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 847 | |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 848 | return moveStateToNextToken(State, DryRun); |
Daniel Jasper | 6021c4a | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 849 | } |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 850 | |
Daniel Jasper | 6021c4a | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 851 | /// \brief Mark the next token as consumed in \p State and modify its stacks |
| 852 | /// accordingly. |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 853 | unsigned moveStateToNextToken(LineState &State, bool DryRun) { |
Daniel Jasper | 7c85fde | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 854 | const AnnotatedToken &Current = *State.NextToken; |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 855 | assert(State.Stack.size()); |
Daniel Jasper | e9de260 | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 856 | |
Daniel Jasper | eead02b | 2013-02-14 08:42:54 +0000 | [diff] [blame] | 857 | if (Current.Type == TT_InheritanceColon) |
| 858 | State.Stack.back().AvoidBinPacking = true; |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 859 | if (Current.is(tok::lessless) && State.Stack.back().FirstLessLess == 0) |
| 860 | State.Stack.back().FirstLessLess = State.Column; |
Daniel Jasper | ca6623b | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 861 | if (Current.is(tok::question)) |
| 862 | State.Stack.back().QuestionColumn = State.Column; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 863 | if (Current.isOneOf(tok::period, tok::arrow) && |
Daniel Jasper | f9a84b5 | 2013-03-01 16:48:32 +0000 | [diff] [blame] | 864 | Line.Type == LT_BuilderTypeCall && State.ParenLevel == 0) |
| 865 | State.Stack.back().StartOfFunctionCall = |
| 866 | Current.LastInChainOfCalls ? 0 : State.Column; |
Daniel Jasper | 37905f7 | 2013-02-21 15:00:29 +0000 | [diff] [blame] | 867 | if (Current.Type == TT_CtorInitializerColon) { |
Daniel Jasper | 6bee682 | 2013-04-08 20:33:42 +0000 | [diff] [blame^] | 868 | State.Stack.back().Indent = State.Column + 2; |
Daniel Jasper | 37905f7 | 2013-02-21 15:00:29 +0000 | [diff] [blame] | 869 | if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine) |
| 870 | State.Stack.back().AvoidBinPacking = true; |
| 871 | State.Stack.back().BreakBeforeParameter = false; |
Daniel Jasper | 8a8ce24 | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 872 | } |
Daniel Jasper | 5188e6b | 2013-04-03 07:21:51 +0000 | [diff] [blame] | 873 | |
Daniel Jasper | 6bee682 | 2013-04-08 20:33:42 +0000 | [diff] [blame^] | 874 | // If return returns a binary expression, align after it. |
| 875 | if (Current.is(tok::kw_return) && !Current.FakeLParens.empty()) |
| 876 | State.Stack.back().LastSpace = State.Column + 7; |
| 877 | |
Daniel Jasper | 5188e6b | 2013-04-03 07:21:51 +0000 | [diff] [blame] | 878 | // In ObjC method declaration we align on the ":" of parameters, but we need |
| 879 | // to ensure that we indent parameters on subsequent lines by at least 4. |
Daniel Jasper | c238c87 | 2013-04-02 14:33:13 +0000 | [diff] [blame] | 880 | if (Current.Type == TT_ObjCMethodSpecifier) |
| 881 | State.Stack.back().Indent += 4; |
Daniel Jasper | e9de260 | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 882 | |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 883 | // Insert scopes created by fake parenthesis. |
Daniel Jasper | 6bee682 | 2013-04-08 20:33:42 +0000 | [diff] [blame^] | 884 | const AnnotatedToken *Previous = Current.getPreviousNoneComment(); |
| 885 | // Don't add extra indentation for the first fake parenthesis after |
| 886 | // 'return', assignements or opening <({[. The indentation for these cases |
| 887 | // is special cased. |
| 888 | bool SkipFirstExtraIndent = |
| 889 | Current.is(tok::kw_return) || |
| 890 | (Previous && (opensScope(*Previous) || |
| 891 | getPrecedence(*Previous) == prec::Assignment)); |
| 892 | for (SmallVector<prec::Level, 4>::const_reverse_iterator |
| 893 | I = Current.FakeLParens.rbegin(), |
| 894 | E = Current.FakeLParens.rend(); |
| 895 | I != E; ++I) { |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 896 | ParenState NewParenState = State.Stack.back(); |
Daniel Jasper | 6bee682 | 2013-04-08 20:33:42 +0000 | [diff] [blame^] | 897 | NewParenState.Indent = |
| 898 | std::max(std::max(State.Column, NewParenState.Indent), |
| 899 | State.Stack.back().LastSpace); |
| 900 | |
| 901 | // Always indent conditional expressions. Never indent expression where |
| 902 | // the 'operator' is ',', ';' or an assignment (i.e. *I <= |
| 903 | // prec::Assignment) as those have different indentation rules. Indent |
| 904 | // other expression, unless the indentation needs to be skipped. |
| 905 | if (*I == prec::Conditional || |
| 906 | (!SkipFirstExtraIndent && *I > prec::Assignment)) |
| 907 | NewParenState.Indent += 4; |
| 908 | if (Previous && !opensScope(*Previous)) |
| 909 | NewParenState.BreakBeforeParameter = false; |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 910 | State.Stack.push_back(NewParenState); |
Daniel Jasper | 6bee682 | 2013-04-08 20:33:42 +0000 | [diff] [blame^] | 911 | SkipFirstExtraIndent = false; |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 912 | } |
| 913 | |
Daniel Jasper | 2eda23e | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 914 | // If we encounter an opening (, [, { or <, we add a level to our stacks to |
Daniel Jasper | 6021c4a | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 915 | // prepare for the following tokens. |
Daniel Jasper | 6bee682 | 2013-04-08 20:33:42 +0000 | [diff] [blame^] | 916 | if (opensScope(Current)) { |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 917 | unsigned NewIndent; |
Daniel Jasper | 8a8ce24 | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 918 | bool AvoidBinPacking; |
Manuel Klimek | 73a2fdf | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 919 | if (Current.is(tok::l_brace)) { |
Daniel Jasper | 8a8ce24 | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 920 | NewIndent = 2 + State.Stack.back().LastSpace; |
| 921 | AvoidBinPacking = false; |
Manuel Klimek | 73a2fdf | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 922 | } else { |
Daniel Jasper | f9a84b5 | 2013-03-01 16:48:32 +0000 | [diff] [blame] | 923 | NewIndent = 4 + std::max(State.Stack.back().LastSpace, |
| 924 | State.Stack.back().StartOfFunctionCall); |
Daniel Jasper | ead41b6 | 2013-02-28 09:39:12 +0000 | [diff] [blame] | 925 | AvoidBinPacking = |
| 926 | !Style.BinPackParameters || State.Stack.back().AvoidBinPacking; |
Manuel Klimek | 73a2fdf | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 927 | } |
Daniel Jasper | b9ebd5d | 2013-02-05 09:41:21 +0000 | [diff] [blame] | 928 | State.Stack.push_back( |
| 929 | ParenState(NewIndent, State.Stack.back().LastSpace, AvoidBinPacking, |
| 930 | State.Stack.back().HasMultiParameterLine)); |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 931 | ++State.ParenLevel; |
Daniel Jasper | 6021c4a | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 932 | } |
| 933 | |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 934 | // If this '[' opens an ObjC call, determine whether all parameters fit into |
| 935 | // one line and put one per line if they don't. |
| 936 | if (Current.is(tok::l_square) && Current.Type == TT_ObjCMethodExpr && |
| 937 | Current.MatchingParen != NULL) { |
| 938 | if (getLengthToMatchingParen(Current) + State.Column > getColumnLimit()) |
| 939 | State.Stack.back().BreakBeforeParameter = true; |
| 940 | } |
| 941 | |
Daniel Jasper | 2eda23e | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 942 | // If we encounter a closing ), ], } or >, we can remove a level from our |
Daniel Jasper | 6021c4a | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 943 | // stacks. |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 944 | if (Current.isOneOf(tok::r_paren, tok::r_square) || |
Daniel Jasper | 7c85fde | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 945 | (Current.is(tok::r_brace) && State.NextToken != &RootToken) || |
| 946 | State.NextToken->Type == TT_TemplateCloser) { |
Daniel Jasper | 337816e | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 947 | State.Stack.pop_back(); |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 948 | --State.ParenLevel; |
| 949 | } |
| 950 | |
| 951 | // Remove scopes created by fake parenthesis. |
| 952 | for (unsigned i = 0, e = Current.FakeRParens; i != e; ++i) { |
Daniel Jasper | 6daabe3 | 2013-04-04 19:31:00 +0000 | [diff] [blame] | 953 | unsigned VariablePos = State.Stack.back().VariablePos; |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 954 | State.Stack.pop_back(); |
Daniel Jasper | 6daabe3 | 2013-04-04 19:31:00 +0000 | [diff] [blame] | 955 | State.Stack.back().VariablePos = VariablePos; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 956 | } |
Manuel Klimek | 73a2fdf | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 957 | |
Manuel Klimek | 0c91571 | 2013-02-20 15:32:58 +0000 | [diff] [blame] | 958 | if (Current.is(tok::string_literal)) { |
Manuel Klimek | 02f640a | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 959 | State.StartOfStringLiteral = State.Column; |
| 960 | } else if (Current.isNot(tok::comment)) { |
| 961 | State.StartOfStringLiteral = 0; |
| 962 | } |
| 963 | |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 964 | State.Column += Current.FormatTok.TokenLength; |
| 965 | |
Daniel Jasper | 7c85fde | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 966 | if (State.NextToken->Children.empty()) |
| 967 | State.NextToken = NULL; |
| 968 | else |
| 969 | State.NextToken = &State.NextToken->Children[0]; |
Manuel Klimek | 73a2fdf | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 970 | |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 971 | return breakProtrudingToken(Current, State, DryRun); |
| 972 | } |
| 973 | |
| 974 | /// \brief If the current token sticks out over the end of the line, break |
| 975 | /// it if possible. |
| 976 | unsigned breakProtrudingToken(const AnnotatedToken &Current, LineState &State, |
| 977 | bool DryRun) { |
| 978 | if (Current.isNot(tok::string_literal)) |
| 979 | return 0; |
Manuel Klimek | 5085d9b | 2013-03-08 18:59:48 +0000 | [diff] [blame] | 980 | // Only break up default narrow strings. |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 981 | const char *LiteralData = Current.FormatTok.Tok.getLiteralData(); |
| 982 | if (!LiteralData || *LiteralData != '"') |
Manuel Klimek | 5085d9b | 2013-03-08 18:59:48 +0000 | [diff] [blame] | 983 | return 0; |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 984 | |
| 985 | unsigned Penalty = 0; |
| 986 | unsigned TailOffset = 0; |
| 987 | unsigned TailLength = Current.FormatTok.TokenLength; |
| 988 | unsigned StartColumn = State.Column - Current.FormatTok.TokenLength; |
| 989 | unsigned OffsetFromStart = 0; |
| 990 | while (StartColumn + TailLength > getColumnLimit()) { |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 991 | StringRef Text = StringRef(LiteralData + TailOffset, TailLength); |
Manuel Klimek | e317d1b | 2013-03-01 13:29:19 +0000 | [diff] [blame] | 992 | if (StartColumn + OffsetFromStart + 1 > getColumnLimit()) |
Manuel Klimek | b176cff | 2013-03-01 13:14:08 +0000 | [diff] [blame] | 993 | break; |
Manuel Klimek | e317d1b | 2013-03-01 13:29:19 +0000 | [diff] [blame] | 994 | StringRef::size_type SplitPoint = getSplitPoint( |
| 995 | Text, getColumnLimit() - StartColumn - OffsetFromStart - 1); |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 996 | if (SplitPoint == StringRef::npos) |
| 997 | break; |
| 998 | assert(SplitPoint != 0); |
| 999 | // +2, because 'Text' starts after the opening quotes, and does not |
| 1000 | // include the closing quote we need to insert. |
| 1001 | unsigned WhitespaceStartColumn = |
| 1002 | StartColumn + OffsetFromStart + SplitPoint + 2; |
| 1003 | State.Stack.back().LastSpace = StartColumn; |
| 1004 | if (!DryRun) { |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 1005 | Whitespaces.breakToken(Current.FormatTok, TailOffset + SplitPoint + 1, |
| 1006 | 0, "\"", "\"", Line.InPPDirective, StartColumn, |
| 1007 | WhitespaceStartColumn); |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 1008 | } |
| 1009 | TailOffset += SplitPoint + 1; |
| 1010 | TailLength -= SplitPoint + 1; |
| 1011 | OffsetFromStart = 1; |
Daniel Jasper | 5497fce | 2013-02-26 12:52:34 +0000 | [diff] [blame] | 1012 | Penalty += Style.PenaltyExcessCharacter; |
Daniel Jasper | 2cf17bf | 2013-02-27 09:47:53 +0000 | [diff] [blame] | 1013 | for (unsigned i = 0, e = State.Stack.size(); i != e; ++i) |
| 1014 | State.Stack[i].BreakBeforeParameter = true; |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 1015 | } |
| 1016 | State.Column = StartColumn + TailLength; |
| 1017 | return Penalty; |
| 1018 | } |
| 1019 | |
| 1020 | StringRef::size_type |
| 1021 | getSplitPoint(StringRef Text, StringRef::size_type Offset) { |
Manuel Klimek | b176cff | 2013-03-01 13:14:08 +0000 | [diff] [blame] | 1022 | StringRef::size_type SpaceOffset = Text.rfind(' ', Offset); |
Manuel Klimek | abf6e03 | 2013-03-04 20:03:38 +0000 | [diff] [blame] | 1023 | if (SpaceOffset != StringRef::npos && SpaceOffset != 0) |
Manuel Klimek | e317d1b | 2013-03-01 13:29:19 +0000 | [diff] [blame] | 1024 | return SpaceOffset; |
| 1025 | StringRef::size_type SlashOffset = Text.rfind('/', Offset); |
Manuel Klimek | abf6e03 | 2013-03-04 20:03:38 +0000 | [diff] [blame] | 1026 | if (SlashOffset != StringRef::npos && SlashOffset != 0) |
Manuel Klimek | e317d1b | 2013-03-01 13:29:19 +0000 | [diff] [blame] | 1027 | return SlashOffset; |
Manuel Klimek | 5085d9b | 2013-03-08 18:59:48 +0000 | [diff] [blame] | 1028 | StringRef::size_type Split = getStartOfCharacter(Text, Offset); |
| 1029 | if (Split != StringRef::npos && Split > 1) |
Manuel Klimek | e317d1b | 2013-03-01 13:29:19 +0000 | [diff] [blame] | 1030 | // Do not split at 0. |
Manuel Klimek | 5085d9b | 2013-03-08 18:59:48 +0000 | [diff] [blame] | 1031 | return Split - 1; |
Manuel Klimek | e317d1b | 2013-03-01 13:29:19 +0000 | [diff] [blame] | 1032 | return StringRef::npos; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1033 | } |
| 1034 | |
Manuel Klimek | 5085d9b | 2013-03-08 18:59:48 +0000 | [diff] [blame] | 1035 | StringRef::size_type |
| 1036 | getStartOfCharacter(StringRef Text, StringRef::size_type Offset) { |
| 1037 | StringRef::size_type NextEscape = Text.find('\\'); |
| 1038 | while (NextEscape != StringRef::npos && NextEscape < Offset) { |
| 1039 | StringRef::size_type SequenceLength = |
| 1040 | getEscapeSequenceLength(Text.substr(NextEscape)); |
| 1041 | if (Offset < NextEscape + SequenceLength) |
| 1042 | return NextEscape; |
| 1043 | NextEscape = Text.find('\\', NextEscape + SequenceLength); |
| 1044 | } |
| 1045 | return Offset; |
| 1046 | } |
| 1047 | |
| 1048 | unsigned getEscapeSequenceLength(StringRef Text) { |
| 1049 | assert(Text[0] == '\\'); |
| 1050 | if (Text.size() < 2) |
| 1051 | return 1; |
| 1052 | |
| 1053 | switch (Text[1]) { |
| 1054 | case 'u': |
| 1055 | return 6; |
| 1056 | case 'U': |
| 1057 | return 10; |
| 1058 | case 'x': |
| 1059 | return getHexLength(Text); |
| 1060 | default: |
| 1061 | if (Text[1] >= '0' && Text[1] <= '7') |
| 1062 | return getOctalLength(Text); |
| 1063 | return 2; |
| 1064 | } |
| 1065 | } |
| 1066 | |
| 1067 | unsigned getHexLength(StringRef Text) { |
| 1068 | unsigned I = 2; // Point after '\x'. |
| 1069 | while (I < Text.size() && ((Text[I] >= '0' && Text[I] <= '9') || |
| 1070 | (Text[I] >= 'a' && Text[I] <= 'f') || |
| 1071 | (Text[I] >= 'A' && Text[I] <= 'F'))) { |
| 1072 | ++I; |
| 1073 | } |
| 1074 | return I; |
| 1075 | } |
| 1076 | |
| 1077 | unsigned getOctalLength(StringRef Text) { |
| 1078 | unsigned I = 1; |
| 1079 | while (I < Text.size() && I < 4 && (Text[I] >= '0' && Text[I] <= '7')) { |
| 1080 | ++I; |
| 1081 | } |
| 1082 | return I; |
| 1083 | } |
| 1084 | |
Daniel Jasper | 2df9331 | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 1085 | unsigned getColumnLimit() { |
Alexander Kornienko | ffd6d04 | 2013-03-27 11:52:18 +0000 | [diff] [blame] | 1086 | return calculateColumnLimit(Style, Line.InPPDirective); |
Daniel Jasper | 2df9331 | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 1087 | } |
| 1088 | |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1089 | /// \brief An edge in the solution space from \c Previous->State to \c State, |
| 1090 | /// inserting a newline dependent on the \c NewLine. |
| 1091 | struct StateNode { |
| 1092 | StateNode(const LineState &State, bool NewLine, StateNode *Previous) |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 1093 | : State(State), NewLine(NewLine), Previous(Previous) {} |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1094 | LineState State; |
| 1095 | bool NewLine; |
| 1096 | StateNode *Previous; |
| 1097 | }; |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1098 | |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1099 | /// \brief A pair of <penalty, count> that is used to prioritize the BFS on. |
| 1100 | /// |
| 1101 | /// In case of equal penalties, we want to prefer states that were inserted |
| 1102 | /// first. During state generation we make sure that we insert states first |
| 1103 | /// that break the line as late as possible. |
| 1104 | typedef std::pair<unsigned, unsigned> OrderedPenalty; |
| 1105 | |
| 1106 | /// \brief An item in the prioritized BFS search queue. The \c StateNode's |
| 1107 | /// \c State has the given \c OrderedPenalty. |
| 1108 | typedef std::pair<OrderedPenalty, StateNode *> QueueItem; |
| 1109 | |
| 1110 | /// \brief The BFS queue type. |
| 1111 | typedef std::priority_queue<QueueItem, std::vector<QueueItem>, |
| 1112 | std::greater<QueueItem> > QueueType; |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1113 | |
| 1114 | /// \brief Analyze the entire solution space starting from \p InitialState. |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1115 | /// |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1116 | /// This implements a variant of Dijkstra's algorithm on the graph that spans |
| 1117 | /// the solution space (\c LineStates are the nodes). The algorithm tries to |
| 1118 | /// find the shortest path (the one with lowest penalty) from \p InitialState |
| 1119 | /// to a state where all tokens are placed. |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1120 | unsigned analyzeSolutionSpace(LineState &InitialState) { |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1121 | std::set<LineState> Seen; |
| 1122 | |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1123 | // Insert start element into queue. |
Daniel Jasper | 687af3b | 2013-02-14 14:26:07 +0000 | [diff] [blame] | 1124 | StateNode *Node = |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1125 | new (Allocator.Allocate()) StateNode(InitialState, false, NULL); |
| 1126 | Queue.push(QueueItem(OrderedPenalty(0, Count), Node)); |
| 1127 | ++Count; |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1128 | |
| 1129 | // While not empty, take first element and follow edges. |
| 1130 | while (!Queue.empty()) { |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1131 | unsigned Penalty = Queue.top().first.first; |
Daniel Jasper | 687af3b | 2013-02-14 14:26:07 +0000 | [diff] [blame] | 1132 | StateNode *Node = Queue.top().second; |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1133 | if (Node->State.NextToken == NULL) { |
Daniel Jasper | 3a9370c | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 1134 | DEBUG(llvm::errs() << "\n---\nPenalty for line: " << Penalty << "\n"); |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1135 | break; |
Daniel Jasper | 3a9370c | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 1136 | } |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1137 | Queue.pop(); |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1138 | |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1139 | if (!Seen.insert(Node->State).second) |
| 1140 | // State already examined with lower penalty. |
| 1141 | continue; |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1142 | |
Manuel Klimek | af49107 | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 1143 | addNextStateToQueue(Penalty, Node, /*NewLine=*/ false); |
| 1144 | addNextStateToQueue(Penalty, Node, /*NewLine=*/ true); |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1145 | } |
| 1146 | |
| 1147 | if (Queue.empty()) |
| 1148 | // We were unable to find a solution, do nothing. |
| 1149 | // FIXME: Add diagnostic? |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1150 | return 0; |
| 1151 | |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1152 | // Reconstruct the solution. |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1153 | reconstructPath(InitialState, Queue.top().second); |
Daniel Jasper | 3a9370c | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 1154 | DEBUG(llvm::errs() << "---\n"); |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1155 | |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1156 | // Return the column after the last token of the solution. |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1157 | return Queue.top().second->State.Column; |
| 1158 | } |
| 1159 | |
| 1160 | void reconstructPath(LineState &State, StateNode *Current) { |
| 1161 | // FIXME: This recursive implementation limits the possible number |
| 1162 | // of tokens per line if compiled into a binary with small stack space. |
| 1163 | // To become more independent of stack frame limitations we would need |
| 1164 | // to also change the TokenAnnotator. |
| 1165 | if (Current->Previous == NULL) |
| 1166 | return; |
| 1167 | reconstructPath(State, Current->Previous); |
| 1168 | DEBUG({ |
| 1169 | if (Current->NewLine) { |
Daniel Jasper | b9caeac | 2013-02-13 20:33:44 +0000 | [diff] [blame] | 1170 | llvm::errs() |
| 1171 | << "Penalty for splitting before " |
| 1172 | << Current->Previous->State.NextToken->FormatTok.Tok.getName() |
| 1173 | << ": " << Current->Previous->State.NextToken->SplitPenalty << "\n"; |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1174 | } |
| 1175 | }); |
| 1176 | addTokenToState(Current->NewLine, false, State); |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1177 | } |
| 1178 | |
Manuel Klimek | af49107 | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 1179 | /// \brief Add the following state to the analysis queue \c Queue. |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1180 | /// |
Manuel Klimek | af49107 | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 1181 | /// Assume the current state is \p PreviousNode and has been reached with a |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1182 | /// penalty of \p Penalty. Insert a line break if \p NewLine is \c true. |
Manuel Klimek | af49107 | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 1183 | void addNextStateToQueue(unsigned Penalty, StateNode *PreviousNode, |
| 1184 | bool NewLine) { |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1185 | if (NewLine && !canBreak(PreviousNode->State)) |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1186 | return; |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1187 | if (!NewLine && mustBreak(PreviousNode->State)) |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1188 | return; |
Daniel Jasper | 20b09ef | 2013-01-28 09:35:24 +0000 | [diff] [blame] | 1189 | if (NewLine) |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1190 | Penalty += PreviousNode->State.NextToken->SplitPenalty; |
| 1191 | |
| 1192 | StateNode *Node = new (Allocator.Allocate()) |
| 1193 | StateNode(PreviousNode->State, NewLine, PreviousNode); |
Manuel Klimek | 1998ea2 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 1194 | Penalty += addTokenToState(NewLine, true, Node->State); |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1195 | if (Node->State.Column > getColumnLimit()) { |
| 1196 | unsigned ExcessCharacters = Node->State.Column - getColumnLimit(); |
Daniel Jasper | 3a9370c | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 1197 | Penalty += Style.PenaltyExcessCharacter * ExcessCharacters; |
Daniel Jasper | 2df9331 | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 1198 | } |
Manuel Klimek | 2ef908e | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 1199 | |
| 1200 | Queue.push(QueueItem(OrderedPenalty(Penalty, Count), Node)); |
| 1201 | ++Count; |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1202 | } |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1203 | |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1204 | /// \brief Returns \c true, if a line break after \p State is allowed. |
| 1205 | bool canBreak(const LineState &State) { |
| 1206 | if (!State.NextToken->CanBreakBefore && |
| 1207 | !(State.NextToken->is(tok::r_brace) && |
| 1208 | State.Stack.back().BreakBeforeClosingBrace)) |
| 1209 | return false; |
| 1210 | // Trying to insert a parameter on a new line if there are already more than |
| 1211 | // one parameter on the current line is bin packing. |
Daniel Jasper | b9ebd5d | 2013-02-05 09:41:21 +0000 | [diff] [blame] | 1212 | if (State.Stack.back().HasMultiParameterLine && |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1213 | State.Stack.back().AvoidBinPacking) |
| 1214 | return false; |
| 1215 | return true; |
| 1216 | } |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1217 | |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1218 | /// \brief Returns \c true, if a line break after \p State is mandatory. |
| 1219 | bool mustBreak(const LineState &State) { |
| 1220 | if (State.NextToken->MustBreakBefore) |
| 1221 | return true; |
| 1222 | if (State.NextToken->is(tok::r_brace) && |
| 1223 | State.Stack.back().BreakBeforeClosingBrace) |
| 1224 | return true; |
| 1225 | if (State.NextToken->Parent->is(tok::semi) && |
| 1226 | State.LineContainsContinuedForLoopSection) |
| 1227 | return true; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1228 | if ((State.NextToken->Parent->isOneOf(tok::comma, tok::semi) || |
Daniel Jasper | cd8599e | 2013-02-23 21:01:55 +0000 | [diff] [blame] | 1229 | State.NextToken->is(tok::question) || |
| 1230 | State.NextToken->Type == TT_ConditionalExpr) && |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 1231 | State.Stack.back().BreakBeforeParameter && |
Daniel Jasper | 66e9dee | 2013-02-14 09:19:04 +0000 | [diff] [blame] | 1232 | !isTrailingComment(*State.NextToken) && |
Daniel Jasper | 37905f7 | 2013-02-21 15:00:29 +0000 | [diff] [blame] | 1233 | State.NextToken->isNot(tok::r_paren) && |
| 1234 | State.NextToken->isNot(tok::r_brace)) |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1235 | return true; |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 1236 | // FIXME: Comparing LongestObjCSelectorName to 0 is a hacky way of finding |
| 1237 | // out whether it is the first parameter. Clean this up. |
Daniel Jasper | 1ac3e05 | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 1238 | if (State.NextToken->Type == TT_ObjCSelectorName && |
Daniel Jasper | acc3366 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 1239 | State.NextToken->LongestObjCSelectorName == 0 && |
| 1240 | State.Stack.back().BreakBeforeParameter) |
Daniel Jasper | 1ac3e05 | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 1241 | return true; |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1242 | if ((State.NextToken->Type == TT_CtorInitializerColon || |
| 1243 | (State.NextToken->Parent->ClosesTemplateDeclaration && |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 1244 | State.ParenLevel == 0))) |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1245 | return true; |
Daniel Jasper | 40aacf4 | 2013-03-14 13:45:21 +0000 | [diff] [blame] | 1246 | if (State.NextToken->Type == TT_InlineASMColon) |
| 1247 | return true; |
Daniel Jasper | 9b33424 | 2013-03-15 14:57:30 +0000 | [diff] [blame] | 1248 | // This prevents breaks like: |
| 1249 | // ... |
| 1250 | // SomeParameter, OtherParameter).DoSomething( |
| 1251 | // ... |
| 1252 | // As they hide "DoSomething" and generally bad for readability. |
| 1253 | if (State.NextToken->isOneOf(tok::period, tok::arrow) && |
| 1254 | getRemainingLength(State) + State.Column > getColumnLimit() && |
| 1255 | State.ParenLevel < State.StartOfLineLevel) |
| 1256 | return true; |
Daniel Jasper | 4b86627 | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 1257 | return false; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1258 | } |
| 1259 | |
Daniel Jasper | 9b33424 | 2013-03-15 14:57:30 +0000 | [diff] [blame] | 1260 | // Returns the total number of columns required for the remaining tokens. |
| 1261 | unsigned getRemainingLength(const LineState &State) { |
| 1262 | if (State.NextToken && State.NextToken->Parent) |
| 1263 | return Line.Last->TotalLength - State.NextToken->Parent->TotalLength; |
| 1264 | return 0; |
| 1265 | } |
| 1266 | |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1267 | FormatStyle Style; |
| 1268 | SourceManager &SourceMgr; |
Daniel Jasper | f1e4b7d | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1269 | const AnnotatedLine &Line; |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1270 | const unsigned FirstIndent; |
Daniel Jasper | 7c85fde | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1271 | const AnnotatedToken &RootToken; |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 1272 | WhitespaceManager &Whitespaces; |
Manuel Klimek | af49107 | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 1273 | |
| 1274 | llvm::SpecificBumpPtrAllocator<StateNode> Allocator; |
| 1275 | QueueType Queue; |
| 1276 | // Increasing count of \c StateNode items we have created. This is used |
| 1277 | // to create a deterministic order independent of the container. |
| 1278 | unsigned Count; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1279 | }; |
| 1280 | |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1281 | class LexerBasedFormatTokenSource : public FormatTokenSource { |
| 1282 | public: |
| 1283 | LexerBasedFormatTokenSource(Lexer &Lex, SourceManager &SourceMgr) |
Daniel Jasper | 2af6bbe | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 1284 | : GreaterStashed(false), Lex(Lex), SourceMgr(SourceMgr), |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1285 | IdentTable(Lex.getLangOpts()) { |
| 1286 | Lex.SetKeepWhitespaceMode(true); |
| 1287 | } |
| 1288 | |
| 1289 | virtual FormatToken getNextToken() { |
| 1290 | if (GreaterStashed) { |
| 1291 | FormatTok.NewlinesBefore = 0; |
| 1292 | FormatTok.WhiteSpaceStart = |
| 1293 | FormatTok.Tok.getLocation().getLocWithOffset(1); |
| 1294 | FormatTok.WhiteSpaceLength = 0; |
| 1295 | GreaterStashed = false; |
| 1296 | return FormatTok; |
| 1297 | } |
| 1298 | |
| 1299 | FormatTok = FormatToken(); |
| 1300 | Lex.LexFromRawLexer(FormatTok.Tok); |
Manuel Klimek | ef92069 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1301 | StringRef Text = rawTokenText(FormatTok.Tok); |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1302 | FormatTok.WhiteSpaceStart = FormatTok.Tok.getLocation(); |
Manuel Klimek | 52d0fd8 | 2013-01-05 22:56:06 +0000 | [diff] [blame] | 1303 | if (SourceMgr.getFileOffset(FormatTok.WhiteSpaceStart) == 0) |
| 1304 | FormatTok.IsFirst = true; |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1305 | |
| 1306 | // Consume and record whitespace until we find a significant token. |
| 1307 | while (FormatTok.Tok.is(tok::unknown)) { |
Manuel Klimek | 0c13795 | 2013-02-11 12:33:24 +0000 | [diff] [blame] | 1308 | unsigned Newlines = Text.count('\n'); |
Daniel Jasper | 973c942 | 2013-03-04 13:43:19 +0000 | [diff] [blame] | 1309 | if (Newlines > 0) |
| 1310 | FormatTok.LastNewlineOffset = |
| 1311 | FormatTok.WhiteSpaceLength + Text.rfind('\n') + 1; |
Manuel Klimek | 0c13795 | 2013-02-11 12:33:24 +0000 | [diff] [blame] | 1312 | unsigned EscapedNewlines = Text.count("\\\n"); |
| 1313 | FormatTok.NewlinesBefore += Newlines; |
| 1314 | FormatTok.HasUnescapedNewline |= EscapedNewlines != Newlines; |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1315 | FormatTok.WhiteSpaceLength += FormatTok.Tok.getLength(); |
| 1316 | |
| 1317 | if (FormatTok.Tok.is(tok::eof)) |
| 1318 | return FormatTok; |
| 1319 | Lex.LexFromRawLexer(FormatTok.Tok); |
Manuel Klimek | ef92069 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1320 | Text = rawTokenText(FormatTok.Tok); |
Manuel Klimek | 1abf789 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1321 | } |
Manuel Klimek | ef92069 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1322 | |
| 1323 | // Now FormatTok is the next non-whitespace token. |
| 1324 | FormatTok.TokenLength = Text.size(); |
| 1325 | |
Manuel Klimek | 1abf789 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1326 | // In case the token starts with escaped newlines, we want to |
| 1327 | // take them into account as whitespace - this pattern is quite frequent |
| 1328 | // in macro definitions. |
| 1329 | // FIXME: What do we want to do with other escaped spaces, and escaped |
| 1330 | // spaces or newlines in the middle of tokens? |
| 1331 | // FIXME: Add a more explicit test. |
| 1332 | unsigned i = 0; |
Daniel Jasper | da16db3 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1333 | while (i + 1 < Text.size() && Text[i] == '\\' && Text[i + 1] == '\n') { |
Manuel Klimek | f92f7bc | 2013-01-22 16:31:55 +0000 | [diff] [blame] | 1334 | // FIXME: ++FormatTok.NewlinesBefore is missing... |
Manuel Klimek | 1abf789 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1335 | FormatTok.WhiteSpaceLength += 2; |
Manuel Klimek | ef92069 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1336 | FormatTok.TokenLength -= 2; |
Manuel Klimek | 1abf789 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1337 | i += 2; |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1338 | } |
| 1339 | |
| 1340 | if (FormatTok.Tok.is(tok::raw_identifier)) { |
Manuel Klimek | 1abf789 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1341 | IdentifierInfo &Info = IdentTable.get(Text); |
Daniel Jasper | 050948a5 | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1342 | FormatTok.Tok.setIdentifierInfo(&Info); |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1343 | FormatTok.Tok.setKind(Info.getTokenID()); |
| 1344 | } |
| 1345 | |
| 1346 | if (FormatTok.Tok.is(tok::greatergreater)) { |
| 1347 | FormatTok.Tok.setKind(tok::greater); |
Daniel Jasper | 57d4a58 | 2013-02-28 10:06:05 +0000 | [diff] [blame] | 1348 | FormatTok.TokenLength = 1; |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1349 | GreaterStashed = true; |
| 1350 | } |
| 1351 | |
Daniel Jasper | 3324cbe | 2013-03-01 16:45:59 +0000 | [diff] [blame] | 1352 | // If we reformat comments, we remove trailing whitespace. Update the length |
| 1353 | // accordingly. |
| 1354 | if (FormatTok.Tok.is(tok::comment)) |
| 1355 | FormatTok.TokenLength = Text.rtrim().size(); |
| 1356 | |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1357 | return FormatTok; |
| 1358 | } |
| 1359 | |
Nico Weber | 29f9dea | 2013-02-11 15:32:15 +0000 | [diff] [blame] | 1360 | IdentifierTable &getIdentTable() { return IdentTable; } |
| 1361 | |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1362 | private: |
| 1363 | FormatToken FormatTok; |
| 1364 | bool GreaterStashed; |
| 1365 | Lexer &Lex; |
| 1366 | SourceManager &SourceMgr; |
| 1367 | IdentifierTable IdentTable; |
| 1368 | |
| 1369 | /// Returns the text of \c FormatTok. |
Manuel Klimek | ef92069 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1370 | StringRef rawTokenText(Token &Tok) { |
Alexander Kornienko | e327684 | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1371 | return StringRef(SourceMgr.getCharacterData(Tok.getLocation()), |
| 1372 | Tok.getLength()); |
| 1373 | } |
| 1374 | }; |
| 1375 | |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1376 | class Formatter : public UnwrappedLineConsumer { |
| 1377 | public: |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1378 | Formatter(DiagnosticsEngine &Diag, const FormatStyle &Style, Lexer &Lex, |
| 1379 | SourceManager &SourceMgr, |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1380 | const std::vector<CharSourceRange> &Ranges) |
Alexander Kornienko | 5b7157a | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1381 | : Diag(Diag), Style(Style), Lex(Lex), SourceMgr(SourceMgr), |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 1382 | Whitespaces(SourceMgr, Style), Ranges(Ranges) {} |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1383 | |
Daniel Jasper | fd8c4b1 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 1384 | virtual ~Formatter() {} |
Daniel Jasper | 61bd3a1 | 2012-12-04 21:05:31 +0000 | [diff] [blame] | 1385 | |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1386 | tooling::Replacements format() { |
| 1387 | LexerBasedFormatTokenSource Tokens(Lex, SourceMgr); |
| 1388 | UnwrappedLineParser Parser(Diag, Style, Tokens, *this); |
| 1389 | StructuralError = Parser.parse(); |
| 1390 | unsigned PreviousEndOfLineColumn = 0; |
| 1391 | TokenAnnotator Annotator(Style, SourceMgr, Lex, |
| 1392 | Tokens.getIdentTable().get("in")); |
| 1393 | for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) { |
| 1394 | Annotator.annotate(AnnotatedLines[i]); |
| 1395 | } |
| 1396 | deriveLocalStyle(); |
| 1397 | for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) { |
| 1398 | Annotator.calculateFormattingInformation(AnnotatedLines[i]); |
Daniel Jasper | 0f8ed9e | 2013-03-13 15:53:12 +0000 | [diff] [blame] | 1399 | |
| 1400 | // Adapt level to the next line if this is a comment. |
| 1401 | // FIXME: Can/should this be done in the UnwrappedLineParser? |
| 1402 | if (i + 1 != e && AnnotatedLines[i].First.is(tok::comment) && |
| 1403 | AnnotatedLines[i].First.Children.empty() && |
| 1404 | AnnotatedLines[i + 1].First.isNot(tok::r_brace)) |
| 1405 | AnnotatedLines[i].Level = AnnotatedLines[i + 1].Level; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1406 | } |
| 1407 | std::vector<int> IndentForLevel; |
| 1408 | bool PreviousLineWasTouched = false; |
Alexander Kornienko | fd43336 | 2013-03-27 17:08:02 +0000 | [diff] [blame] | 1409 | const AnnotatedToken *PreviousLineLastToken = 0; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1410 | for (std::vector<AnnotatedLine>::iterator I = AnnotatedLines.begin(), |
| 1411 | E = AnnotatedLines.end(); |
| 1412 | I != E; ++I) { |
| 1413 | const AnnotatedLine &TheLine = *I; |
| 1414 | const FormatToken &FirstTok = TheLine.First.FormatTok; |
| 1415 | int Offset = getIndentOffset(TheLine.First); |
| 1416 | while (IndentForLevel.size() <= TheLine.Level) |
| 1417 | IndentForLevel.push_back(-1); |
| 1418 | IndentForLevel.resize(TheLine.Level + 1); |
Daniel Jasper | d1ae358 | 2013-03-20 12:37:50 +0000 | [diff] [blame] | 1419 | bool WasMoved = PreviousLineWasTouched && FirstTok.NewlinesBefore == 0; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1420 | if (TheLine.First.is(tok::eof)) { |
| 1421 | if (PreviousLineWasTouched) { |
| 1422 | unsigned NewLines = std::min(FirstTok.NewlinesBefore, 1u); |
| 1423 | Whitespaces.replaceWhitespace(TheLine.First, NewLines, /*Indent*/ 0, |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 1424 | /*WhitespaceStartColumn*/ 0); |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1425 | } |
| 1426 | } else if (TheLine.Type != LT_Invalid && |
| 1427 | (WasMoved || touchesLine(TheLine))) { |
| 1428 | unsigned LevelIndent = getIndent(IndentForLevel, TheLine.Level); |
| 1429 | unsigned Indent = LevelIndent; |
| 1430 | if (static_cast<int>(Indent) + Offset >= 0) |
| 1431 | Indent += Offset; |
| 1432 | if (!FirstTok.WhiteSpaceStart.isValid() || StructuralError) { |
Daniel Jasper | d1ae358 | 2013-03-20 12:37:50 +0000 | [diff] [blame] | 1433 | Indent = LevelIndent = |
| 1434 | SourceMgr.getSpellingColumnNumber(FirstTok.Tok.getLocation()) - 1; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1435 | } else { |
Alexander Kornienko | fd43336 | 2013-03-27 17:08:02 +0000 | [diff] [blame] | 1436 | formatFirstToken(TheLine.First, PreviousLineLastToken, Indent, |
| 1437 | TheLine.InPPDirective, PreviousEndOfLineColumn); |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1438 | } |
| 1439 | tryFitMultipleLinesInOne(Indent, I, E); |
| 1440 | UnwrappedLineFormatter Formatter(Style, SourceMgr, TheLine, Indent, |
| 1441 | TheLine.First, Whitespaces, |
| 1442 | StructuralError); |
| 1443 | PreviousEndOfLineColumn = |
| 1444 | Formatter.format(I + 1 != E ? &*(I + 1) : NULL); |
| 1445 | IndentForLevel[TheLine.Level] = LevelIndent; |
| 1446 | PreviousLineWasTouched = true; |
| 1447 | } else { |
| 1448 | if (FirstTok.NewlinesBefore > 0 || FirstTok.IsFirst) { |
| 1449 | unsigned Indent = |
| 1450 | SourceMgr.getSpellingColumnNumber(FirstTok.Tok.getLocation()) - 1; |
| 1451 | unsigned LevelIndent = Indent; |
| 1452 | if (static_cast<int>(LevelIndent) - Offset >= 0) |
| 1453 | LevelIndent -= Offset; |
Daniel Jasper | 66dc2ec | 2013-03-20 14:31:47 +0000 | [diff] [blame] | 1454 | if (TheLine.First.isNot(tok::comment)) |
| 1455 | IndentForLevel[TheLine.Level] = LevelIndent; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1456 | |
| 1457 | // Remove trailing whitespace of the previous line if it was touched. |
| 1458 | if (PreviousLineWasTouched || touchesEmptyLineBefore(TheLine)) |
Alexander Kornienko | fd43336 | 2013-03-27 17:08:02 +0000 | [diff] [blame] | 1459 | formatFirstToken(TheLine.First, PreviousLineLastToken, Indent, |
| 1460 | TheLine.InPPDirective, PreviousEndOfLineColumn); |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1461 | } |
| 1462 | // If we did not reformat this unwrapped line, the column at the end of |
| 1463 | // the last token is unchanged - thus, we can calculate the end of the |
| 1464 | // last token. |
| 1465 | SourceLocation LastLoc = TheLine.Last->FormatTok.Tok.getLocation(); |
| 1466 | PreviousEndOfLineColumn = |
| 1467 | SourceMgr.getSpellingColumnNumber(LastLoc) + |
| 1468 | Lex.MeasureTokenLength(LastLoc, SourceMgr, Lex.getLangOpts()) - 1; |
| 1469 | PreviousLineWasTouched = false; |
Daniel Jasper | bc0fa39 | 2013-03-22 16:25:51 +0000 | [diff] [blame] | 1470 | if (TheLine.Last->is(tok::comment)) |
| 1471 | Whitespaces.addUntouchableComment(SourceMgr.getSpellingColumnNumber( |
| 1472 | TheLine.Last->FormatTok.Tok.getLocation()) - 1); |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1473 | } |
Alexander Kornienko | fd43336 | 2013-03-27 17:08:02 +0000 | [diff] [blame] | 1474 | PreviousLineLastToken = I->Last; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1475 | } |
| 1476 | return Whitespaces.generateReplacements(); |
| 1477 | } |
| 1478 | |
| 1479 | private: |
Daniel Jasper | 7fce3ab | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 1480 | void deriveLocalStyle() { |
| 1481 | unsigned CountBoundToVariable = 0; |
| 1482 | unsigned CountBoundToType = 0; |
| 1483 | bool HasCpp03IncompatibleFormat = false; |
| 1484 | for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) { |
| 1485 | if (AnnotatedLines[i].First.Children.empty()) |
| 1486 | continue; |
| 1487 | AnnotatedToken *Tok = &AnnotatedLines[i].First.Children[0]; |
| 1488 | while (!Tok->Children.empty()) { |
| 1489 | if (Tok->Type == TT_PointerOrReference) { |
| 1490 | bool SpacesBefore = Tok->FormatTok.WhiteSpaceLength > 0; |
| 1491 | bool SpacesAfter = Tok->Children[0].FormatTok.WhiteSpaceLength > 0; |
| 1492 | if (SpacesBefore && !SpacesAfter) |
| 1493 | ++CountBoundToVariable; |
| 1494 | else if (!SpacesBefore && SpacesAfter) |
| 1495 | ++CountBoundToType; |
| 1496 | } |
| 1497 | |
Daniel Jasper | 400adc6 | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 1498 | if (Tok->Type == TT_TemplateCloser && |
| 1499 | Tok->Parent->Type == TT_TemplateCloser && |
| 1500 | Tok->FormatTok.WhiteSpaceLength == 0) |
Daniel Jasper | 7fce3ab | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 1501 | HasCpp03IncompatibleFormat = true; |
| 1502 | Tok = &Tok->Children[0]; |
| 1503 | } |
| 1504 | } |
| 1505 | if (Style.DerivePointerBinding) { |
| 1506 | if (CountBoundToType > CountBoundToVariable) |
| 1507 | Style.PointerBindsToType = true; |
| 1508 | else if (CountBoundToType < CountBoundToVariable) |
| 1509 | Style.PointerBindsToType = false; |
| 1510 | } |
| 1511 | if (Style.Standard == FormatStyle::LS_Auto) { |
| 1512 | Style.Standard = HasCpp03IncompatibleFormat ? FormatStyle::LS_Cpp11 |
| 1513 | : FormatStyle::LS_Cpp03; |
| 1514 | } |
| 1515 | } |
| 1516 | |
Manuel Klimek | b95f545 | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1517 | /// \brief Get the indent of \p Level from \p IndentForLevel. |
| 1518 | /// |
| 1519 | /// \p IndentForLevel must contain the indent for the level \c l |
| 1520 | /// at \p IndentForLevel[l], or a value < 0 if the indent for |
| 1521 | /// that level is unknown. |
Daniel Jasper | 687af3b | 2013-02-14 14:26:07 +0000 | [diff] [blame] | 1522 | unsigned getIndent(const std::vector<int> IndentForLevel, unsigned Level) { |
Manuel Klimek | b95f545 | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1523 | if (IndentForLevel[Level] != -1) |
| 1524 | return IndentForLevel[Level]; |
Manuel Klimek | d076dcd | 2013-02-08 19:53:32 +0000 | [diff] [blame] | 1525 | if (Level == 0) |
| 1526 | return 0; |
Daniel Jasper | 2457010 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1527 | return getIndent(IndentForLevel, Level - 1) + 2; |
Manuel Klimek | b95f545 | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1528 | } |
| 1529 | |
| 1530 | /// \brief Get the offset of the line relatively to the level. |
| 1531 | /// |
| 1532 | /// For example, 'public:' labels in classes are offset by 1 or 2 |
| 1533 | /// characters to the left from their level. |
Daniel Jasper | 2457010 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1534 | int getIndentOffset(const AnnotatedToken &RootToken) { |
Alexander Kornienko | fd43336 | 2013-03-27 17:08:02 +0000 | [diff] [blame] | 1535 | if (RootToken.isAccessSpecifier(false) || RootToken.isObjCAccessSpecifier()) |
Manuel Klimek | b95f545 | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1536 | return Style.AccessModifierOffset; |
| 1537 | return 0; |
| 1538 | } |
| 1539 | |
Manuel Klimek | f4ab9ef | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1540 | /// \brief Tries to merge lines into one. |
| 1541 | /// |
| 1542 | /// This will change \c Line and \c AnnotatedLine to contain the merged line, |
| 1543 | /// if possible; note that \c I will be incremented when lines are merged. |
| 1544 | /// |
| 1545 | /// Returns whether the resulting \c Line can fit in a single line. |
Daniel Jasper | a67a8f0 | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1546 | void tryFitMultipleLinesInOne(unsigned Indent, |
Daniel Jasper | f1e4b7d | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1547 | std::vector<AnnotatedLine>::iterator &I, |
| 1548 | std::vector<AnnotatedLine>::iterator E) { |
Daniel Jasper | a67a8f0 | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1549 | // We can never merge stuff if there are trailing line comments. |
| 1550 | if (I->Last->Type == TT_LineComment) |
| 1551 | return; |
| 1552 | |
Daniel Jasper | c22f5b4 | 2013-02-28 11:05:57 +0000 | [diff] [blame] | 1553 | unsigned Limit = Style.ColumnLimit - Indent; |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 1554 | // If we already exceed the column limit, we set 'Limit' to 0. The different |
| 1555 | // tryMerge..() functions can then decide whether to still do merging. |
| 1556 | Limit = I->Last->TotalLength > Limit ? 0 : Limit - I->Last->TotalLength; |
Daniel Jasper | c36492b | 2013-01-16 07:02:34 +0000 | [diff] [blame] | 1557 | |
Daniel Jasper | d41ee2d | 2013-01-21 14:18:28 +0000 | [diff] [blame] | 1558 | if (I + 1 == E || (I + 1)->Type == LT_Invalid) |
Daniel Jasper | a67a8f0 | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1559 | return; |
Manuel Klimek | f4ab9ef | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1560 | |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1561 | if (I->Last->is(tok::l_brace)) { |
| 1562 | tryMergeSimpleBlock(I, E, Limit); |
| 1563 | } else if (I->First.is(tok::kw_if)) { |
| 1564 | tryMergeSimpleIf(I, E, Limit); |
Daniel Jasper | 39825ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1565 | } else if (I->InPPDirective && (I->First.FormatTok.HasUnescapedNewline || |
| 1566 | I->First.FormatTok.IsFirst)) { |
| 1567 | tryMergeSimplePPDirective(I, E, Limit); |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1568 | } |
Daniel Jasper | a67a8f0 | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1569 | return; |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1570 | } |
| 1571 | |
Daniel Jasper | 39825ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1572 | void tryMergeSimplePPDirective(std::vector<AnnotatedLine>::iterator &I, |
| 1573 | std::vector<AnnotatedLine>::iterator E, |
| 1574 | unsigned Limit) { |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 1575 | if (Limit == 0) |
| 1576 | return; |
Daniel Jasper | 39825ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1577 | AnnotatedLine &Line = *I; |
Daniel Jasper | 2ab0d01 | 2013-01-14 15:52:06 +0000 | [diff] [blame] | 1578 | if (!(I + 1)->InPPDirective || (I + 1)->First.FormatTok.HasUnescapedNewline) |
| 1579 | return; |
Daniel Jasper | 39825ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1580 | if (I + 2 != E && (I + 2)->InPPDirective && |
| 1581 | !(I + 2)->First.FormatTok.HasUnescapedNewline) |
| 1582 | return; |
Manuel Klimek | a4fe1c1 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1583 | if (1 + (I + 1)->Last->TotalLength > Limit) |
Daniel Jasper | a67a8f0 | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1584 | return; |
Daniel Jasper | 39825ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1585 | join(Line, *(++I)); |
| 1586 | } |
| 1587 | |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1588 | void tryMergeSimpleIf(std::vector<AnnotatedLine>::iterator &I, |
| 1589 | std::vector<AnnotatedLine>::iterator E, |
| 1590 | unsigned Limit) { |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 1591 | if (Limit == 0) |
| 1592 | return; |
Daniel Jasper | 1b750ed | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 1593 | if (!Style.AllowShortIfStatementsOnASingleLine) |
| 1594 | return; |
Manuel Klimek | da08761 | 2013-01-18 14:46:43 +0000 | [diff] [blame] | 1595 | if ((I + 1)->InPPDirective != I->InPPDirective || |
| 1596 | ((I + 1)->InPPDirective && |
| 1597 | (I + 1)->First.FormatTok.HasUnescapedNewline)) |
| 1598 | return; |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1599 | AnnotatedLine &Line = *I; |
Daniel Jasper | c36492b | 2013-01-16 07:02:34 +0000 | [diff] [blame] | 1600 | if (Line.Last->isNot(tok::r_paren)) |
| 1601 | return; |
Manuel Klimek | a4fe1c1 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1602 | if (1 + (I + 1)->Last->TotalLength > Limit) |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1603 | return; |
| 1604 | if ((I + 1)->First.is(tok::kw_if) || (I + 1)->First.Type == TT_LineComment) |
| 1605 | return; |
| 1606 | // Only inline simple if's (no nested if or else). |
| 1607 | if (I + 2 != E && (I + 2)->First.is(tok::kw_else)) |
| 1608 | return; |
| 1609 | join(Line, *(++I)); |
| 1610 | } |
| 1611 | |
| 1612 | void tryMergeSimpleBlock(std::vector<AnnotatedLine>::iterator &I, |
Daniel Jasper | bbc8415 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 1613 | std::vector<AnnotatedLine>::iterator E, |
| 1614 | unsigned Limit) { |
Manuel Klimek | f4ab9ef | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1615 | // First, check that the current line allows merging. This is the case if |
| 1616 | // we're not in a control flow statement and the last token is an opening |
| 1617 | // brace. |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1618 | AnnotatedLine &Line = *I; |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1619 | if (Line.First.isOneOf(tok::kw_if, tok::kw_while, tok::kw_do, tok::r_brace, |
| 1620 | tok::kw_else, tok::kw_try, tok::kw_catch, |
| 1621 | tok::kw_for, |
| 1622 | // This gets rid of all ObjC @ keywords and methods. |
| 1623 | tok::at, tok::minus, tok::plus)) |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1624 | return; |
Manuel Klimek | f4ab9ef | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1625 | |
Manuel Klimek | a4fe1c1 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1626 | AnnotatedToken *Tok = &(I + 1)->First; |
| 1627 | if (Tok->Children.empty() && Tok->is(tok::r_brace) && |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 1628 | !Tok->MustBreakBefore) { |
| 1629 | // We merge empty blocks even if the line exceeds the column limit. |
Daniel Jasper | eef3049 | 2013-02-11 12:36:37 +0000 | [diff] [blame] | 1630 | Tok->SpacesRequiredBefore = 0; |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 1631 | Tok->CanBreakBefore = true; |
Manuel Klimek | a4fe1c1 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1632 | join(Line, *(I + 1)); |
| 1633 | I += 1; |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 1634 | } else if (Limit != 0) { |
Manuel Klimek | a4fe1c1 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1635 | // Check that we still have three lines and they fit into the limit. |
| 1636 | if (I + 2 == E || (I + 2)->Type == LT_Invalid || |
| 1637 | !nextTwoLinesFitInto(I, Limit)) |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1638 | return; |
Manuel Klimek | f4ab9ef | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1639 | |
Manuel Klimek | a4fe1c1 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1640 | // Second, check that the next line does not contain any braces - if it |
| 1641 | // does, readability declines when putting it into a single line. |
| 1642 | if ((I + 1)->Last->Type == TT_LineComment || Tok->MustBreakBefore) |
| 1643 | return; |
| 1644 | do { |
Alexander Kornienko | 62b85b9 | 2013-03-13 14:41:29 +0000 | [diff] [blame] | 1645 | if (Tok->isOneOf(tok::l_brace, tok::r_brace)) |
Manuel Klimek | a4fe1c1 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1646 | return; |
| 1647 | Tok = Tok->Children.empty() ? NULL : &Tok->Children.back(); |
| 1648 | } while (Tok != NULL); |
Manuel Klimek | f4ab9ef | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1649 | |
Manuel Klimek | a4fe1c1 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1650 | // Last, check that the third line contains a single closing brace. |
| 1651 | Tok = &(I + 2)->First; |
| 1652 | if (!Tok->Children.empty() || Tok->isNot(tok::r_brace) || |
| 1653 | Tok->MustBreakBefore) |
| 1654 | return; |
| 1655 | |
| 1656 | join(Line, *(I + 1)); |
| 1657 | join(Line, *(I + 2)); |
| 1658 | I += 2; |
Manuel Klimek | f4ab9ef | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1659 | } |
Daniel Jasper | 25837aa | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1660 | } |
| 1661 | |
| 1662 | bool nextTwoLinesFitInto(std::vector<AnnotatedLine>::iterator I, |
| 1663 | unsigned Limit) { |
Manuel Klimek | a4fe1c1 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1664 | return 1 + (I + 1)->Last->TotalLength + 1 + (I + 2)->Last->TotalLength <= |
| 1665 | Limit; |
Manuel Klimek | f4ab9ef | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1666 | } |
| 1667 | |
Daniel Jasper | f1e4b7d | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1668 | void join(AnnotatedLine &A, const AnnotatedLine &B) { |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 1669 | unsigned LengthA = A.Last->TotalLength + B.First.SpacesRequiredBefore; |
Daniel Jasper | f1e4b7d | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1670 | A.Last->Children.push_back(B.First); |
| 1671 | while (!A.Last->Children.empty()) { |
| 1672 | A.Last->Children[0].Parent = A.Last; |
Daniel Jasper | 12ef4e5 | 2013-02-21 21:33:55 +0000 | [diff] [blame] | 1673 | A.Last->Children[0].TotalLength += LengthA; |
Daniel Jasper | f1e4b7d | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1674 | A.Last = &A.Last->Children[0]; |
| 1675 | } |
Manuel Klimek | 51bd6ec | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1676 | } |
| 1677 | |
Daniel Jasper | 97b8948 | 2013-03-13 07:49:51 +0000 | [diff] [blame] | 1678 | bool touchesRanges(const CharSourceRange &Range) { |
Daniel Jasper | f71cf3b | 2013-03-07 20:50:00 +0000 | [diff] [blame] | 1679 | for (unsigned i = 0, e = Ranges.size(); i != e; ++i) { |
| 1680 | if (!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(), |
| 1681 | Ranges[i].getBegin()) && |
| 1682 | !SourceMgr.isBeforeInTranslationUnit(Ranges[i].getEnd(), |
| 1683 | Range.getBegin())) |
| 1684 | return true; |
| 1685 | } |
| 1686 | return false; |
| 1687 | } |
| 1688 | |
| 1689 | bool touchesLine(const AnnotatedLine &TheLine) { |
Daniel Jasper | f1e4b7d | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1690 | const FormatToken *First = &TheLine.First.FormatTok; |
| 1691 | const FormatToken *Last = &TheLine.Last->FormatTok; |
Daniel Jasper | 8d1832e | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1692 | CharSourceRange LineRange = CharSourceRange::getTokenRange( |
Daniel Jasper | 973c942 | 2013-03-04 13:43:19 +0000 | [diff] [blame] | 1693 | First->WhiteSpaceStart.getLocWithOffset(First->LastNewlineOffset), |
| 1694 | Last->Tok.getLocation()); |
Daniel Jasper | f71cf3b | 2013-03-07 20:50:00 +0000 | [diff] [blame] | 1695 | return touchesRanges(LineRange); |
| 1696 | } |
| 1697 | |
| 1698 | bool touchesEmptyLineBefore(const AnnotatedLine &TheLine) { |
| 1699 | const FormatToken *First = &TheLine.First.FormatTok; |
| 1700 | CharSourceRange LineRange = CharSourceRange::getCharRange( |
| 1701 | First->WhiteSpaceStart, |
| 1702 | First->WhiteSpaceStart.getLocWithOffset(First->LastNewlineOffset)); |
| 1703 | return touchesRanges(LineRange); |
Manuel Klimek | 51bd6ec | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1704 | } |
| 1705 | |
| 1706 | virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) { |
Daniel Jasper | daffc0d | 2013-01-16 09:10:19 +0000 | [diff] [blame] | 1707 | AnnotatedLines.push_back(AnnotatedLine(TheLine)); |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1708 | } |
| 1709 | |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1710 | /// \brief Add a new line and the required indent before the first Token |
| 1711 | /// of the \c UnwrappedLine if there was no structural parsing error. |
| 1712 | /// Returns the indent level of the \c UnwrappedLine. |
Alexander Kornienko | fd43336 | 2013-03-27 17:08:02 +0000 | [diff] [blame] | 1713 | void formatFirstToken(const AnnotatedToken &RootToken, |
| 1714 | const AnnotatedToken *PreviousToken, unsigned Indent, |
Manuel Klimek | b95f545 | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1715 | bool InPPDirective, unsigned PreviousEndOfLineColumn) { |
Daniel Jasper | fd8c4b1 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 1716 | const FormatToken &Tok = RootToken.FormatTok; |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1717 | |
Daniel Jasper | bbc8415 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 1718 | unsigned Newlines = |
| 1719 | std::min(Tok.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1); |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1720 | if (Newlines == 0 && !Tok.IsFirst) |
| 1721 | Newlines = 1; |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1722 | |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1723 | if (!InPPDirective || Tok.HasUnescapedNewline) { |
Alexander Kornienko | fd43336 | 2013-03-27 17:08:02 +0000 | [diff] [blame] | 1724 | // Insert extra new line before access specifiers. |
| 1725 | if (PreviousToken && PreviousToken->isOneOf(tok::semi, tok::r_brace) && |
| 1726 | RootToken.isAccessSpecifier() && Tok.NewlinesBefore == 1) |
| 1727 | ++Newlines; |
| 1728 | |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 1729 | Whitespaces.replaceWhitespace(RootToken, Newlines, Indent, 0); |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1730 | } else { |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 1731 | Whitespaces.replacePPWhitespace(RootToken, Newlines, Indent, |
Alexander Kornienko | afcef33 | 2013-03-19 17:41:36 +0000 | [diff] [blame] | 1732 | PreviousEndOfLineColumn); |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1733 | } |
Manuel Klimek | 0b689fd | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1734 | } |
| 1735 | |
Alexander Kornienko | 116ba68 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1736 | DiagnosticsEngine &Diag; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1737 | FormatStyle Style; |
| 1738 | Lexer &Lex; |
| 1739 | SourceManager &SourceMgr; |
Daniel Jasper | aa701fa | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 1740 | WhitespaceManager Whitespaces; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1741 | std::vector<CharSourceRange> Ranges; |
Daniel Jasper | f1e4b7d | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1742 | std::vector<AnnotatedLine> AnnotatedLines; |
Alexander Kornienko | 870f9eb | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1743 | bool StructuralError; |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1744 | }; |
| 1745 | |
Daniel Jasper | bbc8415 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 1746 | tooling::Replacements |
| 1747 | reformat(const FormatStyle &Style, Lexer &Lex, SourceManager &SourceMgr, |
| 1748 | std::vector<CharSourceRange> Ranges, DiagnosticConsumer *DiagClient) { |
Alexander Kornienko | 5b7157a | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1749 | IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions(); |
Alexander Kornienko | 116ba68 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1750 | OwningPtr<DiagnosticConsumer> DiagPrinter; |
| 1751 | if (DiagClient == 0) { |
| 1752 | DiagPrinter.reset(new TextDiagnosticPrinter(llvm::errs(), &*DiagOpts)); |
| 1753 | DiagPrinter->BeginSourceFile(Lex.getLangOpts(), Lex.getPP()); |
| 1754 | DiagClient = DiagPrinter.get(); |
| 1755 | } |
Alexander Kornienko | 5b7157a | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1756 | DiagnosticsEngine Diagnostics( |
Dmitri Gribenko | f857950 | 2013-01-12 19:30:44 +0000 | [diff] [blame] | 1757 | IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs()), &*DiagOpts, |
Alexander Kornienko | 116ba68 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1758 | DiagClient, false); |
Alexander Kornienko | 5b7157a | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1759 | Diagnostics.setSourceManager(&SourceMgr); |
| 1760 | Formatter formatter(Diagnostics, Style, Lex, SourceMgr, Ranges); |
Daniel Jasper | f793511 | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1761 | return formatter.format(); |
| 1762 | } |
| 1763 | |
Daniel Jasper | c1fa281 | 2013-01-10 13:08:12 +0000 | [diff] [blame] | 1764 | LangOptions getFormattingLangOpts() { |
| 1765 | LangOptions LangOpts; |
| 1766 | LangOpts.CPlusPlus = 1; |
| 1767 | LangOpts.CPlusPlus11 = 1; |
Daniel Jasper | 5521365 | 2013-03-22 10:01:29 +0000 | [diff] [blame] | 1768 | LangOpts.LineComment = 1; |
Daniel Jasper | c1fa281 | 2013-01-10 13:08:12 +0000 | [diff] [blame] | 1769 | LangOpts.Bool = 1; |
| 1770 | LangOpts.ObjC1 = 1; |
| 1771 | LangOpts.ObjC2 = 1; |
| 1772 | return LangOpts; |
| 1773 | } |
| 1774 | |
Daniel Jasper | 8d1832e | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1775 | } // namespace format |
| 1776 | } // namespace clang |