Daniel Jasper | bac016b | 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 | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 14 | //===----------------------------------------------------------------------===// |
| 15 | |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 16 | #define DEBUG_TYPE "format-formatter" |
| 17 | |
Daniel Jasper | 32d28ee | 2013-01-29 21:01:14 +0000 | [diff] [blame] | 18 | #include "TokenAnnotator.h" |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 19 | #include "UnwrappedLineParser.h" |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 20 | #include "clang/Basic/Diagnostic.h" |
Daniel Jasper | 675d2e3 | 2012-12-21 10:20:02 +0000 | [diff] [blame] | 21 | #include "clang/Basic/OperatorPrecedence.h" |
Chandler Carruth | b99083e | 2013-01-02 10:28:36 +0000 | [diff] [blame] | 22 | #include "clang/Basic/SourceManager.h" |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 23 | #include "clang/Format/Format.h" |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 24 | #include "clang/Frontend/TextDiagnosticPrinter.h" |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 25 | #include "clang/Lex/Lexer.h" |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 26 | #include "llvm/Support/Allocator.h" |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 27 | #include "llvm/Support/Debug.h" |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 28 | #include <queue> |
Daniel Jasper | 8822d3a | 2012-12-04 13:02:32 +0000 | [diff] [blame] | 29 | #include <string> |
| 30 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 31 | namespace clang { |
| 32 | namespace format { |
| 33 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 34 | FormatStyle getLLVMStyle() { |
| 35 | FormatStyle LLVMStyle; |
| 36 | LLVMStyle.ColumnLimit = 80; |
| 37 | LLVMStyle.MaxEmptyLinesToKeep = 1; |
Daniel Jasper | 8ff690a | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 38 | LLVMStyle.PointerBindsToType = false; |
| 39 | LLVMStyle.DerivePointerBinding = false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 40 | LLVMStyle.AccessModifierOffset = -2; |
Daniel Jasper | 8ff690a | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 41 | LLVMStyle.Standard = FormatStyle::LS_Cpp03; |
Alexander Kornienko | 1575731 | 2012-12-06 18:03:27 +0000 | [diff] [blame] | 42 | LLVMStyle.IndentCaseLabels = false; |
Daniel Jasper | 7ad4eff | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 43 | LLVMStyle.SpacesBeforeTrailingComments = 1; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 44 | LLVMStyle.BinPackParameters = true; |
Daniel Jasper | f157960 | 2013-01-29 16:03:49 +0000 | [diff] [blame] | 45 | LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 46 | LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false; |
Daniel Jasper | 6f5bb2c | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 47 | LLVMStyle.AllowShortIfStatementsOnASingleLine = false; |
Nico Weber | 5f500df | 2013-01-10 20:12:55 +0000 | [diff] [blame] | 48 | LLVMStyle.ObjCSpaceBeforeProtocolList = true; |
Daniel Jasper | 0178673 | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 49 | LLVMStyle.PenaltyExcessCharacter = 1000000; |
Daniel Jasper | a03ab10 | 2013-02-13 20:33:44 +0000 | [diff] [blame] | 50 | LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 5; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 51 | return LLVMStyle; |
| 52 | } |
| 53 | |
| 54 | FormatStyle getGoogleStyle() { |
| 55 | FormatStyle GoogleStyle; |
| 56 | GoogleStyle.ColumnLimit = 80; |
| 57 | GoogleStyle.MaxEmptyLinesToKeep = 1; |
Daniel Jasper | 8ff690a | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 58 | GoogleStyle.PointerBindsToType = true; |
| 59 | GoogleStyle.DerivePointerBinding = true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 60 | GoogleStyle.AccessModifierOffset = -1; |
Daniel Jasper | 8ff690a | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 61 | GoogleStyle.Standard = FormatStyle::LS_Auto; |
Alexander Kornienko | 1575731 | 2012-12-06 18:03:27 +0000 | [diff] [blame] | 62 | GoogleStyle.IndentCaseLabels = true; |
Daniel Jasper | 7ad4eff | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 63 | GoogleStyle.SpacesBeforeTrailingComments = 2; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 64 | GoogleStyle.BinPackParameters = false; |
Daniel Jasper | f157960 | 2013-01-29 16:03:49 +0000 | [diff] [blame] | 65 | GoogleStyle.AllowAllParametersOfDeclarationOnNextLine = true; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 66 | GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true; |
Daniel Jasper | df3736a | 2013-01-16 15:44:34 +0000 | [diff] [blame] | 67 | GoogleStyle.AllowShortIfStatementsOnASingleLine = false; |
Nico Weber | 5f500df | 2013-01-10 20:12:55 +0000 | [diff] [blame] | 68 | GoogleStyle.ObjCSpaceBeforeProtocolList = false; |
Daniel Jasper | 0178673 | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 69 | GoogleStyle.PenaltyExcessCharacter = 1000000; |
Daniel Jasper | a03ab10 | 2013-02-13 20:33:44 +0000 | [diff] [blame] | 70 | GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 100; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 71 | return GoogleStyle; |
| 72 | } |
| 73 | |
Daniel Jasper | 6f5bb2c | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 74 | FormatStyle getChromiumStyle() { |
| 75 | FormatStyle ChromiumStyle = getGoogleStyle(); |
Daniel Jasper | f157960 | 2013-01-29 16:03:49 +0000 | [diff] [blame] | 76 | ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false; |
Daniel Jasper | 8ff690a | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 77 | ChromiumStyle.Standard = FormatStyle::LS_Cpp03; |
| 78 | ChromiumStyle.DerivePointerBinding = false; |
Daniel Jasper | 6f5bb2c | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 79 | return ChromiumStyle; |
| 80 | } |
| 81 | |
Daniel Jasper | 15417ef | 2013-02-06 20:07:35 +0000 | [diff] [blame] | 82 | static bool isTrailingComment(const AnnotatedToken &Tok) { |
| 83 | return Tok.is(tok::comment) && |
| 84 | (Tok.Children.empty() || Tok.Children[0].MustBreakBefore); |
| 85 | } |
| 86 | |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 87 | // Returns the length of everything up to the first possible line break after |
| 88 | // the ), ], } or > matching \c Tok. |
| 89 | static unsigned getLengthToMatchingParen(const AnnotatedToken &Tok) { |
| 90 | if (Tok.MatchingParen == NULL) |
| 91 | return 0; |
| 92 | AnnotatedToken *End = Tok.MatchingParen; |
| 93 | while (!End->Children.empty() && !End->Children[0].CanBreakBefore) { |
| 94 | End = &End->Children[0]; |
| 95 | } |
| 96 | return End->TotalLength - Tok.TotalLength + 1; |
| 97 | } |
| 98 | |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 99 | /// \brief Manages the whitespaces around tokens and their replacements. |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 100 | /// |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 101 | /// This includes special handling for certain constructs, e.g. the alignment of |
| 102 | /// trailing line comments. |
| 103 | class WhitespaceManager { |
| 104 | public: |
| 105 | WhitespaceManager(SourceManager &SourceMgr) : SourceMgr(SourceMgr) {} |
| 106 | |
| 107 | /// \brief Replaces the whitespace in front of \p Tok. Only call once for |
| 108 | /// each \c AnnotatedToken. |
| 109 | void replaceWhitespace(const AnnotatedToken &Tok, unsigned NewLines, |
| 110 | unsigned Spaces, unsigned WhitespaceStartColumn, |
| 111 | const FormatStyle &Style) { |
Daniel Jasper | 821627e | 2013-01-21 22:49:20 +0000 | [diff] [blame] | 112 | // 2+ newlines mean an empty line separating logic scopes. |
| 113 | if (NewLines >= 2) |
| 114 | alignComments(); |
| 115 | |
| 116 | // Align line comments if they are trailing or if they continue other |
| 117 | // trailing comments. |
Daniel Jasper | 15417ef | 2013-02-06 20:07:35 +0000 | [diff] [blame] | 118 | if (isTrailingComment(Tok) && (Tok.Parent != NULL || !Comments.empty())) { |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 119 | if (Style.ColumnLimit >= |
| 120 | Spaces + WhitespaceStartColumn + Tok.FormatTok.TokenLength) { |
| 121 | Comments.push_back(StoredComment()); |
| 122 | Comments.back().Tok = Tok.FormatTok; |
| 123 | Comments.back().Spaces = Spaces; |
| 124 | Comments.back().NewLines = NewLines; |
Daniel Jasper | 474e462 | 2013-02-06 22:04:05 +0000 | [diff] [blame] | 125 | if (NewLines == 0) |
| 126 | Comments.back().MinColumn = WhitespaceStartColumn + Spaces; |
| 127 | else |
| 128 | Comments.back().MinColumn = Spaces; |
Daniel Jasper | 1a1ce83 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 129 | Comments.back().MaxColumn = |
Daniel Jasper | 42f458d | 2013-02-13 19:25:54 +0000 | [diff] [blame] | 130 | Style.ColumnLimit - Tok.FormatTok.TokenLength; |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 131 | return; |
| 132 | } |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 133 | } |
Daniel Jasper | 821627e | 2013-01-21 22:49:20 +0000 | [diff] [blame] | 134 | |
| 135 | // If this line does not have a trailing comment, align the stored comments. |
Daniel Jasper | 15417ef | 2013-02-06 20:07:35 +0000 | [diff] [blame] | 136 | if (Tok.Children.empty() && !isTrailingComment(Tok)) |
Daniel Jasper | 821627e | 2013-01-21 22:49:20 +0000 | [diff] [blame] | 137 | alignComments(); |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 138 | storeReplacement(Tok.FormatTok, getNewLineText(NewLines, Spaces)); |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 139 | } |
| 140 | |
| 141 | /// \brief Like \c replaceWhitespace, but additionally adds right-aligned |
| 142 | /// backslashes to escape newlines inside a preprocessor directive. |
| 143 | /// |
| 144 | /// This function and \c replaceWhitespace have the same behavior if |
| 145 | /// \c Newlines == 0. |
| 146 | void replacePPWhitespace(const AnnotatedToken &Tok, unsigned NewLines, |
| 147 | unsigned Spaces, unsigned WhitespaceStartColumn, |
| 148 | const FormatStyle &Style) { |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 149 | storeReplacement( |
| 150 | Tok.FormatTok, |
| 151 | getNewLineText(NewLines, Spaces, WhitespaceStartColumn, Style)); |
| 152 | } |
| 153 | |
| 154 | /// \brief Inserts a line break into the middle of a token. |
| 155 | /// |
| 156 | /// Will break at \p Offset inside \p Tok, putting \p Prefix before the line |
| 157 | /// break and \p Postfix before the rest of the token starts in the next line. |
| 158 | /// |
| 159 | /// \p InPPDirective, \p Spaces, \p WhitespaceStartColumn and \p Style are |
| 160 | /// used to generate the correct line break. |
| 161 | void breakToken(const AnnotatedToken &Tok, unsigned Offset, StringRef Prefix, |
| 162 | StringRef Postfix, bool InPPDirective, unsigned Spaces, |
| 163 | unsigned WhitespaceStartColumn, const FormatStyle &Style) { |
| 164 | std::string NewLineText; |
| 165 | if (!InPPDirective) |
| 166 | NewLineText = getNewLineText(1, Spaces); |
| 167 | else |
| 168 | NewLineText = getNewLineText(1, Spaces, WhitespaceStartColumn, Style); |
| 169 | std::string ReplacementText = (Prefix + NewLineText + Postfix).str(); |
| 170 | SourceLocation InsertAt = Tok.FormatTok.WhiteSpaceStart |
| 171 | .getLocWithOffset(Tok.FormatTok.WhiteSpaceLength + Offset); |
| 172 | Replaces.insert( |
| 173 | tooling::Replacement(SourceMgr, InsertAt, 0, ReplacementText)); |
| 174 | } |
| 175 | |
| 176 | /// \brief Returns all the \c Replacements created during formatting. |
| 177 | const tooling::Replacements &generateReplacements() { |
| 178 | alignComments(); |
| 179 | return Replaces; |
| 180 | } |
| 181 | |
| 182 | private: |
| 183 | std::string getNewLineText(unsigned NewLines, unsigned Spaces) { |
| 184 | return std::string(NewLines, '\n') + std::string(Spaces, ' '); |
| 185 | } |
| 186 | |
| 187 | std::string |
| 188 | getNewLineText(unsigned NewLines, unsigned Spaces, |
| 189 | unsigned WhitespaceStartColumn, const FormatStyle &Style) { |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 190 | std::string NewLineText; |
| 191 | if (NewLines > 0) { |
Daniel Jasper | 1a1ce83 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 192 | unsigned Offset = |
| 193 | std::min<int>(Style.ColumnLimit - 1, WhitespaceStartColumn); |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 194 | for (unsigned i = 0; i < NewLines; ++i) { |
| 195 | NewLineText += std::string(Style.ColumnLimit - Offset - 1, ' '); |
| 196 | NewLineText += "\\\n"; |
| 197 | Offset = 0; |
| 198 | } |
| 199 | } |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 200 | return NewLineText + std::string(Spaces, ' '); |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 201 | } |
| 202 | |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 203 | /// \brief Structure to store a comment for later layout and alignment. |
| 204 | struct StoredComment { |
| 205 | FormatToken Tok; |
| 206 | unsigned MinColumn; |
| 207 | unsigned MaxColumn; |
| 208 | unsigned NewLines; |
| 209 | unsigned Spaces; |
| 210 | }; |
| 211 | SmallVector<StoredComment, 16> Comments; |
| 212 | typedef SmallVector<StoredComment, 16>::iterator comment_iterator; |
| 213 | |
| 214 | /// \brief Try to align all stashed comments. |
| 215 | void alignComments() { |
| 216 | unsigned MinColumn = 0; |
| 217 | unsigned MaxColumn = UINT_MAX; |
| 218 | comment_iterator Start = Comments.begin(); |
| 219 | for (comment_iterator I = Comments.begin(), E = Comments.end(); I != E; |
| 220 | ++I) { |
| 221 | if (I->MinColumn > MaxColumn || I->MaxColumn < MinColumn) { |
| 222 | alignComments(Start, I, MinColumn); |
| 223 | MinColumn = I->MinColumn; |
| 224 | MaxColumn = I->MaxColumn; |
| 225 | Start = I; |
| 226 | } else { |
| 227 | MinColumn = std::max(MinColumn, I->MinColumn); |
| 228 | MaxColumn = std::min(MaxColumn, I->MaxColumn); |
| 229 | } |
| 230 | } |
| 231 | alignComments(Start, Comments.end(), MinColumn); |
| 232 | Comments.clear(); |
| 233 | } |
| 234 | |
| 235 | /// \brief Put all the comments between \p I and \p E into \p Column. |
| 236 | void alignComments(comment_iterator I, comment_iterator E, unsigned Column) { |
| 237 | while (I != E) { |
| 238 | unsigned Spaces = I->Spaces + Column - I->MinColumn; |
| 239 | storeReplacement(I->Tok, std::string(I->NewLines, '\n') + |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 240 | std::string(Spaces, ' ')); |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 241 | ++I; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 242 | } |
| 243 | } |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 244 | |
| 245 | /// \brief Stores \p Text as the replacement for the whitespace in front of |
| 246 | /// \p Tok. |
| 247 | void storeReplacement(const FormatToken &Tok, const std::string Text) { |
Daniel Jasper | afcbd85 | 2013-01-30 09:46:12 +0000 | [diff] [blame] | 248 | // Don't create a replacement, if it does not change anything. |
| 249 | if (StringRef(SourceMgr.getCharacterData(Tok.WhiteSpaceStart), |
| 250 | Tok.WhiteSpaceLength) == Text) |
| 251 | return; |
| 252 | |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 253 | Replaces.insert(tooling::Replacement(SourceMgr, Tok.WhiteSpaceStart, |
| 254 | Tok.WhiteSpaceLength, Text)); |
| 255 | } |
| 256 | |
| 257 | SourceManager &SourceMgr; |
| 258 | tooling::Replacements Replaces; |
| 259 | }; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 260 | |
Daniel Jasper | 7d81281 | 2013-02-21 15:00:29 +0000 | [diff] [blame] | 261 | static bool isVarDeclName(const AnnotatedToken &Tok) { |
| 262 | return Tok.Parent != NULL && Tok.is(tok::identifier) && |
| 263 | (Tok.Parent->Type == TT_PointerOrReference || |
| 264 | Tok.Parent->is(tok::identifier)); |
| 265 | } |
| 266 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 267 | class UnwrappedLineFormatter { |
| 268 | public: |
Manuel Klimek | 94fc6f1 | 2013-01-10 19:17:33 +0000 | [diff] [blame] | 269 | UnwrappedLineFormatter(const FormatStyle &Style, SourceManager &SourceMgr, |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 270 | const AnnotatedLine &Line, unsigned FirstIndent, |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 271 | const AnnotatedToken &RootToken, |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 272 | WhitespaceManager &Whitespaces, bool StructuralError) |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 273 | : Style(Style), SourceMgr(SourceMgr), Line(Line), |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 274 | FirstIndent(FirstIndent), RootToken(RootToken), |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 275 | Whitespaces(Whitespaces), Count(0) {} |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 276 | |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 277 | /// \brief Formats an \c UnwrappedLine. |
| 278 | /// |
| 279 | /// \returns The column after the last token in the last line of the |
| 280 | /// \c UnwrappedLine. |
| 281 | unsigned format() { |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 282 | // Initialize state dependent on indent. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 283 | LineState State; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 284 | State.Column = FirstIndent; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 285 | State.NextToken = &RootToken; |
Daniel Jasper | c4615b7 | 2013-02-20 12:56:39 +0000 | [diff] [blame] | 286 | State.Stack.push_back(ParenState(FirstIndent + 4, FirstIndent, |
| 287 | !Style.BinPackParameters, |
| 288 | /*HasMultiParameterLine=*/ false)); |
Daniel Jasper | 2e60377 | 2013-01-29 11:21:01 +0000 | [diff] [blame] | 289 | State.VariablePos = 0; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 290 | State.LineContainsContinuedForLoopSection = false; |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 291 | State.ParenLevel = 0; |
Manuel Klimek | b56b6d1 | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 292 | State.StartOfStringLiteral = 0; |
Daniel Jasper | cf5767d | 2013-02-18 11:05:07 +0000 | [diff] [blame] | 293 | State.StartOfLineLevel = State.ParenLevel; |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 294 | |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 295 | DEBUG({ |
| 296 | DebugTokenState(*State.NextToken); |
| 297 | }); |
| 298 | |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 299 | // The first token has already been indented and thus consumed. |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 300 | moveStateToNextToken(State, /*DryRun=*/ false); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 301 | |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 302 | // If everything fits on a single line, just put it there. |
| 303 | if (Line.Last->TotalLength <= getColumnLimit() - FirstIndent) { |
| 304 | while (State.NextToken != NULL) { |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 305 | addTokenToState(false, false, State); |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 306 | } |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 307 | return State.Column; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 308 | } |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 309 | |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 310 | // If the ObjC method declaration does not fit on a line, we should format |
| 311 | // it with one arg per line. |
| 312 | if (Line.Type == LT_ObjCMethodDecl) |
| 313 | State.Stack.back().BreakBeforeParameter = true; |
| 314 | |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 315 | // Find best solution in solution space. |
| 316 | return analyzeSolutionSpace(State); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 317 | } |
| 318 | |
| 319 | private: |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 320 | void DebugTokenState(const AnnotatedToken &AnnotatedTok) { |
| 321 | const Token &Tok = AnnotatedTok.FormatTok.Tok; |
Daniel Jasper | 1a1ce83 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 322 | llvm::errs() << StringRef(SourceMgr.getCharacterData(Tok.getLocation()), |
| 323 | Tok.getLength()); |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 324 | llvm::errs(); |
| 325 | } |
| 326 | |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 327 | struct ParenState { |
Daniel Jasper | d399bff | 2013-02-05 09:41:21 +0000 | [diff] [blame] | 328 | ParenState(unsigned Indent, unsigned LastSpace, bool AvoidBinPacking, |
| 329 | bool HasMultiParameterLine) |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 330 | : Indent(Indent), LastSpace(LastSpace), FirstLessLess(0), |
| 331 | BreakBeforeClosingBrace(false), QuestionColumn(0), |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 332 | AvoidBinPacking(AvoidBinPacking), BreakBeforeParameter(false), |
Daniel Jasper | 7878a7b | 2013-02-15 11:07:25 +0000 | [diff] [blame] | 333 | HasMultiParameterLine(HasMultiParameterLine), ColonPos(0), |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 334 | BreakBeforeThirdOperand(false) {} |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 335 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 336 | /// \brief The position to which a specific parenthesis level needs to be |
| 337 | /// indented. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 338 | unsigned Indent; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 339 | |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 340 | /// \brief The position of the last space on each level. |
| 341 | /// |
| 342 | /// Used e.g. to break like: |
| 343 | /// functionCall(Parameter, otherCall( |
| 344 | /// OtherParameter)); |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 345 | unsigned LastSpace; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 346 | |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 347 | /// \brief The position the first "<<" operator encountered on each level. |
| 348 | /// |
| 349 | /// Used to align "<<" operators. 0 if no such operator has been encountered |
| 350 | /// on a level. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 351 | unsigned FirstLessLess; |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 352 | |
Manuel Klimek | c8c8a47 | 2013-01-10 15:58:26 +0000 | [diff] [blame] | 353 | /// \brief Whether a newline needs to be inserted before the block's closing |
| 354 | /// brace. |
| 355 | /// |
| 356 | /// We only want to insert a newline before the closing brace if there also |
| 357 | /// was a newline after the beginning left brace. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 358 | bool BreakBeforeClosingBrace; |
| 359 | |
Daniel Jasper | bfe6fd4 | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 360 | /// \brief The column of a \c ? in a conditional expression; |
| 361 | unsigned QuestionColumn; |
| 362 | |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 363 | /// \brief Avoid bin packing, i.e. multiple parameters/elements on multiple |
| 364 | /// lines, in this context. |
| 365 | bool AvoidBinPacking; |
| 366 | |
| 367 | /// \brief Break after the next comma (or all the commas in this context if |
| 368 | /// \c AvoidBinPacking is \c true). |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 369 | bool BreakBeforeParameter; |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 370 | |
| 371 | /// \brief This context already has a line with more than one parameter. |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 372 | bool HasMultiParameterLine; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 373 | |
Daniel Jasper | 63d7ced | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 374 | /// \brief The position of the colon in an ObjC method declaration/call. |
| 375 | unsigned ColonPos; |
Daniel Jasper | c4615b7 | 2013-02-20 12:56:39 +0000 | [diff] [blame] | 376 | |
Daniel Jasper | 7878a7b | 2013-02-15 11:07:25 +0000 | [diff] [blame] | 377 | /// \brief Break before third operand in ternary expression. |
| 378 | bool BreakBeforeThirdOperand; |
Daniel Jasper | 63d7ced | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 379 | |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 380 | bool operator<(const ParenState &Other) const { |
| 381 | if (Indent != Other.Indent) |
Daniel Jasper | 7d19bc2 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 382 | return Indent < Other.Indent; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 383 | if (LastSpace != Other.LastSpace) |
| 384 | return LastSpace < Other.LastSpace; |
| 385 | if (FirstLessLess != Other.FirstLessLess) |
| 386 | return FirstLessLess < Other.FirstLessLess; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 387 | if (BreakBeforeClosingBrace != Other.BreakBeforeClosingBrace) |
| 388 | return BreakBeforeClosingBrace; |
Daniel Jasper | bfe6fd4 | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 389 | if (QuestionColumn != Other.QuestionColumn) |
| 390 | return QuestionColumn < Other.QuestionColumn; |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 391 | if (AvoidBinPacking != Other.AvoidBinPacking) |
| 392 | return AvoidBinPacking; |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 393 | if (BreakBeforeParameter != Other.BreakBeforeParameter) |
| 394 | return BreakBeforeParameter; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 395 | if (HasMultiParameterLine != Other.HasMultiParameterLine) |
| 396 | return HasMultiParameterLine; |
Daniel Jasper | 63d7ced | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 397 | if (ColonPos != Other.ColonPos) |
| 398 | return ColonPos < Other.ColonPos; |
Daniel Jasper | 7878a7b | 2013-02-15 11:07:25 +0000 | [diff] [blame] | 399 | if (BreakBeforeThirdOperand != Other.BreakBeforeThirdOperand) |
| 400 | return BreakBeforeThirdOperand; |
Daniel Jasper | b312314 | 2013-01-12 07:36:22 +0000 | [diff] [blame] | 401 | return false; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 402 | } |
| 403 | }; |
| 404 | |
| 405 | /// \brief The current state when indenting a unwrapped line. |
| 406 | /// |
| 407 | /// As the indenting tries different combinations this is copied by value. |
| 408 | struct LineState { |
| 409 | /// \brief The number of used columns in the current line. |
| 410 | unsigned Column; |
| 411 | |
| 412 | /// \brief The token that needs to be next formatted. |
| 413 | const AnnotatedToken *NextToken; |
| 414 | |
Daniel Jasper | 1a1ce83 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 415 | /// \brief The column of the first variable name in a variable declaration. |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 416 | /// |
Daniel Jasper | 1a1ce83 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 417 | /// Used to align further variables if necessary. |
Daniel Jasper | 2e60377 | 2013-01-29 11:21:01 +0000 | [diff] [blame] | 418 | unsigned VariablePos; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 419 | |
| 420 | /// \brief \c true if this line contains a continued for-loop section. |
| 421 | bool LineContainsContinuedForLoopSection; |
| 422 | |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 423 | /// \brief The level of nesting inside (), [], <> and {}. |
| 424 | unsigned ParenLevel; |
| 425 | |
Daniel Jasper | cf5767d | 2013-02-18 11:05:07 +0000 | [diff] [blame] | 426 | /// \brief The \c ParenLevel at the start of this line. |
| 427 | unsigned StartOfLineLevel; |
| 428 | |
Manuel Klimek | b56b6d1 | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 429 | /// \brief The start column of the string literal, if we're in a string |
| 430 | /// literal sequence, 0 otherwise. |
| 431 | unsigned StartOfStringLiteral; |
| 432 | |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 433 | /// \brief A stack keeping track of properties applying to parenthesis |
| 434 | /// levels. |
| 435 | std::vector<ParenState> Stack; |
| 436 | |
| 437 | /// \brief Comparison operator to be able to used \c LineState in \c map. |
| 438 | bool operator<(const LineState &Other) const { |
Daniel Jasper | d789670 | 2013-02-19 09:28:55 +0000 | [diff] [blame] | 439 | if (NextToken != Other.NextToken) |
| 440 | return NextToken < Other.NextToken; |
| 441 | if (Column != Other.Column) |
| 442 | return Column < Other.Column; |
| 443 | if (VariablePos != Other.VariablePos) |
| 444 | return VariablePos < Other.VariablePos; |
| 445 | if (LineContainsContinuedForLoopSection != |
| 446 | Other.LineContainsContinuedForLoopSection) |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 447 | return LineContainsContinuedForLoopSection; |
Daniel Jasper | d789670 | 2013-02-19 09:28:55 +0000 | [diff] [blame] | 448 | if (ParenLevel != Other.ParenLevel) |
| 449 | return ParenLevel < Other.ParenLevel; |
| 450 | if (StartOfLineLevel != Other.StartOfLineLevel) |
| 451 | return StartOfLineLevel < Other.StartOfLineLevel; |
Manuel Klimek | b56b6d1 | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 452 | if (StartOfStringLiteral != Other.StartOfStringLiteral) |
| 453 | return StartOfStringLiteral < Other.StartOfStringLiteral; |
Daniel Jasper | d789670 | 2013-02-19 09:28:55 +0000 | [diff] [blame] | 454 | return Stack < Other.Stack; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 455 | } |
| 456 | }; |
| 457 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 458 | /// \brief Appends the next token to \p State and updates information |
| 459 | /// necessary for indentation. |
| 460 | /// |
| 461 | /// Puts the token on the current line if \p Newline is \c true and adds a |
| 462 | /// line break and necessary indentation otherwise. |
| 463 | /// |
| 464 | /// If \p DryRun is \c false, also creates and stores the required |
| 465 | /// \c Replacement. |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 466 | unsigned addTokenToState(bool Newline, bool DryRun, LineState &State) { |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 467 | const AnnotatedToken &Current = *State.NextToken; |
| 468 | const AnnotatedToken &Previous = *State.NextToken->Parent; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 469 | assert(State.Stack.size()); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 470 | |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 471 | if (Current.Type == TT_ImplicitStringLiteral) { |
| 472 | State.Column += State.NextToken->FormatTok.WhiteSpaceLength + |
| 473 | State.NextToken->FormatTok.TokenLength; |
| 474 | if (State.NextToken->Children.empty()) |
| 475 | State.NextToken = NULL; |
| 476 | else |
| 477 | State.NextToken = &State.NextToken->Children[0]; |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 478 | return 0; |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 479 | } |
| 480 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 481 | if (Newline) { |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 482 | unsigned WhitespaceStartColumn = State.Column; |
Manuel Klimek | bb42bf1 | 2013-01-10 11:52:21 +0000 | [diff] [blame] | 483 | if (Current.is(tok::r_brace)) { |
| 484 | State.Column = Line.Level * 2; |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 485 | } else if (Current.is(tok::string_literal) && |
Manuel Klimek | b56b6d1 | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 486 | State.StartOfStringLiteral != 0) { |
| 487 | State.Column = State.StartOfStringLiteral; |
Daniel Jasper | 66d19bd | 2013-02-18 11:59:17 +0000 | [diff] [blame] | 488 | State.Stack.back().BreakBeforeParameter = true; |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 489 | } else if (Current.is(tok::lessless) && |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 490 | State.Stack.back().FirstLessLess != 0) { |
| 491 | State.Column = State.Stack.back().FirstLessLess; |
| 492 | } else if (State.ParenLevel != 0 && |
Daniel Jasper | 5f2173e | 2013-01-28 07:43:15 +0000 | [diff] [blame] | 493 | (Previous.is(tok::equal) || Previous.is(tok::coloncolon) || |
Daniel Jasper | bfe6fd4 | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 494 | Current.is(tok::period) || Current.is(tok::arrow) || |
| 495 | Current.is(tok::question))) { |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 496 | // Indent and extra 4 spaces after if we know the current expression is |
| 497 | // continued. Don't do that on the top level, as we already indent 4 |
| 498 | // there. |
Daniel Jasper | bfe6fd4 | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 499 | State.Column = std::max(State.Stack.back().LastSpace, |
| 500 | State.Stack.back().Indent) + 4; |
| 501 | } else if (Current.Type == TT_ConditionalExpr) { |
| 502 | State.Column = State.Stack.back().QuestionColumn; |
Daniel Jasper | 2e60377 | 2013-01-29 11:21:01 +0000 | [diff] [blame] | 503 | } else if (Previous.is(tok::comma) && State.VariablePos != 0 && |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 504 | ((RootToken.is(tok::kw_for) && State.ParenLevel == 1) || |
| 505 | State.ParenLevel == 0)) { |
Daniel Jasper | 2e60377 | 2013-01-29 11:21:01 +0000 | [diff] [blame] | 506 | State.Column = State.VariablePos; |
Daniel Jasper | 83f25ba | 2013-01-28 15:16:31 +0000 | [diff] [blame] | 507 | } else if (State.NextToken->Parent->ClosesTemplateDeclaration || |
| 508 | Current.Type == TT_StartOfName) { |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 509 | State.Column = State.Stack.back().Indent - 4; |
Daniel Jasper | 63d7ced | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 510 | } else if (Current.Type == TT_ObjCSelectorName) { |
| 511 | if (State.Stack.back().ColonPos > Current.FormatTok.TokenLength) { |
| 512 | State.Column = |
| 513 | State.Stack.back().ColonPos - Current.FormatTok.TokenLength; |
| 514 | } else { |
| 515 | State.Column = State.Stack.back().Indent; |
| 516 | State.Stack.back().ColonPos = |
| 517 | State.Column + Current.FormatTok.TokenLength; |
| 518 | } |
Daniel Jasper | 7d81281 | 2013-02-21 15:00:29 +0000 | [diff] [blame] | 519 | } else if (Previous.Type == TT_ObjCMethodExpr || isVarDeclName(Current)) { |
Daniel Jasper | 63d7ced | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 520 | State.Column = State.Stack.back().Indent + 4; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 521 | } else { |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 522 | State.Column = State.Stack.back().Indent; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 523 | } |
| 524 | |
Daniel Jasper | 7878a7b | 2013-02-15 11:07:25 +0000 | [diff] [blame] | 525 | if (Current.is(tok::question)) |
| 526 | State.Stack.back().BreakBeforeThirdOperand = true; |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 527 | if (Previous.is(tok::comma) && !State.Stack.back().AvoidBinPacking) |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 528 | State.Stack.back().BreakBeforeParameter = false; |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 529 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 530 | if (RootToken.is(tok::kw_for)) |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 531 | State.LineContainsContinuedForLoopSection = Previous.isNot(tok::semi); |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 532 | |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 533 | if (!DryRun) { |
Daniel Jasper | c4615b7 | 2013-02-20 12:56:39 +0000 | [diff] [blame] | 534 | unsigned NewLines = |
| 535 | std::max(1u, std::min(Current.FormatTok.NewlinesBefore, |
| 536 | Style.MaxEmptyLinesToKeep + 1)); |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 537 | if (!Line.InPPDirective) |
Daniel Jasper | c4615b7 | 2013-02-20 12:56:39 +0000 | [diff] [blame] | 538 | Whitespaces.replaceWhitespace(Current, NewLines, State.Column, |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 539 | WhitespaceStartColumn, Style); |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 540 | else |
Daniel Jasper | c4615b7 | 2013-02-20 12:56:39 +0000 | [diff] [blame] | 541 | Whitespaces.replacePPWhitespace(Current, NewLines, State.Column, |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 542 | WhitespaceStartColumn, Style); |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 543 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 544 | |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 545 | State.Stack.back().LastSpace = State.Column; |
Daniel Jasper | cf5767d | 2013-02-18 11:05:07 +0000 | [diff] [blame] | 546 | State.StartOfLineLevel = State.ParenLevel; |
Daniel Jasper | bfe6fd4 | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 547 | if (Current.is(tok::colon) && Current.Type != TT_ConditionalExpr) |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 548 | State.Stack.back().Indent += 2; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 549 | } else { |
Daniel Jasper | 2e60377 | 2013-01-29 11:21:01 +0000 | [diff] [blame] | 550 | if (Current.is(tok::equal) && |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 551 | (RootToken.is(tok::kw_for) || State.ParenLevel == 0)) |
Daniel Jasper | 2e60377 | 2013-01-29 11:21:01 +0000 | [diff] [blame] | 552 | State.VariablePos = State.Column - Previous.FormatTok.TokenLength; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 553 | |
Daniel Jasper | 729a743 | 2013-02-11 12:36:37 +0000 | [diff] [blame] | 554 | unsigned Spaces = State.NextToken->SpacesRequiredBefore; |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 555 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 556 | if (!DryRun) |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 557 | Whitespaces.replaceWhitespace(Current, 0, Spaces, State.Column, Style); |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 558 | |
Daniel Jasper | 63d7ced | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 559 | if (Current.Type == TT_ObjCSelectorName && |
| 560 | State.Stack.back().ColonPos == 0) { |
| 561 | if (State.Stack.back().Indent + Current.LongestObjCSelectorName > |
| 562 | State.Column + Spaces + Current.FormatTok.TokenLength) |
| 563 | State.Stack.back().ColonPos = |
| 564 | State.Stack.back().Indent + Current.LongestObjCSelectorName; |
| 565 | else |
| 566 | State.Stack.back().ColonPos = |
Daniel Jasper | 9e9e6e0 | 2013-02-06 16:00:26 +0000 | [diff] [blame] | 567 | State.Column + Spaces + Current.FormatTok.TokenLength; |
Daniel Jasper | 63d7ced | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 568 | } |
| 569 | |
Daniel Jasper | d4f2c2e | 2013-01-29 19:41:55 +0000 | [diff] [blame] | 570 | if (Current.Type != TT_LineComment && |
| 571 | (Previous.is(tok::l_paren) || Previous.is(tok::l_brace) || |
| 572 | State.NextToken->Parent->Type == TT_TemplateOpener)) |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 573 | State.Stack.back().Indent = State.Column + Spaces; |
Daniel Jasper | cda1650 | 2013-02-04 08:34:57 +0000 | [diff] [blame] | 574 | if (Previous.is(tok::comma) && !isTrailingComment(Current)) |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 575 | State.Stack.back().HasMultiParameterLine = true; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 576 | |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 577 | State.Column += Spaces; |
Daniel Jasper | e438bac | 2013-01-23 20:41:06 +0000 | [diff] [blame] | 578 | if (Current.is(tok::l_paren) && Previous.is(tok::kw_if)) |
| 579 | // Treat the condition inside an if as if it was a second function |
| 580 | // parameter, i.e. let nested calls have an indent of 4. |
| 581 | State.Stack.back().LastSpace = State.Column + 1; // 1 is length of "(". |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 582 | else if (Previous.is(tok::comma) && State.ParenLevel != 0) |
Daniel Jasper | e438bac | 2013-01-23 20:41:06 +0000 | [diff] [blame] | 583 | // Top-level spaces are exempt as that mostly leads to better results. |
| 584 | State.Stack.back().LastSpace = State.Column; |
Daniel Jasper | bfe6fd4 | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 585 | else if ((Previous.Type == TT_BinaryOperator || |
Daniel Jasper | 02b771e | 2013-01-28 13:31:35 +0000 | [diff] [blame] | 586 | Previous.Type == TT_ConditionalExpr || |
| 587 | Previous.Type == TT_CtorInitializerColon) && |
Daniel Jasper | ae8699b | 2013-01-28 09:35:24 +0000 | [diff] [blame] | 588 | getPrecedence(Previous) != prec::Assignment) |
| 589 | State.Stack.back().LastSpace = State.Column; |
Daniel Jasper | 6cabab4 | 2013-02-14 08:42:54 +0000 | [diff] [blame] | 590 | else if (Previous.Type == TT_InheritanceColon) |
| 591 | State.Stack.back().Indent = State.Column; |
Daniel Jasper | 986e17f | 2013-01-28 07:35:34 +0000 | [diff] [blame] | 592 | else if (Previous.ParameterCount > 1 && |
| 593 | (Previous.is(tok::l_paren) || Previous.is(tok::l_square) || |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 594 | Previous.is(tok::l_brace) || |
Daniel Jasper | 986e17f | 2013-01-28 07:35:34 +0000 | [diff] [blame] | 595 | Previous.Type == TT_TemplateOpener)) |
| 596 | // If this function has multiple parameters, indent nested calls from |
| 597 | // the start of the first parameter. |
| 598 | State.Stack.back().LastSpace = State.Column; |
Daniel Jasper | 82282dc | 2013-02-18 13:52:06 +0000 | [diff] [blame] | 599 | else if ((Current.is(tok::period) || Current.is(tok::arrow)) && |
| 600 | Line.Type == LT_BuilderTypeCall && State.ParenLevel == 0) |
| 601 | State.Stack.back().LastSpace = State.Column; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 602 | } |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 603 | |
| 604 | // If we break after an {, we should also break before the corresponding }. |
| 605 | if (Newline && Previous.is(tok::l_brace)) |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 606 | State.Stack.back().BreakBeforeClosingBrace = true; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 607 | |
Daniel Jasper | 8159d2f | 2013-02-04 07:30:30 +0000 | [diff] [blame] | 608 | if (State.Stack.back().AvoidBinPacking && Newline && |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 609 | (Line.First.isNot(tok::kw_for) || State.ParenLevel != 1)) { |
Daniel Jasper | 8f4bd7a | 2013-01-23 10:08:28 +0000 | [diff] [blame] | 610 | // If we are breaking after '(', '{', '<', this is not bin packing unless |
Daniel Jasper | f157960 | 2013-01-29 16:03:49 +0000 | [diff] [blame] | 611 | // AllowAllParametersOfDeclarationOnNextLine is false. |
Daniel Jasper | 8f4bd7a | 2013-01-23 10:08:28 +0000 | [diff] [blame] | 612 | if ((Previous.isNot(tok::l_paren) && Previous.isNot(tok::l_brace) && |
| 613 | Previous.Type != TT_TemplateOpener) || |
Daniel Jasper | f157960 | 2013-01-29 16:03:49 +0000 | [diff] [blame] | 614 | (!Style.AllowAllParametersOfDeclarationOnNextLine && |
| 615 | Line.MustBeDeclaration)) |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 616 | State.Stack.back().BreakBeforeParameter = true; |
Daniel Jasper | 7d81281 | 2013-02-21 15:00:29 +0000 | [diff] [blame] | 617 | } |
Daniel Jasper | 2e60377 | 2013-01-29 11:21:01 +0000 | [diff] [blame] | 618 | |
Daniel Jasper | 7d81281 | 2013-02-21 15:00:29 +0000 | [diff] [blame] | 619 | if (Newline) { |
Daniel Jasper | 8f4bd7a | 2013-01-23 10:08:28 +0000 | [diff] [blame] | 620 | // Any break on this level means that the parent level has been broken |
| 621 | // and we need to avoid bin packing there. |
| 622 | for (unsigned i = 0, e = State.Stack.size() - 1; i != e; ++i) { |
Daniel Jasper | 8159d2f | 2013-02-04 07:30:30 +0000 | [diff] [blame] | 623 | if (Line.First.isNot(tok::kw_for) || i != 1) |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 624 | State.Stack[i].BreakBeforeParameter = true; |
Daniel Jasper | 8f4bd7a | 2013-01-23 10:08:28 +0000 | [diff] [blame] | 625 | } |
| 626 | } |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 627 | |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 628 | return moveStateToNextToken(State, DryRun); |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 629 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 630 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 631 | /// \brief Mark the next token as consumed in \p State and modify its stacks |
| 632 | /// accordingly. |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 633 | unsigned moveStateToNextToken(LineState &State, bool DryRun) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 634 | const AnnotatedToken &Current = *State.NextToken; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 635 | assert(State.Stack.size()); |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 636 | |
Daniel Jasper | 6cabab4 | 2013-02-14 08:42:54 +0000 | [diff] [blame] | 637 | if (Current.Type == TT_InheritanceColon) |
| 638 | State.Stack.back().AvoidBinPacking = true; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 639 | if (Current.is(tok::lessless) && State.Stack.back().FirstLessLess == 0) |
| 640 | State.Stack.back().FirstLessLess = State.Column; |
Daniel Jasper | bfe6fd4 | 2013-01-28 12:45:14 +0000 | [diff] [blame] | 641 | if (Current.is(tok::question)) |
| 642 | State.Stack.back().QuestionColumn = State.Column; |
Daniel Jasper | 7d81281 | 2013-02-21 15:00:29 +0000 | [diff] [blame] | 643 | if (Current.Type == TT_CtorInitializerColon) { |
| 644 | if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine) |
| 645 | State.Stack.back().AvoidBinPacking = true; |
| 646 | State.Stack.back().BreakBeforeParameter = false; |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 647 | } |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 648 | |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 649 | // Insert scopes created by fake parenthesis. |
| 650 | for (unsigned i = 0, e = Current.FakeLParens; i != e; ++i) { |
| 651 | ParenState NewParenState = State.Stack.back(); |
| 652 | NewParenState.Indent = std::max(State.Column, State.Stack.back().Indent); |
| 653 | State.Stack.push_back(NewParenState); |
| 654 | } |
| 655 | |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 656 | // If we encounter an opening (, [, { or <, we add a level to our stacks to |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 657 | // prepare for the following tokens. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 658 | if (Current.is(tok::l_paren) || Current.is(tok::l_square) || |
| 659 | Current.is(tok::l_brace) || |
| 660 | State.NextToken->Type == TT_TemplateOpener) { |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 661 | unsigned NewIndent; |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 662 | bool AvoidBinPacking; |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 663 | if (Current.is(tok::l_brace)) { |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 664 | NewIndent = 2 + State.Stack.back().LastSpace; |
| 665 | AvoidBinPacking = false; |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 666 | } else { |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 667 | NewIndent = 4 + State.Stack.back().LastSpace; |
Daniel Jasper | f343cab | 2013-01-31 14:59:26 +0000 | [diff] [blame] | 668 | AvoidBinPacking = !Style.BinPackParameters; |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 669 | } |
Daniel Jasper | d399bff | 2013-02-05 09:41:21 +0000 | [diff] [blame] | 670 | State.Stack.push_back( |
| 671 | ParenState(NewIndent, State.Stack.back().LastSpace, AvoidBinPacking, |
| 672 | State.Stack.back().HasMultiParameterLine)); |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 673 | ++State.ParenLevel; |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 674 | } |
| 675 | |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 676 | // If this '[' opens an ObjC call, determine whether all parameters fit into |
| 677 | // one line and put one per line if they don't. |
| 678 | if (Current.is(tok::l_square) && Current.Type == TT_ObjCMethodExpr && |
| 679 | Current.MatchingParen != NULL) { |
| 680 | if (getLengthToMatchingParen(Current) + State.Column > getColumnLimit()) |
| 681 | State.Stack.back().BreakBeforeParameter = true; |
| 682 | } |
| 683 | |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 684 | // If we encounter a closing ), ], } or >, we can remove a level from our |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 685 | // stacks. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 686 | if (Current.is(tok::r_paren) || Current.is(tok::r_square) || |
| 687 | (Current.is(tok::r_brace) && State.NextToken != &RootToken) || |
| 688 | State.NextToken->Type == TT_TemplateCloser) { |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 689 | State.Stack.pop_back(); |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 690 | --State.ParenLevel; |
| 691 | } |
| 692 | |
| 693 | // Remove scopes created by fake parenthesis. |
| 694 | for (unsigned i = 0, e = Current.FakeRParens; i != e; ++i) { |
| 695 | State.Stack.pop_back(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 696 | } |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 697 | |
Manuel Klimek | e9a6226 | 2013-02-20 15:32:58 +0000 | [diff] [blame] | 698 | if (Current.is(tok::string_literal)) { |
Manuel Klimek | b56b6d1 | 2013-02-20 15:25:48 +0000 | [diff] [blame] | 699 | State.StartOfStringLiteral = State.Column; |
| 700 | } else if (Current.isNot(tok::comment)) { |
| 701 | State.StartOfStringLiteral = 0; |
| 702 | } |
| 703 | |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 704 | State.Column += Current.FormatTok.TokenLength; |
| 705 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 706 | if (State.NextToken->Children.empty()) |
| 707 | State.NextToken = NULL; |
| 708 | else |
| 709 | State.NextToken = &State.NextToken->Children[0]; |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 710 | |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 711 | return breakProtrudingToken(Current, State, DryRun); |
| 712 | } |
| 713 | |
| 714 | /// \brief If the current token sticks out over the end of the line, break |
| 715 | /// it if possible. |
| 716 | unsigned breakProtrudingToken(const AnnotatedToken &Current, LineState &State, |
| 717 | bool DryRun) { |
| 718 | if (Current.isNot(tok::string_literal)) |
| 719 | return 0; |
| 720 | |
| 721 | unsigned Penalty = 0; |
| 722 | unsigned TailOffset = 0; |
| 723 | unsigned TailLength = Current.FormatTok.TokenLength; |
| 724 | unsigned StartColumn = State.Column - Current.FormatTok.TokenLength; |
| 725 | unsigned OffsetFromStart = 0; |
| 726 | while (StartColumn + TailLength > getColumnLimit()) { |
| 727 | StringRef Text = StringRef(Current.FormatTok.Tok.getLiteralData() + |
| 728 | TailOffset, TailLength); |
| 729 | StringRef::size_type SplitPoint = |
| 730 | getSplitPoint(Text, getColumnLimit() - StartColumn - 1); |
| 731 | if (SplitPoint == StringRef::npos) |
| 732 | break; |
| 733 | assert(SplitPoint != 0); |
| 734 | // +2, because 'Text' starts after the opening quotes, and does not |
| 735 | // include the closing quote we need to insert. |
| 736 | unsigned WhitespaceStartColumn = |
| 737 | StartColumn + OffsetFromStart + SplitPoint + 2; |
| 738 | State.Stack.back().LastSpace = StartColumn; |
| 739 | if (!DryRun) { |
| 740 | Whitespaces.breakToken(Current, TailOffset + SplitPoint + 1, "\"", "\"", |
| 741 | Line.InPPDirective, StartColumn, |
| 742 | WhitespaceStartColumn, Style); |
| 743 | } |
| 744 | TailOffset += SplitPoint + 1; |
| 745 | TailLength -= SplitPoint + 1; |
| 746 | OffsetFromStart = 1; |
| 747 | Penalty += 100; |
| 748 | } |
| 749 | State.Column = StartColumn + TailLength; |
| 750 | return Penalty; |
| 751 | } |
| 752 | |
| 753 | StringRef::size_type |
| 754 | getSplitPoint(StringRef Text, StringRef::size_type Offset) { |
| 755 | // FIXME: Implement more sophisticated splitting mechanism, and a fallback. |
| 756 | return Text.rfind(' ', Offset); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 757 | } |
| 758 | |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 759 | unsigned getColumnLimit() { |
| 760 | return Style.ColumnLimit - (Line.InPPDirective ? 1 : 0); |
| 761 | } |
| 762 | |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 763 | /// \brief An edge in the solution space from \c Previous->State to \c State, |
| 764 | /// inserting a newline dependent on the \c NewLine. |
| 765 | struct StateNode { |
| 766 | StateNode(const LineState &State, bool NewLine, StateNode *Previous) |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 767 | : State(State), NewLine(NewLine), Previous(Previous) {} |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 768 | LineState State; |
| 769 | bool NewLine; |
| 770 | StateNode *Previous; |
| 771 | }; |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 772 | |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 773 | /// \brief A pair of <penalty, count> that is used to prioritize the BFS on. |
| 774 | /// |
| 775 | /// In case of equal penalties, we want to prefer states that were inserted |
| 776 | /// first. During state generation we make sure that we insert states first |
| 777 | /// that break the line as late as possible. |
| 778 | typedef std::pair<unsigned, unsigned> OrderedPenalty; |
| 779 | |
| 780 | /// \brief An item in the prioritized BFS search queue. The \c StateNode's |
| 781 | /// \c State has the given \c OrderedPenalty. |
| 782 | typedef std::pair<OrderedPenalty, StateNode *> QueueItem; |
| 783 | |
| 784 | /// \brief The BFS queue type. |
| 785 | typedef std::priority_queue<QueueItem, std::vector<QueueItem>, |
| 786 | std::greater<QueueItem> > QueueType; |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 787 | |
| 788 | /// \brief Analyze the entire solution space starting from \p InitialState. |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 789 | /// |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 790 | /// This implements a variant of Dijkstra's algorithm on the graph that spans |
| 791 | /// the solution space (\c LineStates are the nodes). The algorithm tries to |
| 792 | /// find the shortest path (the one with lowest penalty) from \p InitialState |
| 793 | /// to a state where all tokens are placed. |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 794 | unsigned analyzeSolutionSpace(LineState &InitialState) { |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 795 | std::set<LineState> Seen; |
| 796 | |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 797 | // Insert start element into queue. |
Daniel Jasper | fc75908 | 2013-02-14 14:26:07 +0000 | [diff] [blame] | 798 | StateNode *Node = |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 799 | new (Allocator.Allocate()) StateNode(InitialState, false, NULL); |
| 800 | Queue.push(QueueItem(OrderedPenalty(0, Count), Node)); |
| 801 | ++Count; |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 802 | |
| 803 | // While not empty, take first element and follow edges. |
| 804 | while (!Queue.empty()) { |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 805 | unsigned Penalty = Queue.top().first.first; |
Daniel Jasper | fc75908 | 2013-02-14 14:26:07 +0000 | [diff] [blame] | 806 | StateNode *Node = Queue.top().second; |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 807 | if (Node->State.NextToken == NULL) { |
Daniel Jasper | 0178673 | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 808 | DEBUG(llvm::errs() << "\n---\nPenalty for line: " << Penalty << "\n"); |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 809 | break; |
Daniel Jasper | 0178673 | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 810 | } |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 811 | Queue.pop(); |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 812 | |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 813 | if (!Seen.insert(Node->State).second) |
| 814 | // State already examined with lower penalty. |
| 815 | continue; |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 816 | |
Manuel Klimek | 62a48fb | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 817 | addNextStateToQueue(Penalty, Node, /*NewLine=*/ false); |
| 818 | addNextStateToQueue(Penalty, Node, /*NewLine=*/ true); |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 819 | } |
| 820 | |
| 821 | if (Queue.empty()) |
| 822 | // We were unable to find a solution, do nothing. |
| 823 | // FIXME: Add diagnostic? |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 824 | return 0; |
| 825 | |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 826 | // Reconstruct the solution. |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 827 | reconstructPath(InitialState, Queue.top().second); |
Daniel Jasper | 0178673 | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 828 | DEBUG(llvm::errs() << "---\n"); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 829 | |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 830 | // Return the column after the last token of the solution. |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 831 | return Queue.top().second->State.Column; |
| 832 | } |
| 833 | |
| 834 | void reconstructPath(LineState &State, StateNode *Current) { |
| 835 | // FIXME: This recursive implementation limits the possible number |
| 836 | // of tokens per line if compiled into a binary with small stack space. |
| 837 | // To become more independent of stack frame limitations we would need |
| 838 | // to also change the TokenAnnotator. |
| 839 | if (Current->Previous == NULL) |
| 840 | return; |
| 841 | reconstructPath(State, Current->Previous); |
| 842 | DEBUG({ |
| 843 | if (Current->NewLine) { |
Daniel Jasper | a03ab10 | 2013-02-13 20:33:44 +0000 | [diff] [blame] | 844 | llvm::errs() |
| 845 | << "Penalty for splitting before " |
| 846 | << Current->Previous->State.NextToken->FormatTok.Tok.getName() |
| 847 | << ": " << Current->Previous->State.NextToken->SplitPenalty << "\n"; |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 848 | } |
| 849 | }); |
| 850 | addTokenToState(Current->NewLine, false, State); |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 851 | } |
| 852 | |
Manuel Klimek | 62a48fb | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 853 | /// \brief Add the following state to the analysis queue \c Queue. |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 854 | /// |
Manuel Klimek | 62a48fb | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 855 | /// Assume the current state is \p PreviousNode and has been reached with a |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 856 | /// penalty of \p Penalty. Insert a line break if \p NewLine is \c true. |
Manuel Klimek | 62a48fb | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 857 | void addNextStateToQueue(unsigned Penalty, StateNode *PreviousNode, |
| 858 | bool NewLine) { |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 859 | if (NewLine && !canBreak(PreviousNode->State)) |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 860 | return; |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 861 | if (!NewLine && mustBreak(PreviousNode->State)) |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 862 | return; |
Daniel Jasper | ae8699b | 2013-01-28 09:35:24 +0000 | [diff] [blame] | 863 | if (NewLine) |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 864 | Penalty += PreviousNode->State.NextToken->SplitPenalty; |
| 865 | |
| 866 | StateNode *Node = new (Allocator.Allocate()) |
| 867 | StateNode(PreviousNode->State, NewLine, PreviousNode); |
Manuel Klimek | 8092a94 | 2013-02-20 10:15:13 +0000 | [diff] [blame] | 868 | Penalty += addTokenToState(NewLine, true, Node->State); |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 869 | if (Node->State.Column > getColumnLimit()) { |
| 870 | unsigned ExcessCharacters = Node->State.Column - getColumnLimit(); |
Daniel Jasper | 0178673 | 2013-02-04 07:21:18 +0000 | [diff] [blame] | 871 | Penalty += Style.PenaltyExcessCharacter * ExcessCharacters; |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 872 | } |
Manuel Klimek | 32a2fd7 | 2013-02-13 10:46:36 +0000 | [diff] [blame] | 873 | |
| 874 | Queue.push(QueueItem(OrderedPenalty(Penalty, Count), Node)); |
| 875 | ++Count; |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 876 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 877 | |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 878 | /// \brief Returns \c true, if a line break after \p State is allowed. |
| 879 | bool canBreak(const LineState &State) { |
| 880 | if (!State.NextToken->CanBreakBefore && |
| 881 | !(State.NextToken->is(tok::r_brace) && |
| 882 | State.Stack.back().BreakBeforeClosingBrace)) |
| 883 | return false; |
Daniel Jasper | cf5767d | 2013-02-18 11:05:07 +0000 | [diff] [blame] | 884 | // This prevents breaks like: |
| 885 | // ... |
| 886 | // SomeParameter, OtherParameter).DoSomething( |
| 887 | // ... |
| 888 | // As they hide "DoSomething" and generally bad for readability. |
| 889 | if (State.NextToken->Parent->is(tok::l_paren) && |
| 890 | State.ParenLevel <= State.StartOfLineLevel) |
| 891 | return false; |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 892 | // Trying to insert a parameter on a new line if there are already more than |
| 893 | // one parameter on the current line is bin packing. |
Daniel Jasper | d399bff | 2013-02-05 09:41:21 +0000 | [diff] [blame] | 894 | if (State.Stack.back().HasMultiParameterLine && |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 895 | State.Stack.back().AvoidBinPacking) |
| 896 | return false; |
| 897 | return true; |
| 898 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 899 | |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 900 | /// \brief Returns \c true, if a line break after \p State is mandatory. |
| 901 | bool mustBreak(const LineState &State) { |
| 902 | if (State.NextToken->MustBreakBefore) |
| 903 | return true; |
| 904 | if (State.NextToken->is(tok::r_brace) && |
| 905 | State.Stack.back().BreakBeforeClosingBrace) |
| 906 | return true; |
| 907 | if (State.NextToken->Parent->is(tok::semi) && |
| 908 | State.LineContainsContinuedForLoopSection) |
| 909 | return true; |
| 910 | if (State.NextToken->Parent->is(tok::comma) && |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 911 | State.Stack.back().BreakBeforeParameter && |
Daniel Jasper | c5cfa49 | 2013-02-14 09:19:04 +0000 | [diff] [blame] | 912 | !isTrailingComment(*State.NextToken) && |
Daniel Jasper | 7d81281 | 2013-02-21 15:00:29 +0000 | [diff] [blame] | 913 | State.NextToken->isNot(tok::r_paren) && |
| 914 | State.NextToken->isNot(tok::r_brace)) |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 915 | return true; |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 916 | // FIXME: Comparing LongestObjCSelectorName to 0 is a hacky way of finding |
| 917 | // out whether it is the first parameter. Clean this up. |
Daniel Jasper | 63d7ced | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 918 | if (State.NextToken->Type == TT_ObjCSelectorName && |
Daniel Jasper | ce3d1a6 | 2013-02-08 08:22:00 +0000 | [diff] [blame] | 919 | State.NextToken->LongestObjCSelectorName == 0 && |
| 920 | State.Stack.back().BreakBeforeParameter) |
Daniel Jasper | 63d7ced | 2013-02-05 10:07:47 +0000 | [diff] [blame] | 921 | return true; |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 922 | if ((State.NextToken->Type == TT_CtorInitializerColon || |
| 923 | (State.NextToken->Parent->ClosesTemplateDeclaration && |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 924 | State.ParenLevel == 0))) |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 925 | return true; |
Daniel Jasper | 7878a7b | 2013-02-15 11:07:25 +0000 | [diff] [blame] | 926 | if (State.NextToken->is(tok::colon) && |
| 927 | State.Stack.back().BreakBeforeThirdOperand) |
| 928 | return true; |
Daniel Jasper | 68ef0df | 2013-02-01 11:00:45 +0000 | [diff] [blame] | 929 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 930 | } |
| 931 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 932 | FormatStyle Style; |
| 933 | SourceManager &SourceMgr; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 934 | const AnnotatedLine &Line; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 935 | const unsigned FirstIndent; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 936 | const AnnotatedToken &RootToken; |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 937 | WhitespaceManager &Whitespaces; |
Manuel Klimek | 62a48fb | 2013-02-13 10:54:19 +0000 | [diff] [blame] | 938 | |
| 939 | llvm::SpecificBumpPtrAllocator<StateNode> Allocator; |
| 940 | QueueType Queue; |
| 941 | // Increasing count of \c StateNode items we have created. This is used |
| 942 | // to create a deterministic order independent of the container. |
| 943 | unsigned Count; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 944 | }; |
| 945 | |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 946 | class LexerBasedFormatTokenSource : public FormatTokenSource { |
| 947 | public: |
| 948 | LexerBasedFormatTokenSource(Lexer &Lex, SourceManager &SourceMgr) |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 949 | : GreaterStashed(false), Lex(Lex), SourceMgr(SourceMgr), |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 950 | IdentTable(Lex.getLangOpts()) { |
| 951 | Lex.SetKeepWhitespaceMode(true); |
| 952 | } |
| 953 | |
| 954 | virtual FormatToken getNextToken() { |
| 955 | if (GreaterStashed) { |
| 956 | FormatTok.NewlinesBefore = 0; |
| 957 | FormatTok.WhiteSpaceStart = |
| 958 | FormatTok.Tok.getLocation().getLocWithOffset(1); |
| 959 | FormatTok.WhiteSpaceLength = 0; |
| 960 | GreaterStashed = false; |
| 961 | return FormatTok; |
| 962 | } |
| 963 | |
| 964 | FormatTok = FormatToken(); |
| 965 | Lex.LexFromRawLexer(FormatTok.Tok); |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 966 | StringRef Text = rawTokenText(FormatTok.Tok); |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 967 | FormatTok.WhiteSpaceStart = FormatTok.Tok.getLocation(); |
Manuel Klimek | f6fd00b | 2013-01-05 22:56:06 +0000 | [diff] [blame] | 968 | if (SourceMgr.getFileOffset(FormatTok.WhiteSpaceStart) == 0) |
| 969 | FormatTok.IsFirst = true; |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 970 | |
| 971 | // Consume and record whitespace until we find a significant token. |
| 972 | while (FormatTok.Tok.is(tok::unknown)) { |
Manuel Klimek | a28fc06 | 2013-02-11 12:33:24 +0000 | [diff] [blame] | 973 | unsigned Newlines = Text.count('\n'); |
| 974 | unsigned EscapedNewlines = Text.count("\\\n"); |
| 975 | FormatTok.NewlinesBefore += Newlines; |
| 976 | FormatTok.HasUnescapedNewline |= EscapedNewlines != Newlines; |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 977 | FormatTok.WhiteSpaceLength += FormatTok.Tok.getLength(); |
| 978 | |
| 979 | if (FormatTok.Tok.is(tok::eof)) |
| 980 | return FormatTok; |
| 981 | Lex.LexFromRawLexer(FormatTok.Tok); |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 982 | Text = rawTokenText(FormatTok.Tok); |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 983 | } |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 984 | |
| 985 | // Now FormatTok is the next non-whitespace token. |
| 986 | FormatTok.TokenLength = Text.size(); |
| 987 | |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 988 | // In case the token starts with escaped newlines, we want to |
| 989 | // take them into account as whitespace - this pattern is quite frequent |
| 990 | // in macro definitions. |
| 991 | // FIXME: What do we want to do with other escaped spaces, and escaped |
| 992 | // spaces or newlines in the middle of tokens? |
| 993 | // FIXME: Add a more explicit test. |
| 994 | unsigned i = 0; |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 995 | while (i + 1 < Text.size() && Text[i] == '\\' && Text[i + 1] == '\n') { |
Manuel Klimek | 86721d2 | 2013-01-22 16:31:55 +0000 | [diff] [blame] | 996 | // FIXME: ++FormatTok.NewlinesBefore is missing... |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 997 | FormatTok.WhiteSpaceLength += 2; |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 998 | FormatTok.TokenLength -= 2; |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 999 | i += 2; |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1000 | } |
| 1001 | |
| 1002 | if (FormatTok.Tok.is(tok::raw_identifier)) { |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1003 | IdentifierInfo &Info = IdentTable.get(Text); |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1004 | FormatTok.Tok.setIdentifierInfo(&Info); |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1005 | FormatTok.Tok.setKind(Info.getTokenID()); |
| 1006 | } |
| 1007 | |
| 1008 | if (FormatTok.Tok.is(tok::greatergreater)) { |
| 1009 | FormatTok.Tok.setKind(tok::greater); |
| 1010 | GreaterStashed = true; |
| 1011 | } |
| 1012 | |
| 1013 | return FormatTok; |
| 1014 | } |
| 1015 | |
Nico Weber | c2e6d2a | 2013-02-11 15:32:15 +0000 | [diff] [blame] | 1016 | IdentifierTable &getIdentTable() { return IdentTable; } |
| 1017 | |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1018 | private: |
| 1019 | FormatToken FormatTok; |
| 1020 | bool GreaterStashed; |
| 1021 | Lexer &Lex; |
| 1022 | SourceManager &SourceMgr; |
| 1023 | IdentifierTable IdentTable; |
| 1024 | |
| 1025 | /// Returns the text of \c FormatTok. |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1026 | StringRef rawTokenText(Token &Tok) { |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1027 | return StringRef(SourceMgr.getCharacterData(Tok.getLocation()), |
| 1028 | Tok.getLength()); |
| 1029 | } |
| 1030 | }; |
| 1031 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1032 | class Formatter : public UnwrappedLineConsumer { |
| 1033 | public: |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1034 | Formatter(DiagnosticsEngine &Diag, const FormatStyle &Style, Lexer &Lex, |
| 1035 | SourceManager &SourceMgr, |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1036 | const std::vector<CharSourceRange> &Ranges) |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1037 | : Diag(Diag), Style(Style), Lex(Lex), SourceMgr(SourceMgr), |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 1038 | Whitespaces(SourceMgr), Ranges(Ranges) {} |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1039 | |
Daniel Jasper | 7d19bc2 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 1040 | virtual ~Formatter() {} |
Daniel Jasper | accb0b0 | 2012-12-04 21:05:31 +0000 | [diff] [blame] | 1041 | |
Daniel Jasper | 8ff690a | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 1042 | void deriveLocalStyle() { |
| 1043 | unsigned CountBoundToVariable = 0; |
| 1044 | unsigned CountBoundToType = 0; |
| 1045 | bool HasCpp03IncompatibleFormat = false; |
| 1046 | for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) { |
| 1047 | if (AnnotatedLines[i].First.Children.empty()) |
| 1048 | continue; |
| 1049 | AnnotatedToken *Tok = &AnnotatedLines[i].First.Children[0]; |
| 1050 | while (!Tok->Children.empty()) { |
| 1051 | if (Tok->Type == TT_PointerOrReference) { |
| 1052 | bool SpacesBefore = Tok->FormatTok.WhiteSpaceLength > 0; |
| 1053 | bool SpacesAfter = Tok->Children[0].FormatTok.WhiteSpaceLength > 0; |
| 1054 | if (SpacesBefore && !SpacesAfter) |
| 1055 | ++CountBoundToVariable; |
| 1056 | else if (!SpacesBefore && SpacesAfter) |
| 1057 | ++CountBoundToType; |
| 1058 | } |
| 1059 | |
Daniel Jasper | 29f123b | 2013-02-08 15:28:42 +0000 | [diff] [blame] | 1060 | if (Tok->Type == TT_TemplateCloser && |
| 1061 | Tok->Parent->Type == TT_TemplateCloser && |
| 1062 | Tok->FormatTok.WhiteSpaceLength == 0) |
Daniel Jasper | 8ff690a | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 1063 | HasCpp03IncompatibleFormat = true; |
| 1064 | Tok = &Tok->Children[0]; |
| 1065 | } |
| 1066 | } |
| 1067 | if (Style.DerivePointerBinding) { |
| 1068 | if (CountBoundToType > CountBoundToVariable) |
| 1069 | Style.PointerBindsToType = true; |
| 1070 | else if (CountBoundToType < CountBoundToVariable) |
| 1071 | Style.PointerBindsToType = false; |
| 1072 | } |
| 1073 | if (Style.Standard == FormatStyle::LS_Auto) { |
| 1074 | Style.Standard = HasCpp03IncompatibleFormat ? FormatStyle::LS_Cpp11 |
| 1075 | : FormatStyle::LS_Cpp03; |
| 1076 | } |
| 1077 | } |
| 1078 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1079 | tooling::Replacements format() { |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1080 | LexerBasedFormatTokenSource Tokens(Lex, SourceMgr); |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1081 | UnwrappedLineParser Parser(Diag, Style, Tokens, *this); |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1082 | StructuralError = Parser.parse(); |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1083 | unsigned PreviousEndOfLineColumn = 0; |
Nico Weber | c2e6d2a | 2013-02-11 15:32:15 +0000 | [diff] [blame] | 1084 | TokenAnnotator Annotator(Style, SourceMgr, Lex, |
| 1085 | Tokens.getIdentTable().get("in")); |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1086 | for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) { |
Daniel Jasper | 8ff690a | 2013-02-06 14:22:40 +0000 | [diff] [blame] | 1087 | Annotator.annotate(AnnotatedLines[i]); |
| 1088 | } |
| 1089 | deriveLocalStyle(); |
| 1090 | for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) { |
| 1091 | Annotator.calculateFormattingInformation(AnnotatedLines[i]); |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1092 | } |
Manuel Klimek | 547d5db | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1093 | std::vector<int> IndentForLevel; |
Daniel Jasper | c78c6b3 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1094 | bool PreviousLineWasTouched = false; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1095 | for (std::vector<AnnotatedLine>::iterator I = AnnotatedLines.begin(), |
| 1096 | E = AnnotatedLines.end(); |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1097 | I != E; ++I) { |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1098 | const AnnotatedLine &TheLine = *I; |
Daniel Jasper | c78c6b3 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1099 | int Offset = getIndentOffset(TheLine.First); |
Manuel Klimek | 547d5db | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1100 | while (IndentForLevel.size() <= TheLine.Level) |
| 1101 | IndentForLevel.push_back(-1); |
| 1102 | IndentForLevel.resize(TheLine.Level + 1); |
Daniel Jasper | 2933316 | 2013-02-18 13:08:03 +0000 | [diff] [blame] | 1103 | bool WasMoved = |
| 1104 | PreviousLineWasTouched && TheLine.First.FormatTok.NewlinesBefore == 0; |
| 1105 | if (TheLine.Type != LT_Invalid && (WasMoved || touchesRanges(TheLine))) { |
Daniel Jasper | c78c6b3 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1106 | unsigned LevelIndent = getIndent(IndentForLevel, TheLine.Level); |
Manuel Klimek | 547d5db | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1107 | unsigned Indent = LevelIndent; |
| 1108 | if (static_cast<int>(Indent) + Offset >= 0) |
| 1109 | Indent += Offset; |
| 1110 | if (!TheLine.First.FormatTok.WhiteSpaceStart.isValid() || |
| 1111 | StructuralError) { |
| 1112 | Indent = LevelIndent = SourceMgr.getSpellingColumnNumber( |
| 1113 | TheLine.First.FormatTok.Tok.getLocation()) - 1; |
| 1114 | } else { |
| 1115 | formatFirstToken(TheLine.First, Indent, TheLine.InPPDirective, |
| 1116 | PreviousEndOfLineColumn); |
| 1117 | } |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1118 | tryFitMultipleLinesInOne(Indent, I, E); |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1119 | UnwrappedLineFormatter Formatter(Style, SourceMgr, TheLine, Indent, |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 1120 | TheLine.First, Whitespaces, |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1121 | StructuralError); |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1122 | PreviousEndOfLineColumn = Formatter.format(); |
Manuel Klimek | 547d5db | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1123 | IndentForLevel[TheLine.Level] = LevelIndent; |
Daniel Jasper | c78c6b3 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1124 | PreviousLineWasTouched = true; |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1125 | } else { |
Daniel Jasper | 9ece2bb | 2013-02-12 16:51:23 +0000 | [diff] [blame] | 1126 | if (TheLine.First.FormatTok.NewlinesBefore > 0 || |
| 1127 | TheLine.First.FormatTok.IsFirst) { |
| 1128 | unsigned Indent = SourceMgr.getSpellingColumnNumber( |
| 1129 | TheLine.First.FormatTok.Tok.getLocation()) - 1; |
| 1130 | unsigned LevelIndent = Indent; |
| 1131 | if (static_cast<int>(LevelIndent) - Offset >= 0) |
| 1132 | LevelIndent -= Offset; |
| 1133 | IndentForLevel[TheLine.Level] = LevelIndent; |
Daniel Jasper | c78c6b3 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1134 | |
| 1135 | // Remove trailing whitespace of the previous line if it was touched. |
| 1136 | if (PreviousLineWasTouched) |
| 1137 | formatFirstToken(TheLine.First, Indent, TheLine.InPPDirective, |
| 1138 | PreviousEndOfLineColumn); |
Daniel Jasper | 9ece2bb | 2013-02-12 16:51:23 +0000 | [diff] [blame] | 1139 | } |
Daniel Jasper | c78c6b3 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1140 | // If we did not reformat this unwrapped line, the column at the end of |
| 1141 | // the last token is unchanged - thus, we can calculate the end of the |
| 1142 | // last token. |
| 1143 | PreviousEndOfLineColumn = |
| 1144 | SourceMgr.getSpellingColumnNumber( |
| 1145 | TheLine.Last->FormatTok.Tok.getLocation()) + |
| 1146 | Lex.MeasureTokenLength(TheLine.Last->FormatTok.Tok.getLocation(), |
| 1147 | SourceMgr, Lex.getLangOpts()) - 1; |
| 1148 | PreviousLineWasTouched = false; |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1149 | } |
| 1150 | } |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 1151 | return Whitespaces.generateReplacements(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1152 | } |
| 1153 | |
| 1154 | private: |
Manuel Klimek | 547d5db | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1155 | /// \brief Get the indent of \p Level from \p IndentForLevel. |
| 1156 | /// |
| 1157 | /// \p IndentForLevel must contain the indent for the level \c l |
| 1158 | /// at \p IndentForLevel[l], or a value < 0 if the indent for |
| 1159 | /// that level is unknown. |
Daniel Jasper | fc75908 | 2013-02-14 14:26:07 +0000 | [diff] [blame] | 1160 | unsigned getIndent(const std::vector<int> IndentForLevel, unsigned Level) { |
Manuel Klimek | 547d5db | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1161 | if (IndentForLevel[Level] != -1) |
| 1162 | return IndentForLevel[Level]; |
Manuel Klimek | 52635ff | 2013-02-08 19:53:32 +0000 | [diff] [blame] | 1163 | if (Level == 0) |
| 1164 | return 0; |
Daniel Jasper | c78c6b3 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1165 | return getIndent(IndentForLevel, Level - 1) + 2; |
Manuel Klimek | 547d5db | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1166 | } |
| 1167 | |
| 1168 | /// \brief Get the offset of the line relatively to the level. |
| 1169 | /// |
| 1170 | /// For example, 'public:' labels in classes are offset by 1 or 2 |
| 1171 | /// characters to the left from their level. |
Daniel Jasper | c78c6b3 | 2013-02-14 09:58:41 +0000 | [diff] [blame] | 1172 | int getIndentOffset(const AnnotatedToken &RootToken) { |
Manuel Klimek | 547d5db | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1173 | bool IsAccessModifier = false; |
| 1174 | if (RootToken.is(tok::kw_public) || RootToken.is(tok::kw_protected) || |
| 1175 | RootToken.is(tok::kw_private)) |
| 1176 | IsAccessModifier = true; |
| 1177 | else if (RootToken.is(tok::at) && !RootToken.Children.empty() && |
| 1178 | (RootToken.Children[0].isObjCAtKeyword(tok::objc_public) || |
| 1179 | RootToken.Children[0].isObjCAtKeyword(tok::objc_protected) || |
| 1180 | RootToken.Children[0].isObjCAtKeyword(tok::objc_package) || |
| 1181 | RootToken.Children[0].isObjCAtKeyword(tok::objc_private))) |
| 1182 | IsAccessModifier = true; |
| 1183 | |
| 1184 | if (IsAccessModifier) |
| 1185 | return Style.AccessModifierOffset; |
| 1186 | return 0; |
| 1187 | } |
| 1188 | |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1189 | /// \brief Tries to merge lines into one. |
| 1190 | /// |
| 1191 | /// This will change \c Line and \c AnnotatedLine to contain the merged line, |
| 1192 | /// if possible; note that \c I will be incremented when lines are merged. |
| 1193 | /// |
| 1194 | /// Returns whether the resulting \c Line can fit in a single line. |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1195 | void tryFitMultipleLinesInOne(unsigned Indent, |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1196 | std::vector<AnnotatedLine>::iterator &I, |
| 1197 | std::vector<AnnotatedLine>::iterator E) { |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1198 | // We can never merge stuff if there are trailing line comments. |
| 1199 | if (I->Last->Type == TT_LineComment) |
| 1200 | return; |
| 1201 | |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 1202 | unsigned Limit = Style.ColumnLimit - (I->InPPDirective ? 1 : 0) - Indent; |
| 1203 | // If we already exceed the column limit, we set 'Limit' to 0. The different |
| 1204 | // tryMerge..() functions can then decide whether to still do merging. |
| 1205 | Limit = I->Last->TotalLength > Limit ? 0 : Limit - I->Last->TotalLength; |
Daniel Jasper | 55b08e7 | 2013-01-16 07:02:34 +0000 | [diff] [blame] | 1206 | |
Daniel Jasper | 9c8c40e | 2013-01-21 14:18:28 +0000 | [diff] [blame] | 1207 | if (I + 1 == E || (I + 1)->Type == LT_Invalid) |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1208 | return; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1209 | |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1210 | if (I->Last->is(tok::l_brace)) { |
| 1211 | tryMergeSimpleBlock(I, E, Limit); |
| 1212 | } else if (I->First.is(tok::kw_if)) { |
| 1213 | tryMergeSimpleIf(I, E, Limit); |
Daniel Jasper | e0b15ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1214 | } else if (I->InPPDirective && (I->First.FormatTok.HasUnescapedNewline || |
| 1215 | I->First.FormatTok.IsFirst)) { |
| 1216 | tryMergeSimplePPDirective(I, E, Limit); |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1217 | } |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1218 | return; |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1219 | } |
| 1220 | |
Daniel Jasper | e0b15ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1221 | void tryMergeSimplePPDirective(std::vector<AnnotatedLine>::iterator &I, |
| 1222 | std::vector<AnnotatedLine>::iterator E, |
| 1223 | unsigned Limit) { |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 1224 | if (Limit == 0) |
| 1225 | return; |
Daniel Jasper | e0b15ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1226 | AnnotatedLine &Line = *I; |
Daniel Jasper | 2b9c10b | 2013-01-14 15:52:06 +0000 | [diff] [blame] | 1227 | if (!(I + 1)->InPPDirective || (I + 1)->First.FormatTok.HasUnescapedNewline) |
| 1228 | return; |
Daniel Jasper | e0b15ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1229 | if (I + 2 != E && (I + 2)->InPPDirective && |
| 1230 | !(I + 2)->First.FormatTok.HasUnescapedNewline) |
| 1231 | return; |
Manuel Klimek | 2f1ac41 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1232 | if (1 + (I + 1)->Last->TotalLength > Limit) |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1233 | return; |
Daniel Jasper | e0b15ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1234 | join(Line, *(++I)); |
| 1235 | } |
| 1236 | |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1237 | void tryMergeSimpleIf(std::vector<AnnotatedLine>::iterator &I, |
| 1238 | std::vector<AnnotatedLine>::iterator E, |
| 1239 | unsigned Limit) { |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 1240 | if (Limit == 0) |
| 1241 | return; |
Daniel Jasper | 6f5bb2c | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 1242 | if (!Style.AllowShortIfStatementsOnASingleLine) |
| 1243 | return; |
Manuel Klimek | 4c12812 | 2013-01-18 14:46:43 +0000 | [diff] [blame] | 1244 | if ((I + 1)->InPPDirective != I->InPPDirective || |
| 1245 | ((I + 1)->InPPDirective && |
| 1246 | (I + 1)->First.FormatTok.HasUnescapedNewline)) |
| 1247 | return; |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1248 | AnnotatedLine &Line = *I; |
Daniel Jasper | 55b08e7 | 2013-01-16 07:02:34 +0000 | [diff] [blame] | 1249 | if (Line.Last->isNot(tok::r_paren)) |
| 1250 | return; |
Manuel Klimek | 2f1ac41 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1251 | if (1 + (I + 1)->Last->TotalLength > Limit) |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1252 | return; |
| 1253 | if ((I + 1)->First.is(tok::kw_if) || (I + 1)->First.Type == TT_LineComment) |
| 1254 | return; |
| 1255 | // Only inline simple if's (no nested if or else). |
| 1256 | if (I + 2 != E && (I + 2)->First.is(tok::kw_else)) |
| 1257 | return; |
| 1258 | join(Line, *(++I)); |
| 1259 | } |
| 1260 | |
| 1261 | void tryMergeSimpleBlock(std::vector<AnnotatedLine>::iterator &I, |
Daniel Jasper | 1a1ce83 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 1262 | std::vector<AnnotatedLine>::iterator E, |
| 1263 | unsigned Limit) { |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1264 | // First, check that the current line allows merging. This is the case if |
| 1265 | // we're not in a control flow statement and the last token is an opening |
| 1266 | // brace. |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1267 | AnnotatedLine &Line = *I; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1268 | bool AllowedTokens = |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1269 | Line.First.isNot(tok::kw_if) && Line.First.isNot(tok::kw_while) && |
| 1270 | Line.First.isNot(tok::kw_do) && Line.First.isNot(tok::r_brace) && |
| 1271 | Line.First.isNot(tok::kw_else) && Line.First.isNot(tok::kw_try) && |
| 1272 | Line.First.isNot(tok::kw_catch) && Line.First.isNot(tok::kw_for) && |
Nico Weber | 67015ed | 2013-01-11 21:14:08 +0000 | [diff] [blame] | 1273 | // This gets rid of all ObjC @ keywords and methods. |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1274 | Line.First.isNot(tok::at) && Line.First.isNot(tok::minus) && |
| 1275 | Line.First.isNot(tok::plus); |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1276 | if (!AllowedTokens) |
| 1277 | return; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1278 | |
Manuel Klimek | 2f1ac41 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1279 | AnnotatedToken *Tok = &(I + 1)->First; |
| 1280 | if (Tok->Children.empty() && Tok->is(tok::r_brace) && |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 1281 | !Tok->MustBreakBefore) { |
| 1282 | // We merge empty blocks even if the line exceeds the column limit. |
Daniel Jasper | 729a743 | 2013-02-11 12:36:37 +0000 | [diff] [blame] | 1283 | Tok->SpacesRequiredBefore = 0; |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 1284 | Tok->CanBreakBefore = true; |
Manuel Klimek | 2f1ac41 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1285 | join(Line, *(I + 1)); |
| 1286 | I += 1; |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 1287 | } else if (Limit != 0) { |
Manuel Klimek | 2f1ac41 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1288 | // Check that we still have three lines and they fit into the limit. |
| 1289 | if (I + 2 == E || (I + 2)->Type == LT_Invalid || |
| 1290 | !nextTwoLinesFitInto(I, Limit)) |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1291 | return; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1292 | |
Manuel Klimek | 2f1ac41 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1293 | // Second, check that the next line does not contain any braces - if it |
| 1294 | // does, readability declines when putting it into a single line. |
| 1295 | if ((I + 1)->Last->Type == TT_LineComment || Tok->MustBreakBefore) |
| 1296 | return; |
| 1297 | do { |
| 1298 | if (Tok->is(tok::l_brace) || Tok->is(tok::r_brace)) |
| 1299 | return; |
| 1300 | Tok = Tok->Children.empty() ? NULL : &Tok->Children.back(); |
| 1301 | } while (Tok != NULL); |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1302 | |
Manuel Klimek | 2f1ac41 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1303 | // Last, check that the third line contains a single closing brace. |
| 1304 | Tok = &(I + 2)->First; |
| 1305 | if (!Tok->Children.empty() || Tok->isNot(tok::r_brace) || |
| 1306 | Tok->MustBreakBefore) |
| 1307 | return; |
| 1308 | |
| 1309 | join(Line, *(I + 1)); |
| 1310 | join(Line, *(I + 2)); |
| 1311 | I += 2; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1312 | } |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1313 | } |
| 1314 | |
| 1315 | bool nextTwoLinesFitInto(std::vector<AnnotatedLine>::iterator I, |
| 1316 | unsigned Limit) { |
Manuel Klimek | 2f1ac41 | 2013-01-21 16:42:44 +0000 | [diff] [blame] | 1317 | return 1 + (I + 1)->Last->TotalLength + 1 + (I + 2)->Last->TotalLength <= |
| 1318 | Limit; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1319 | } |
| 1320 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1321 | void join(AnnotatedLine &A, const AnnotatedLine &B) { |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 1322 | unsigned LengthA = A.Last->TotalLength + B.First.SpacesRequiredBefore; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1323 | A.Last->Children.push_back(B.First); |
| 1324 | while (!A.Last->Children.empty()) { |
| 1325 | A.Last->Children[0].Parent = A.Last; |
Daniel Jasper | f11a705 | 2013-02-21 21:33:55 +0000 | [diff] [blame^] | 1326 | A.Last->Children[0].TotalLength += LengthA; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1327 | A.Last = &A.Last->Children[0]; |
| 1328 | } |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1329 | } |
| 1330 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1331 | bool touchesRanges(const AnnotatedLine &TheLine) { |
| 1332 | const FormatToken *First = &TheLine.First.FormatTok; |
| 1333 | const FormatToken *Last = &TheLine.Last->FormatTok; |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1334 | CharSourceRange LineRange = CharSourceRange::getTokenRange( |
Daniel Jasper | 1a1ce83 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 1335 | First->Tok.getLocation(), Last->Tok.getLocation()); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1336 | for (unsigned i = 0, e = Ranges.size(); i != e; ++i) { |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1337 | if (!SourceMgr.isBeforeInTranslationUnit(LineRange.getEnd(), |
| 1338 | Ranges[i].getBegin()) && |
| 1339 | !SourceMgr.isBeforeInTranslationUnit(Ranges[i].getEnd(), |
| 1340 | LineRange.getBegin())) |
| 1341 | return true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1342 | } |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1343 | return false; |
| 1344 | } |
| 1345 | |
| 1346 | virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) { |
Daniel Jasper | cbb6c41 | 2013-01-16 09:10:19 +0000 | [diff] [blame] | 1347 | AnnotatedLines.push_back(AnnotatedLine(TheLine)); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1348 | } |
| 1349 | |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1350 | /// \brief Add a new line and the required indent before the first Token |
| 1351 | /// of the \c UnwrappedLine if there was no structural parsing error. |
| 1352 | /// Returns the indent level of the \c UnwrappedLine. |
Manuel Klimek | 547d5db | 2013-02-08 17:38:27 +0000 | [diff] [blame] | 1353 | void formatFirstToken(const AnnotatedToken &RootToken, unsigned Indent, |
| 1354 | bool InPPDirective, unsigned PreviousEndOfLineColumn) { |
Daniel Jasper | 7d19bc2 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 1355 | const FormatToken &Tok = RootToken.FormatTok; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1356 | |
Daniel Jasper | 1a1ce83 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 1357 | unsigned Newlines = |
| 1358 | std::min(Tok.NewlinesBefore, Style.MaxEmptyLinesToKeep + 1); |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1359 | if (Newlines == 0 && !Tok.IsFirst) |
| 1360 | Newlines = 1; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1361 | |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1362 | if (!InPPDirective || Tok.HasUnescapedNewline) { |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 1363 | Whitespaces.replaceWhitespace(RootToken, Newlines, Indent, 0, Style); |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1364 | } else { |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 1365 | Whitespaces.replacePPWhitespace(RootToken, Newlines, Indent, |
| 1366 | PreviousEndOfLineColumn, Style); |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1367 | } |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1368 | } |
| 1369 | |
Alexander Kornienko | a4ae9f3 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1370 | DiagnosticsEngine &Diag; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1371 | FormatStyle Style; |
| 1372 | Lexer &Lex; |
| 1373 | SourceManager &SourceMgr; |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame] | 1374 | WhitespaceManager Whitespaces; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1375 | std::vector<CharSourceRange> Ranges; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1376 | std::vector<AnnotatedLine> AnnotatedLines; |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1377 | bool StructuralError; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1378 | }; |
| 1379 | |
Daniel Jasper | 1a1ce83 | 2013-01-29 11:27:30 +0000 | [diff] [blame] | 1380 | tooling::Replacements |
| 1381 | reformat(const FormatStyle &Style, Lexer &Lex, SourceManager &SourceMgr, |
| 1382 | std::vector<CharSourceRange> Ranges, DiagnosticConsumer *DiagClient) { |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1383 | IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions(); |
Alexander Kornienko | a4ae9f3 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1384 | OwningPtr<DiagnosticConsumer> DiagPrinter; |
| 1385 | if (DiagClient == 0) { |
| 1386 | DiagPrinter.reset(new TextDiagnosticPrinter(llvm::errs(), &*DiagOpts)); |
| 1387 | DiagPrinter->BeginSourceFile(Lex.getLangOpts(), Lex.getPP()); |
| 1388 | DiagClient = DiagPrinter.get(); |
| 1389 | } |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1390 | DiagnosticsEngine Diagnostics( |
Dmitri Gribenko | cfa88f8 | 2013-01-12 19:30:44 +0000 | [diff] [blame] | 1391 | IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs()), &*DiagOpts, |
Alexander Kornienko | a4ae9f3 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1392 | DiagClient, false); |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1393 | Diagnostics.setSourceManager(&SourceMgr); |
| 1394 | Formatter formatter(Diagnostics, Style, Lex, SourceMgr, Ranges); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1395 | return formatter.format(); |
| 1396 | } |
| 1397 | |
Daniel Jasper | 46ef852 | 2013-01-10 13:08:12 +0000 | [diff] [blame] | 1398 | LangOptions getFormattingLangOpts() { |
| 1399 | LangOptions LangOpts; |
| 1400 | LangOpts.CPlusPlus = 1; |
| 1401 | LangOpts.CPlusPlus11 = 1; |
| 1402 | LangOpts.Bool = 1; |
| 1403 | LangOpts.ObjC1 = 1; |
| 1404 | LangOpts.ObjC2 = 1; |
| 1405 | return LangOpts; |
| 1406 | } |
| 1407 | |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1408 | } // namespace format |
| 1409 | } // namespace clang |