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 | /// |
| 14 | /// This is EXPERIMENTAL code under heavy development. It is not in a state yet, |
| 15 | /// where it can be used to format real code. |
| 16 | /// |
| 17 | //===----------------------------------------------------------------------===// |
| 18 | |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 19 | #define DEBUG_TYPE "format-formatter" |
| 20 | |
Chandler Carruth | 55fc873 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 21 | #include "UnwrappedLineParser.h" |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 22 | #include "clang/Basic/Diagnostic.h" |
Daniel Jasper | 675d2e3 | 2012-12-21 10:20:02 +0000 | [diff] [blame] | 23 | #include "clang/Basic/OperatorPrecedence.h" |
Chandler Carruth | b99083e | 2013-01-02 10:28:36 +0000 | [diff] [blame] | 24 | #include "clang/Basic/SourceManager.h" |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 25 | #include "clang/Format/Format.h" |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 26 | #include "clang/Frontend/TextDiagnosticPrinter.h" |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 27 | #include "clang/Lex/Lexer.h" |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 28 | #include "llvm/Support/Debug.h" |
Daniel Jasper | 8822d3a | 2012-12-04 13:02:32 +0000 | [diff] [blame] | 29 | #include <string> |
| 30 | |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 31 | // Uncomment to get debug output from tests: |
| 32 | // #define DEBUG_WITH_TYPE(T, X) do { X; } while(0) |
| 33 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 34 | namespace clang { |
| 35 | namespace format { |
| 36 | |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 37 | enum TokenType { |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 38 | TT_BinaryOperator, |
Daniel Jasper | 5cf7cf3 | 2013-01-10 11:14:08 +0000 | [diff] [blame] | 39 | TT_BlockComment, |
| 40 | TT_CastRParen, |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 41 | TT_ConditionalExpr, |
| 42 | TT_CtorInitializerColon, |
Manuel Klimek | 407a31a | 2013-01-15 15:50:27 +0000 | [diff] [blame] | 43 | TT_ImplicitStringLiteral, |
Daniel Jasper | 5cf7cf3 | 2013-01-10 11:14:08 +0000 | [diff] [blame] | 44 | TT_LineComment, |
Daniel Jasper | 46ef852 | 2013-01-10 13:08:12 +0000 | [diff] [blame] | 45 | TT_ObjCBlockLParen, |
Nico Weber | ed91bba | 2013-01-10 19:19:14 +0000 | [diff] [blame] | 46 | TT_ObjCDecl, |
Daniel Jasper | 5cf7cf3 | 2013-01-10 11:14:08 +0000 | [diff] [blame] | 47 | TT_ObjCMethodSpecifier, |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 48 | TT_ObjCMethodExpr, |
Nico Weber | 7084823 | 2013-01-10 21:30:42 +0000 | [diff] [blame] | 49 | TT_ObjCProperty, |
Daniel Jasper | 5cf7cf3 | 2013-01-10 11:14:08 +0000 | [diff] [blame] | 50 | TT_OverloadedOperator, |
| 51 | TT_PointerOrReference, |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 52 | TT_PureVirtualSpecifier, |
Daniel Jasper | 5cf7cf3 | 2013-01-10 11:14:08 +0000 | [diff] [blame] | 53 | TT_TemplateCloser, |
| 54 | TT_TemplateOpener, |
| 55 | TT_TrailingUnaryOperator, |
| 56 | TT_UnaryOperator, |
| 57 | TT_Unknown |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 58 | }; |
| 59 | |
| 60 | enum LineType { |
| 61 | LT_Invalid, |
| 62 | LT_Other, |
| 63 | LT_PreprocessorDirective, |
| 64 | LT_VirtualFunctionDecl, |
Nico Weber | ed91bba | 2013-01-10 19:19:14 +0000 | [diff] [blame] | 65 | LT_ObjCDecl, // An @interface, @implementation, or @protocol line. |
Nico Weber | 7084823 | 2013-01-10 21:30:42 +0000 | [diff] [blame] | 66 | LT_ObjCMethodDecl, |
| 67 | LT_ObjCProperty // An @property line. |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 68 | }; |
| 69 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 70 | class AnnotatedToken { |
| 71 | public: |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 72 | explicit AnnotatedToken(const FormatToken &FormatTok) |
Manuel Klimek | 94fc6f1 | 2013-01-10 19:17:33 +0000 | [diff] [blame] | 73 | : FormatTok(FormatTok), Type(TT_Unknown), SpaceRequiredBefore(false), |
| 74 | CanBreakBefore(false), MustBreakBefore(false), |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 75 | ClosesTemplateDeclaration(false), MatchingParen(NULL), Parent(NULL) {} |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 76 | |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 77 | bool is(tok::TokenKind Kind) const { return FormatTok.Tok.is(Kind); } |
| 78 | bool isNot(tok::TokenKind Kind) const { return FormatTok.Tok.isNot(Kind); } |
| 79 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 80 | bool isObjCAtKeyword(tok::ObjCKeywordKind Kind) const { |
| 81 | return FormatTok.Tok.isObjCAtKeyword(Kind); |
| 82 | } |
| 83 | |
| 84 | FormatToken FormatTok; |
| 85 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 86 | TokenType Type; |
| 87 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 88 | bool SpaceRequiredBefore; |
| 89 | bool CanBreakBefore; |
| 90 | bool MustBreakBefore; |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 91 | |
| 92 | bool ClosesTemplateDeclaration; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 93 | |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 94 | AnnotatedToken *MatchingParen; |
| 95 | |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 96 | /// \brief The total length of the line up to and including this token. |
| 97 | unsigned TotalLength; |
| 98 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 99 | std::vector<AnnotatedToken> Children; |
| 100 | AnnotatedToken *Parent; |
Daniel Jasper | 2c6cc48 | 2013-01-17 12:53:34 +0000 | [diff] [blame] | 101 | |
| 102 | const AnnotatedToken *getPreviousNoneComment() const { |
| 103 | AnnotatedToken *Tok = Parent; |
| 104 | while (Tok != NULL && Tok->is(tok::comment)) |
| 105 | Tok = Tok->Parent; |
| 106 | return Tok; |
| 107 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 108 | }; |
| 109 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 110 | class AnnotatedLine { |
| 111 | public: |
Daniel Jasper | cbb6c41 | 2013-01-16 09:10:19 +0000 | [diff] [blame] | 112 | AnnotatedLine(const UnwrappedLine &Line) |
| 113 | : First(Line.Tokens.front()), Level(Line.Level), |
| 114 | InPPDirective(Line.InPPDirective) { |
| 115 | assert(!Line.Tokens.empty()); |
| 116 | AnnotatedToken *Current = &First; |
| 117 | for (std::list<FormatToken>::const_iterator I = ++Line.Tokens.begin(), |
| 118 | E = Line.Tokens.end(); |
| 119 | I != E; ++I) { |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 120 | Current->Children.push_back(AnnotatedToken(*I)); |
Daniel Jasper | cbb6c41 | 2013-01-16 09:10:19 +0000 | [diff] [blame] | 121 | Current->Children[0].Parent = Current; |
| 122 | Current = &Current->Children[0]; |
| 123 | } |
| 124 | Last = Current; |
| 125 | } |
| 126 | AnnotatedLine(const AnnotatedLine &Other) |
| 127 | : First(Other.First), Type(Other.Type), Level(Other.Level), |
| 128 | InPPDirective(Other.InPPDirective) { |
| 129 | Last = &First; |
| 130 | while (!Last->Children.empty()) { |
| 131 | Last->Children[0].Parent = Last; |
| 132 | Last = &Last->Children[0]; |
| 133 | } |
| 134 | } |
| 135 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 136 | AnnotatedToken First; |
| 137 | AnnotatedToken *Last; |
| 138 | |
| 139 | LineType Type; |
| 140 | unsigned Level; |
| 141 | bool InPPDirective; |
| 142 | }; |
| 143 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 144 | static prec::Level getPrecedence(const AnnotatedToken &Tok) { |
| 145 | return getBinOpPrecedence(Tok.FormatTok.Tok.getKind(), true, true); |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 146 | } |
| 147 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 148 | FormatStyle getLLVMStyle() { |
| 149 | FormatStyle LLVMStyle; |
| 150 | LLVMStyle.ColumnLimit = 80; |
| 151 | LLVMStyle.MaxEmptyLinesToKeep = 1; |
| 152 | LLVMStyle.PointerAndReferenceBindToType = false; |
| 153 | LLVMStyle.AccessModifierOffset = -2; |
| 154 | LLVMStyle.SplitTemplateClosingGreater = true; |
Alexander Kornienko | 1575731 | 2012-12-06 18:03:27 +0000 | [diff] [blame] | 155 | LLVMStyle.IndentCaseLabels = false; |
Daniel Jasper | 7ad4eff | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 156 | LLVMStyle.SpacesBeforeTrailingComments = 1; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 157 | LLVMStyle.BinPackParameters = true; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 158 | LLVMStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = false; |
Daniel Jasper | 6f5bb2c | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 159 | LLVMStyle.AllowShortIfStatementsOnASingleLine = false; |
Nico Weber | 5f500df | 2013-01-10 20:12:55 +0000 | [diff] [blame] | 160 | LLVMStyle.ObjCSpaceBeforeProtocolList = true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 161 | return LLVMStyle; |
| 162 | } |
| 163 | |
| 164 | FormatStyle getGoogleStyle() { |
| 165 | FormatStyle GoogleStyle; |
| 166 | GoogleStyle.ColumnLimit = 80; |
| 167 | GoogleStyle.MaxEmptyLinesToKeep = 1; |
| 168 | GoogleStyle.PointerAndReferenceBindToType = true; |
| 169 | GoogleStyle.AccessModifierOffset = -1; |
| 170 | GoogleStyle.SplitTemplateClosingGreater = false; |
Alexander Kornienko | 1575731 | 2012-12-06 18:03:27 +0000 | [diff] [blame] | 171 | GoogleStyle.IndentCaseLabels = true; |
Daniel Jasper | 7ad4eff | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 172 | GoogleStyle.SpacesBeforeTrailingComments = 2; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 173 | GoogleStyle.BinPackParameters = false; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 174 | GoogleStyle.ConstructorInitializerAllOnOneLineOrOnePerLine = true; |
Daniel Jasper | df3736a | 2013-01-16 15:44:34 +0000 | [diff] [blame] | 175 | GoogleStyle.AllowShortIfStatementsOnASingleLine = false; |
Nico Weber | 5f500df | 2013-01-10 20:12:55 +0000 | [diff] [blame] | 176 | GoogleStyle.ObjCSpaceBeforeProtocolList = false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 177 | return GoogleStyle; |
| 178 | } |
| 179 | |
Daniel Jasper | 6f5bb2c | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 180 | FormatStyle getChromiumStyle() { |
| 181 | FormatStyle ChromiumStyle = getGoogleStyle(); |
| 182 | ChromiumStyle.AllowShortIfStatementsOnASingleLine = false; |
| 183 | return ChromiumStyle; |
| 184 | } |
| 185 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 186 | struct OptimizationParameters { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 187 | unsigned PenaltyIndentLevel; |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 188 | unsigned PenaltyLevelDecrease; |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 189 | unsigned PenaltyExcessCharacter; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 190 | }; |
| 191 | |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 192 | /// \brief Manages the whitespaces around tokens and their replacements. |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 193 | /// |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 194 | /// This includes special handling for certain constructs, e.g. the alignment of |
| 195 | /// trailing line comments. |
| 196 | class WhitespaceManager { |
| 197 | public: |
| 198 | WhitespaceManager(SourceManager &SourceMgr) : SourceMgr(SourceMgr) {} |
| 199 | |
| 200 | /// \brief Replaces the whitespace in front of \p Tok. Only call once for |
| 201 | /// each \c AnnotatedToken. |
| 202 | void replaceWhitespace(const AnnotatedToken &Tok, unsigned NewLines, |
| 203 | unsigned Spaces, unsigned WhitespaceStartColumn, |
| 204 | const FormatStyle &Style) { |
| 205 | if (Tok.Type == TT_LineComment && NewLines < 2 && |
| 206 | (Tok.Parent != NULL || !Comments.empty())) { |
| 207 | if (Style.ColumnLimit >= |
| 208 | Spaces + WhitespaceStartColumn + Tok.FormatTok.TokenLength) { |
| 209 | Comments.push_back(StoredComment()); |
| 210 | Comments.back().Tok = Tok.FormatTok; |
| 211 | Comments.back().Spaces = Spaces; |
| 212 | Comments.back().NewLines = NewLines; |
| 213 | Comments.back().MinColumn = WhitespaceStartColumn + Spaces; |
| 214 | Comments.back().MaxColumn = Style.ColumnLimit - |
| 215 | Spaces - Tok.FormatTok.TokenLength; |
| 216 | return; |
| 217 | } |
| 218 | } else if (NewLines == 0 && Tok.Children.empty() && |
| 219 | Tok.Type != TT_LineComment) { |
| 220 | alignComments(); |
| 221 | } |
| 222 | storeReplacement(Tok.FormatTok, |
| 223 | std::string(NewLines, '\n') + std::string(Spaces, ' ')); |
| 224 | } |
| 225 | |
| 226 | /// \brief Like \c replaceWhitespace, but additionally adds right-aligned |
| 227 | /// backslashes to escape newlines inside a preprocessor directive. |
| 228 | /// |
| 229 | /// This function and \c replaceWhitespace have the same behavior if |
| 230 | /// \c Newlines == 0. |
| 231 | void replacePPWhitespace(const AnnotatedToken &Tok, unsigned NewLines, |
| 232 | unsigned Spaces, unsigned WhitespaceStartColumn, |
| 233 | const FormatStyle &Style) { |
| 234 | std::string NewLineText; |
| 235 | if (NewLines > 0) { |
| 236 | unsigned Offset = std::min<int>(Style.ColumnLimit - 1, |
| 237 | WhitespaceStartColumn); |
| 238 | for (unsigned i = 0; i < NewLines; ++i) { |
| 239 | NewLineText += std::string(Style.ColumnLimit - Offset - 1, ' '); |
| 240 | NewLineText += "\\\n"; |
| 241 | Offset = 0; |
| 242 | } |
| 243 | } |
| 244 | storeReplacement(Tok.FormatTok, NewLineText + std::string(Spaces, ' ')); |
| 245 | } |
| 246 | |
| 247 | /// \brief Returns all the \c Replacements created during formatting. |
| 248 | const tooling::Replacements &generateReplacements() { |
| 249 | alignComments(); |
| 250 | return Replaces; |
| 251 | } |
| 252 | |
| 253 | private: |
| 254 | /// \brief Structure to store a comment for later layout and alignment. |
| 255 | struct StoredComment { |
| 256 | FormatToken Tok; |
| 257 | unsigned MinColumn; |
| 258 | unsigned MaxColumn; |
| 259 | unsigned NewLines; |
| 260 | unsigned Spaces; |
| 261 | }; |
| 262 | SmallVector<StoredComment, 16> Comments; |
| 263 | typedef SmallVector<StoredComment, 16>::iterator comment_iterator; |
| 264 | |
| 265 | /// \brief Try to align all stashed comments. |
| 266 | void alignComments() { |
| 267 | unsigned MinColumn = 0; |
| 268 | unsigned MaxColumn = UINT_MAX; |
| 269 | comment_iterator Start = Comments.begin(); |
| 270 | for (comment_iterator I = Comments.begin(), E = Comments.end(); I != E; |
| 271 | ++I) { |
| 272 | if (I->MinColumn > MaxColumn || I->MaxColumn < MinColumn) { |
| 273 | alignComments(Start, I, MinColumn); |
| 274 | MinColumn = I->MinColumn; |
| 275 | MaxColumn = I->MaxColumn; |
| 276 | Start = I; |
| 277 | } else { |
| 278 | MinColumn = std::max(MinColumn, I->MinColumn); |
| 279 | MaxColumn = std::min(MaxColumn, I->MaxColumn); |
| 280 | } |
| 281 | } |
| 282 | alignComments(Start, Comments.end(), MinColumn); |
| 283 | Comments.clear(); |
| 284 | } |
| 285 | |
| 286 | /// \brief Put all the comments between \p I and \p E into \p Column. |
| 287 | void alignComments(comment_iterator I, comment_iterator E, unsigned Column) { |
| 288 | while (I != E) { |
| 289 | unsigned Spaces = I->Spaces + Column - I->MinColumn; |
| 290 | storeReplacement(I->Tok, std::string(I->NewLines, '\n') + |
| 291 | std::string(Spaces, ' ')); |
| 292 | ++I; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 293 | } |
| 294 | } |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 295 | |
| 296 | /// \brief Stores \p Text as the replacement for the whitespace in front of |
| 297 | /// \p Tok. |
| 298 | void storeReplacement(const FormatToken &Tok, const std::string Text) { |
| 299 | Replaces.insert(tooling::Replacement(SourceMgr, Tok.WhiteSpaceStart, |
| 300 | Tok.WhiteSpaceLength, Text)); |
| 301 | } |
| 302 | |
| 303 | SourceManager &SourceMgr; |
| 304 | tooling::Replacements Replaces; |
| 305 | }; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 306 | |
Nico Weber | e8ccc81 | 2013-01-12 22:48:47 +0000 | [diff] [blame] | 307 | /// \brief Returns if a token is an Objective-C selector name. |
| 308 | /// |
Nico Weber | ea86563 | 2013-01-12 22:51:13 +0000 | [diff] [blame] | 309 | /// For example, "bar" is a selector name in [foo bar:(4 + 5)]. |
Nico Weber | e8ccc81 | 2013-01-12 22:48:47 +0000 | [diff] [blame] | 310 | static bool isObjCSelectorName(const AnnotatedToken &Tok) { |
| 311 | return Tok.is(tok::identifier) && !Tok.Children.empty() && |
| 312 | Tok.Children[0].is(tok::colon) && |
| 313 | Tok.Children[0].Type == TT_ObjCMethodExpr; |
| 314 | } |
| 315 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 316 | class UnwrappedLineFormatter { |
| 317 | public: |
Manuel Klimek | 94fc6f1 | 2013-01-10 19:17:33 +0000 | [diff] [blame] | 318 | UnwrappedLineFormatter(const FormatStyle &Style, SourceManager &SourceMgr, |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 319 | const AnnotatedLine &Line, unsigned FirstIndent, |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 320 | const AnnotatedToken &RootToken, |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 321 | WhitespaceManager &Whitespaces, bool StructuralError) |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 322 | : Style(Style), SourceMgr(SourceMgr), Line(Line), |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 323 | FirstIndent(FirstIndent), RootToken(RootToken), |
| 324 | Whitespaces(Whitespaces) { |
Daniel Jasper | e2c7acf | 2012-12-24 00:13:23 +0000 | [diff] [blame] | 325 | Parameters.PenaltyIndentLevel = 15; |
Daniel Jasper | 46a46a2 | 2013-01-07 07:13:20 +0000 | [diff] [blame] | 326 | Parameters.PenaltyLevelDecrease = 30; |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 327 | Parameters.PenaltyExcessCharacter = 1000000; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 328 | } |
| 329 | |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 330 | /// \brief Formats an \c UnwrappedLine. |
| 331 | /// |
| 332 | /// \returns The column after the last token in the last line of the |
| 333 | /// \c UnwrappedLine. |
| 334 | unsigned format() { |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 335 | // Initialize state dependent on indent. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 336 | LineState State; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 337 | State.Column = FirstIndent; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 338 | State.NextToken = &RootToken; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 339 | State.Stack.push_back(ParenState(FirstIndent + 4, FirstIndent)); |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 340 | State.ForLoopVariablePos = 0; |
| 341 | State.LineContainsContinuedForLoopSection = false; |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 342 | State.StartOfLineLevel = 1; |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 343 | |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 344 | DEBUG({ |
| 345 | DebugTokenState(*State.NextToken); |
| 346 | }); |
| 347 | |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 348 | // The first token has already been indented and thus consumed. |
| 349 | moveStateToNextToken(State); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 350 | |
| 351 | // Start iterating at 1 as we have correctly formatted of Token #0 above. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 352 | while (State.NextToken != NULL) { |
Manuel Klimek | 1913230 | 2013-01-15 16:41:02 +0000 | [diff] [blame] | 353 | if (State.NextToken->Type == TT_ImplicitStringLiteral) |
| 354 | // We will not touch the rest of the white space in this |
| 355 | // \c UnwrappedLine. The returned value can also not matter, as we |
| 356 | // cannot continue an top-level implicit string literal on the next |
| 357 | // line. |
| 358 | return 0; |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 359 | if (Line.Last->TotalLength <= getColumnLimit() - FirstIndent) { |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 360 | addTokenToState(false, false, State); |
| 361 | } else { |
| 362 | unsigned NoBreak = calcPenalty(State, false, UINT_MAX); |
| 363 | unsigned Break = calcPenalty(State, true, NoBreak); |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 364 | DEBUG({ |
| 365 | if (Break < NoBreak) |
| 366 | llvm::errs() << "\n"; |
| 367 | else |
| 368 | llvm::errs() << " "; |
| 369 | llvm::errs() << "<"; |
| 370 | DebugPenalty(Break, Break < NoBreak); |
| 371 | llvm::errs() << "/"; |
| 372 | DebugPenalty(NoBreak, !(Break < NoBreak)); |
| 373 | llvm::errs() << "> "; |
| 374 | DebugTokenState(*State.NextToken); |
| 375 | }); |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 376 | addTokenToState(Break < NoBreak, false, State); |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 377 | if (State.NextToken != NULL && |
| 378 | State.NextToken->Parent->Type == TT_CtorInitializerColon) { |
| 379 | if (Style.ConstructorInitializerAllOnOneLineOrOnePerLine && |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 380 | Line.Last->TotalLength > getColumnLimit() - State.Column - 1) |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 381 | State.Stack.back().BreakAfterComma = true; |
| 382 | } |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 383 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 384 | } |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 385 | DEBUG(llvm::errs() << "\n"); |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 386 | return State.Column; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 387 | } |
| 388 | |
| 389 | private: |
Manuel Klimek | ca547db | 2013-01-16 14:55:28 +0000 | [diff] [blame] | 390 | void DebugTokenState(const AnnotatedToken &AnnotatedTok) { |
| 391 | const Token &Tok = AnnotatedTok.FormatTok.Tok; |
| 392 | llvm::errs() |
| 393 | << StringRef(SourceMgr.getCharacterData(Tok.getLocation()), |
| 394 | Tok.getLength()); |
| 395 | llvm::errs(); |
| 396 | } |
| 397 | |
| 398 | void DebugPenalty(unsigned Penalty, bool Winner) { |
| 399 | llvm::errs().changeColor(Winner ? raw_ostream::GREEN : raw_ostream::RED); |
| 400 | if (Penalty == UINT_MAX) |
| 401 | llvm::errs() << "MAX"; |
| 402 | else |
| 403 | llvm::errs() << Penalty; |
| 404 | llvm::errs().resetColor(); |
| 405 | } |
| 406 | |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 407 | struct ParenState { |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 408 | ParenState(unsigned Indent, unsigned LastSpace) |
| 409 | : Indent(Indent), LastSpace(LastSpace), FirstLessLess(0), |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 410 | BreakBeforeClosingBrace(false), BreakAfterComma(false), |
| 411 | HasMultiParameterLine(false) {} |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 412 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 413 | /// \brief The position to which a specific parenthesis level needs to be |
| 414 | /// indented. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 415 | unsigned Indent; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 416 | |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 417 | /// \brief The position of the last space on each level. |
| 418 | /// |
| 419 | /// Used e.g. to break like: |
| 420 | /// functionCall(Parameter, otherCall( |
| 421 | /// OtherParameter)); |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 422 | unsigned LastSpace; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 423 | |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 424 | /// \brief The position the first "<<" operator encountered on each level. |
| 425 | /// |
| 426 | /// Used to align "<<" operators. 0 if no such operator has been encountered |
| 427 | /// on a level. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 428 | unsigned FirstLessLess; |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 429 | |
Manuel Klimek | c8c8a47 | 2013-01-10 15:58:26 +0000 | [diff] [blame] | 430 | /// \brief Whether a newline needs to be inserted before the block's closing |
| 431 | /// brace. |
| 432 | /// |
| 433 | /// We only want to insert a newline before the closing brace if there also |
| 434 | /// was a newline after the beginning left brace. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 435 | bool BreakBeforeClosingBrace; |
| 436 | |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 437 | bool BreakAfterComma; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 438 | bool HasMultiParameterLine; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 439 | |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 440 | bool operator<(const ParenState &Other) const { |
| 441 | if (Indent != Other.Indent) |
Daniel Jasper | 7d19bc2 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 442 | return Indent < Other.Indent; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 443 | if (LastSpace != Other.LastSpace) |
| 444 | return LastSpace < Other.LastSpace; |
| 445 | if (FirstLessLess != Other.FirstLessLess) |
| 446 | return FirstLessLess < Other.FirstLessLess; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 447 | if (BreakBeforeClosingBrace != Other.BreakBeforeClosingBrace) |
| 448 | return BreakBeforeClosingBrace; |
Daniel Jasper | b312314 | 2013-01-12 07:36:22 +0000 | [diff] [blame] | 449 | if (BreakAfterComma != Other.BreakAfterComma) |
| 450 | return BreakAfterComma; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 451 | if (HasMultiParameterLine != Other.HasMultiParameterLine) |
| 452 | return HasMultiParameterLine; |
Daniel Jasper | b312314 | 2013-01-12 07:36:22 +0000 | [diff] [blame] | 453 | return false; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 454 | } |
| 455 | }; |
| 456 | |
| 457 | /// \brief The current state when indenting a unwrapped line. |
| 458 | /// |
| 459 | /// As the indenting tries different combinations this is copied by value. |
| 460 | struct LineState { |
| 461 | /// \brief The number of used columns in the current line. |
| 462 | unsigned Column; |
| 463 | |
| 464 | /// \brief The token that needs to be next formatted. |
| 465 | const AnnotatedToken *NextToken; |
| 466 | |
| 467 | /// \brief The parenthesis level of the first token on the current line. |
| 468 | unsigned StartOfLineLevel; |
Manuel Klimek | c8c8a47 | 2013-01-10 15:58:26 +0000 | [diff] [blame] | 469 | |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 470 | /// \brief The column of the first variable in a for-loop declaration. |
| 471 | /// |
| 472 | /// Used to align the second variable if necessary. |
| 473 | unsigned ForLoopVariablePos; |
| 474 | |
| 475 | /// \brief \c true if this line contains a continued for-loop section. |
| 476 | bool LineContainsContinuedForLoopSection; |
| 477 | |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 478 | /// \brief A stack keeping track of properties applying to parenthesis |
| 479 | /// levels. |
| 480 | std::vector<ParenState> Stack; |
| 481 | |
| 482 | /// \brief Comparison operator to be able to used \c LineState in \c map. |
| 483 | bool operator<(const LineState &Other) const { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 484 | if (Other.NextToken != NextToken) |
| 485 | return Other.NextToken > NextToken; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 486 | if (Other.Column != Column) |
| 487 | return Other.Column > Column; |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 488 | if (Other.StartOfLineLevel != StartOfLineLevel) |
| 489 | return Other.StartOfLineLevel > StartOfLineLevel; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 490 | if (Other.ForLoopVariablePos != ForLoopVariablePos) |
| 491 | return Other.ForLoopVariablePos < ForLoopVariablePos; |
| 492 | if (Other.LineContainsContinuedForLoopSection != |
| 493 | LineContainsContinuedForLoopSection) |
| 494 | return LineContainsContinuedForLoopSection; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 495 | return Other.Stack < Stack; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 496 | } |
| 497 | }; |
| 498 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 499 | /// \brief Appends the next token to \p State and updates information |
| 500 | /// necessary for indentation. |
| 501 | /// |
| 502 | /// Puts the token on the current line if \p Newline is \c true and adds a |
| 503 | /// line break and necessary indentation otherwise. |
| 504 | /// |
| 505 | /// If \p DryRun is \c false, also creates and stores the required |
| 506 | /// \c Replacement. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 507 | void addTokenToState(bool Newline, bool DryRun, LineState &State) { |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 508 | const AnnotatedToken &Current = *State.NextToken; |
| 509 | const AnnotatedToken &Previous = *State.NextToken->Parent; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 510 | assert(State.Stack.size()); |
| 511 | unsigned ParenLevel = State.Stack.size() - 1; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 512 | |
| 513 | if (Newline) { |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 514 | unsigned WhitespaceStartColumn = State.Column; |
Manuel Klimek | bb42bf1 | 2013-01-10 11:52:21 +0000 | [diff] [blame] | 515 | if (Current.is(tok::r_brace)) { |
| 516 | State.Column = Line.Level * 2; |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 517 | } else if (Current.is(tok::string_literal) && |
| 518 | Previous.is(tok::string_literal)) { |
| 519 | State.Column = State.Column - Previous.FormatTok.TokenLength; |
| 520 | } else if (Current.is(tok::lessless) && |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 521 | State.Stack[ParenLevel].FirstLessLess != 0) { |
| 522 | State.Column = State.Stack[ParenLevel].FirstLessLess; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 523 | } else if (ParenLevel != 0 && |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 524 | (Previous.is(tok::equal) || Current.is(tok::arrow) || |
| 525 | Current.is(tok::period) || Previous.is(tok::question) || |
| 526 | Previous.Type == TT_ConditionalExpr)) { |
| 527 | // Indent and extra 4 spaces after if we know the current expression is |
| 528 | // continued. Don't do that on the top level, as we already indent 4 |
| 529 | // there. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 530 | State.Column = State.Stack[ParenLevel].Indent + 4; |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 531 | } else if (RootToken.is(tok::kw_for) && Previous.is(tok::comma)) { |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 532 | State.Column = State.ForLoopVariablePos; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 533 | } else if (State.NextToken->Parent->ClosesTemplateDeclaration) { |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 534 | State.Column = State.Stack[ParenLevel].Indent - 4; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 535 | } else { |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 536 | State.Column = State.Stack[ParenLevel].Indent; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 537 | } |
| 538 | |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 539 | // A line starting with a closing brace is assumed to be correct for the |
| 540 | // same level as before the opening brace. |
| 541 | State.StartOfLineLevel = ParenLevel + (Current.is(tok::r_brace) ? 0 : 1); |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 542 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 543 | if (RootToken.is(tok::kw_for)) |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 544 | State.LineContainsContinuedForLoopSection = Previous.isNot(tok::semi); |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 545 | |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 546 | if (!DryRun) { |
| 547 | if (!Line.InPPDirective) |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 548 | Whitespaces.replaceWhitespace(Current, 1, State.Column, |
| 549 | WhitespaceStartColumn, Style); |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 550 | else |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 551 | Whitespaces.replacePPWhitespace(Current, 1, State.Column, |
| 552 | WhitespaceStartColumn, Style); |
Manuel Klimek | 060143e | 2013-01-02 18:33:23 +0000 | [diff] [blame] | 553 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 554 | |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 555 | State.Stack[ParenLevel].LastSpace = State.Column; |
Nico Weber | f681fa8 | 2013-01-12 07:05:25 +0000 | [diff] [blame] | 556 | if (Current.is(tok::colon) && State.NextToken->Type != TT_ConditionalExpr) |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 557 | State.Stack[ParenLevel].Indent += 2; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 558 | } else { |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 559 | if (Current.is(tok::equal) && RootToken.is(tok::kw_for)) |
| 560 | State.ForLoopVariablePos = State.Column - |
| 561 | Previous.FormatTok.TokenLength; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 562 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 563 | unsigned Spaces = State.NextToken->SpaceRequiredBefore ? 1 : 0; |
| 564 | if (State.NextToken->Type == TT_LineComment) |
Daniel Jasper | 7ad4eff | 2013-01-07 11:09:06 +0000 | [diff] [blame] | 565 | Spaces = Style.SpacesBeforeTrailingComments; |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 566 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 567 | if (!DryRun) |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 568 | Whitespaces.replaceWhitespace(Current, 0, Spaces, State.Column, Style); |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 569 | |
Daniel Jasper | 3fc0bb7 | 2013-01-09 10:40:23 +0000 | [diff] [blame] | 570 | // FIXME: Do we need to do this for assignments nested in other |
| 571 | // expressions? |
| 572 | if (RootToken.isNot(tok::kw_for) && ParenLevel == 0 && |
Daniel Jasper | 9cda800 | 2013-01-07 13:08:40 +0000 | [diff] [blame] | 573 | (getPrecedence(Previous) == prec::Assignment || |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 574 | Previous.is(tok::kw_return))) |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 575 | State.Stack[ParenLevel].Indent = State.Column + Spaces; |
Daniel Jasper | 7d19bc2 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 576 | if (Previous.is(tok::l_paren) || Previous.is(tok::l_brace) || |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 577 | State.NextToken->Parent->Type == TT_TemplateOpener) |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 578 | State.Stack[ParenLevel].Indent = State.Column + Spaces; |
Daniel Jasper | 2c6cc48 | 2013-01-17 12:53:34 +0000 | [diff] [blame] | 579 | if (Current.getPreviousNoneComment()->is(tok::comma) && |
| 580 | Current.isNot(tok::comment)) |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 581 | State.Stack[ParenLevel].HasMultiParameterLine = true; |
| 582 | |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 583 | |
Daniel Jasper | 9cda800 | 2013-01-07 13:08:40 +0000 | [diff] [blame] | 584 | // Top-level spaces that are not part of assignments are exempt as that |
| 585 | // mostly leads to better results. |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 586 | State.Column += Spaces; |
Daniel Jasper | 9cda800 | 2013-01-07 13:08:40 +0000 | [diff] [blame] | 587 | if (Spaces > 0 && |
| 588 | (ParenLevel != 0 || getPrecedence(Previous) == prec::Assignment)) |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 589 | State.Stack[ParenLevel].LastSpace = State.Column; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 590 | } |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 591 | |
| 592 | // If we break after an {, we should also break before the corresponding }. |
| 593 | if (Newline && Previous.is(tok::l_brace)) |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 594 | State.Stack.back().BreakBeforeClosingBrace = true; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 595 | |
| 596 | // If we are breaking after '(', '{', '<' or ',', we need to break after |
| 597 | // future commas as well to avoid bin packing. |
| 598 | if (!Style.BinPackParameters && Newline && |
| 599 | (Previous.is(tok::comma) || Previous.is(tok::l_paren) || |
| 600 | Previous.is(tok::l_brace) || Previous.Type == TT_TemplateOpener)) |
| 601 | State.Stack.back().BreakAfterComma = true; |
| 602 | |
Manuel Klimek | 2c7739e | 2013-01-14 16:41:43 +0000 | [diff] [blame] | 603 | moveStateToNextToken(State); |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 604 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 605 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 606 | /// \brief Mark the next token as consumed in \p State and modify its stacks |
| 607 | /// accordingly. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 608 | void moveStateToNextToken(LineState &State) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 609 | const AnnotatedToken &Current = *State.NextToken; |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 610 | assert(State.Stack.size()); |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 611 | |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 612 | if (Current.is(tok::lessless) && State.Stack.back().FirstLessLess == 0) |
| 613 | State.Stack.back().FirstLessLess = State.Column; |
Daniel Jasper | 3b5943f | 2012-12-06 09:56:08 +0000 | [diff] [blame] | 614 | |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 615 | // 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] | 616 | // prepare for the following tokens. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 617 | if (Current.is(tok::l_paren) || Current.is(tok::l_square) || |
| 618 | Current.is(tok::l_brace) || |
| 619 | State.NextToken->Type == TT_TemplateOpener) { |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 620 | unsigned NewIndent; |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 621 | if (Current.is(tok::l_brace)) { |
| 622 | // FIXME: This does not work with nested static initializers. |
| 623 | // Implement a better handling for static initializers and similar |
| 624 | // constructs. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 625 | NewIndent = Line.Level * 2 + 2; |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 626 | } else { |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 627 | NewIndent = 4 + State.Stack.back().LastSpace; |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 628 | } |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 629 | State.Stack.push_back( |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 630 | ParenState(NewIndent, State.Stack.back().LastSpace)); |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 631 | |
| 632 | // If the entire set of parameters will not fit on the current line, we |
| 633 | // will need to break after commas on this level to avoid bin-packing. |
| 634 | if (!Style.BinPackParameters && Current.MatchingParen != NULL && |
| 635 | !Current.Children.empty()) { |
| 636 | if (getColumnLimit() < State.Column + Current.FormatTok.TokenLength + |
| 637 | Current.MatchingParen->TotalLength - |
| 638 | Current.Children[0].TotalLength) { |
| 639 | State.Stack.back().BreakAfterComma = true; |
| 640 | } |
| 641 | } |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 642 | } |
| 643 | |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 644 | // 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] | 645 | // stacks. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 646 | if (Current.is(tok::r_paren) || Current.is(tok::r_square) || |
| 647 | (Current.is(tok::r_brace) && State.NextToken != &RootToken) || |
| 648 | State.NextToken->Type == TT_TemplateCloser) { |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 649 | State.Stack.pop_back(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 650 | } |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 651 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 652 | if (State.NextToken->Children.empty()) |
| 653 | State.NextToken = NULL; |
| 654 | else |
| 655 | State.NextToken = &State.NextToken->Children[0]; |
Manuel Klimek | 2851c16 | 2013-01-10 14:36:46 +0000 | [diff] [blame] | 656 | |
| 657 | State.Column += Current.FormatTok.TokenLength; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 658 | } |
| 659 | |
Nico Weber | decf7bc | 2013-01-07 15:15:29 +0000 | [diff] [blame] | 660 | /// \brief Calculate the penalty for splitting after the token at \p Index. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 661 | unsigned splitPenalty(const AnnotatedToken &Tok) { |
| 662 | const AnnotatedToken &Left = Tok; |
| 663 | const AnnotatedToken &Right = Tok.Children[0]; |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 664 | |
Manuel Klimek | 2c7739e | 2013-01-14 16:41:43 +0000 | [diff] [blame] | 665 | if (Left.is(tok::l_brace) && Right.isNot(tok::l_brace)) |
| 666 | return 50; |
| 667 | if (Left.is(tok::equal) && Right.is(tok::l_brace)) |
| 668 | return 150; |
| 669 | |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 670 | // In for-loops, prefer breaking at ',' and ';'. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 671 | if (RootToken.is(tok::kw_for) && |
| 672 | (Left.isNot(tok::comma) && Left.isNot(tok::semi))) |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 673 | return 20; |
| 674 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 675 | if (Left.is(tok::semi) || Left.is(tok::comma) || |
| 676 | Left.ClosesTemplateDeclaration) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 677 | return 0; |
Nico Weber | e8ccc81 | 2013-01-12 22:48:47 +0000 | [diff] [blame] | 678 | |
| 679 | // In Objective-C method expressions, prefer breaking before "param:" over |
| 680 | // breaking after it. |
| 681 | if (isObjCSelectorName(Right)) |
| 682 | return 0; |
| 683 | if (Right.is(tok::colon) && Right.Type == TT_ObjCMethodExpr) |
| 684 | return 20; |
| 685 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 686 | if (Left.is(tok::l_paren)) |
Daniel Jasper | 723f030 | 2013-01-02 14:40:02 +0000 | [diff] [blame] | 687 | return 20; |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 688 | |
Daniel Jasper | 9c837d0 | 2013-01-09 07:06:56 +0000 | [diff] [blame] | 689 | if (Left.is(tok::question) || Left.Type == TT_ConditionalExpr) |
| 690 | return prec::Assignment; |
Daniel Jasper | 9cda800 | 2013-01-07 13:08:40 +0000 | [diff] [blame] | 691 | prec::Level Level = getPrecedence(Left); |
| 692 | |
| 693 | // Breaking after an assignment leads to a bad result as the two sides of |
| 694 | // the assignment are visually very close together. |
| 695 | if (Level == prec::Assignment) |
| 696 | return 50; |
| 697 | |
Daniel Jasper | e2c7acf | 2012-12-24 00:13:23 +0000 | [diff] [blame] | 698 | if (Level != prec::Unknown) |
| 699 | return Level; |
| 700 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 701 | if (Right.is(tok::arrow) || Right.is(tok::period)) |
Daniel Jasper | 46a46a2 | 2013-01-07 07:13:20 +0000 | [diff] [blame] | 702 | return 150; |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 703 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 704 | return 3; |
| 705 | } |
| 706 | |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 707 | unsigned getColumnLimit() { |
| 708 | return Style.ColumnLimit - (Line.InPPDirective ? 1 : 0); |
| 709 | } |
| 710 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 711 | /// \brief Calculate the number of lines needed to format the remaining part |
| 712 | /// of the unwrapped line. |
| 713 | /// |
| 714 | /// Assumes the formatting so far has led to |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 715 | /// the \c LineSta \p State. If \p NewLine is set, a new line will be |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 716 | /// added after the previous token. |
| 717 | /// |
| 718 | /// \param StopAt is used for optimization. If we can determine that we'll |
| 719 | /// definitely need at least \p StopAt additional lines, we already know of a |
| 720 | /// better solution. |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 721 | unsigned calcPenalty(LineState State, bool NewLine, unsigned StopAt) { |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 722 | // We are at the end of the unwrapped line, so we don't need any more lines. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 723 | if (State.NextToken == NULL) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 724 | return 0; |
| 725 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 726 | if (!NewLine && State.NextToken->MustBreakBefore) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 727 | return UINT_MAX; |
Manuel Klimek | 2c7739e | 2013-01-14 16:41:43 +0000 | [diff] [blame] | 728 | if (NewLine && !State.NextToken->CanBreakBefore && |
| 729 | !(State.NextToken->is(tok::r_brace) && |
| 730 | State.Stack.back().BreakBeforeClosingBrace)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 731 | return UINT_MAX; |
Manuel Klimek | c8c8a47 | 2013-01-10 15:58:26 +0000 | [diff] [blame] | 732 | if (!NewLine && State.NextToken->is(tok::r_brace) && |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 733 | State.Stack.back().BreakBeforeClosingBrace) |
Manuel Klimek | c8c8a47 | 2013-01-10 15:58:26 +0000 | [diff] [blame] | 734 | return UINT_MAX; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 735 | if (!NewLine && State.NextToken->Parent->is(tok::semi) && |
Daniel Jasper | a324a0e | 2012-12-21 14:37:20 +0000 | [diff] [blame] | 736 | State.LineContainsContinuedForLoopSection) |
| 737 | return UINT_MAX; |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 738 | if (!NewLine && State.NextToken->Parent->is(tok::comma) && |
Daniel Jasper | 2c6cc48 | 2013-01-17 12:53:34 +0000 | [diff] [blame] | 739 | State.NextToken->isNot(tok::comment) && |
Daniel Jasper | 7e9bf8c | 2013-01-11 11:37:55 +0000 | [diff] [blame] | 740 | State.Stack.back().BreakAfterComma) |
| 741 | return UINT_MAX; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 742 | // Trying to insert a parameter on a new line if there are already more than |
| 743 | // one parameter on the current line is bin packing. |
| 744 | if (NewLine && State.NextToken->Parent->is(tok::comma) && |
| 745 | State.Stack.back().HasMultiParameterLine && !Style.BinPackParameters) |
| 746 | return UINT_MAX; |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 747 | if (!NewLine && State.NextToken->Type == TT_CtorInitializerColon) |
| 748 | return UINT_MAX; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 749 | |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 750 | unsigned CurrentPenalty = 0; |
| 751 | if (NewLine) { |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 752 | CurrentPenalty += Parameters.PenaltyIndentLevel * State.Stack.size() + |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 753 | splitPenalty(*State.NextToken->Parent); |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 754 | } else { |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 755 | if (State.Stack.size() < State.StartOfLineLevel && |
| 756 | State.NextToken->is(tok::identifier)) |
Daniel Jasper | a4974cf | 2012-12-24 16:43:00 +0000 | [diff] [blame] | 757 | CurrentPenalty += Parameters.PenaltyLevelDecrease * |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 758 | (State.StartOfLineLevel - State.Stack.size()); |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 759 | } |
| 760 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 761 | addTokenToState(NewLine, true, State); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 762 | |
Daniel Jasper | ceb99ab | 2013-01-09 10:16:05 +0000 | [diff] [blame] | 763 | // Exceeding column limit is bad, assign penalty. |
| 764 | if (State.Column > getColumnLimit()) { |
| 765 | unsigned ExcessCharacters = State.Column - getColumnLimit(); |
| 766 | CurrentPenalty += Parameters.PenaltyExcessCharacter * ExcessCharacters; |
| 767 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 768 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 769 | if (StopAt <= CurrentPenalty) |
| 770 | return UINT_MAX; |
| 771 | StopAt -= CurrentPenalty; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 772 | StateMap::iterator I = Memory.find(State); |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 773 | if (I != Memory.end()) { |
| 774 | // If this state has already been examined, we can safely return the |
| 775 | // previous result if we |
| 776 | // - have not hit the optimatization (and thus returned UINT_MAX) OR |
| 777 | // - are now computing for a smaller or equal StopAt. |
| 778 | unsigned SavedResult = I->second.first; |
| 779 | unsigned SavedStopAt = I->second.second; |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 780 | if (SavedResult != UINT_MAX) |
| 781 | return SavedResult + CurrentPenalty; |
| 782 | else if (StopAt <= SavedStopAt) |
| 783 | return UINT_MAX; |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 784 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 785 | |
| 786 | unsigned NoBreak = calcPenalty(State, false, StopAt); |
| 787 | unsigned WithBreak = calcPenalty(State, true, std::min(StopAt, NoBreak)); |
| 788 | unsigned Result = std::min(NoBreak, WithBreak); |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 789 | |
| 790 | // We have to store 'Result' without adding 'CurrentPenalty' as the latter |
| 791 | // can depend on 'NewLine'. |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 792 | Memory[State] = std::pair<unsigned, unsigned>(Result, StopAt); |
Daniel Jasper | 9a0b494 | 2012-12-17 14:34:14 +0000 | [diff] [blame] | 793 | |
| 794 | return Result == UINT_MAX ? UINT_MAX : Result + CurrentPenalty; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 795 | } |
| 796 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 797 | FormatStyle Style; |
| 798 | SourceManager &SourceMgr; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 799 | const AnnotatedLine &Line; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 800 | const unsigned FirstIndent; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 801 | const AnnotatedToken &RootToken; |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 802 | WhitespaceManager &Whitespaces; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 803 | |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 804 | // A map from an indent state to a pair (Result, Used-StopAt). |
Daniel Jasper | 604eb4c | 2013-01-11 10:22:12 +0000 | [diff] [blame] | 805 | typedef std::map<LineState, std::pair<unsigned, unsigned> > StateMap; |
Daniel Jasper | 33182dd | 2012-12-05 14:57:28 +0000 | [diff] [blame] | 806 | StateMap Memory; |
| 807 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 808 | OptimizationParameters Parameters; |
| 809 | }; |
| 810 | |
| 811 | /// \brief Determines extra information about the tokens comprising an |
| 812 | /// \c UnwrappedLine. |
| 813 | class TokenAnnotator { |
| 814 | public: |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 815 | TokenAnnotator(const FormatStyle &Style, SourceManager &SourceMgr, Lexer &Lex, |
| 816 | AnnotatedLine &Line) |
| 817 | : Style(Style), SourceMgr(SourceMgr), Lex(Lex), Line(Line) {} |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 818 | |
| 819 | /// \brief A parser that gathers additional information about tokens. |
| 820 | /// |
| 821 | /// The \c TokenAnnotator tries to matches parenthesis and square brakets and |
| 822 | /// store a parenthesis levels. It also tries to resolve matching "<" and ">" |
| 823 | /// into template parameter lists. |
| 824 | class AnnotatingParser { |
| 825 | public: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 826 | AnnotatingParser(AnnotatedToken &RootToken) |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 827 | : CurrentToken(&RootToken), KeywordVirtualFound(false), |
| 828 | ColonIsObjCMethodExpr(false) {} |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 829 | |
Nico Weber | 6a21a55 | 2013-01-18 02:43:57 +0000 | [diff] [blame] | 830 | /// \brief A helper class to manage AnnotatingParser::ColonIsObjCMethodExpr. |
| 831 | struct ObjCSelectorRAII { |
| 832 | AnnotatingParser &P; |
| 833 | bool ColonWasObjCMethodExpr; |
| 834 | |
| 835 | ObjCSelectorRAII(AnnotatingParser &P) |
| 836 | : P(P), ColonWasObjCMethodExpr(P.ColonIsObjCMethodExpr) {} |
| 837 | |
| 838 | ~ObjCSelectorRAII() { P.ColonIsObjCMethodExpr = ColonWasObjCMethodExpr; } |
| 839 | |
| 840 | void markStart(AnnotatedToken &Left) { |
| 841 | P.ColonIsObjCMethodExpr = true; |
| 842 | Left.Type = TT_ObjCMethodExpr; |
| 843 | } |
| 844 | |
| 845 | void markEnd(AnnotatedToken &Right) { Right.Type = TT_ObjCMethodExpr; } |
| 846 | }; |
| 847 | |
| 848 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 849 | bool parseAngle() { |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 850 | if (CurrentToken == NULL) |
| 851 | return false; |
| 852 | AnnotatedToken *Left = CurrentToken->Parent; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 853 | while (CurrentToken != NULL) { |
| 854 | if (CurrentToken->is(tok::greater)) { |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 855 | Left->MatchingParen = CurrentToken; |
| 856 | CurrentToken->MatchingParen = Left; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 857 | CurrentToken->Type = TT_TemplateCloser; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 858 | next(); |
| 859 | return true; |
| 860 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 861 | if (CurrentToken->is(tok::r_paren) || CurrentToken->is(tok::r_square) || |
| 862 | CurrentToken->is(tok::r_brace)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 863 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 864 | if (CurrentToken->is(tok::pipepipe) || CurrentToken->is(tok::ampamp) || |
| 865 | CurrentToken->is(tok::question) || CurrentToken->is(tok::colon)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 866 | return false; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 867 | if (!consumeToken()) |
| 868 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 869 | } |
| 870 | return false; |
| 871 | } |
| 872 | |
Nico Weber | 5096a44 | 2013-01-17 17:17:19 +0000 | [diff] [blame] | 873 | bool parseParens(bool LookForDecls = false) { |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 874 | if (CurrentToken == NULL) |
| 875 | return false; |
Nico Weber | 6a21a55 | 2013-01-18 02:43:57 +0000 | [diff] [blame] | 876 | bool StartsObjCMethodExpr = false; |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 877 | AnnotatedToken *Left = CurrentToken->Parent; |
Nico Weber | 6a21a55 | 2013-01-18 02:43:57 +0000 | [diff] [blame] | 878 | if (CurrentToken->is(tok::caret)) { |
| 879 | // ^( starts a block. |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 880 | Left->Type = TT_ObjCBlockLParen; |
Nico Weber | 6a21a55 | 2013-01-18 02:43:57 +0000 | [diff] [blame] | 881 | } else if (AnnotatedToken *MaybeSel = Left->Parent) { |
| 882 | // @selector( starts a selector. |
| 883 | if (MaybeSel->isObjCAtKeyword(tok::objc_selector) && MaybeSel->Parent && |
| 884 | MaybeSel->Parent->is(tok::at)) { |
| 885 | StartsObjCMethodExpr = true; |
| 886 | } |
| 887 | } |
| 888 | |
| 889 | ObjCSelectorRAII objCSelector(*this); |
| 890 | if (StartsObjCMethodExpr) |
| 891 | objCSelector.markStart(*Left); |
| 892 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 893 | while (CurrentToken != NULL) { |
Nico Weber | 5096a44 | 2013-01-17 17:17:19 +0000 | [diff] [blame] | 894 | // LookForDecls is set when "if (" has been seen. Check for |
| 895 | // 'identifier' '*' 'identifier' followed by not '=' -- this |
| 896 | // '*' has to be a binary operator but determineStarAmpUsage() will |
| 897 | // categorize it as an unary operator, so set the right type here. |
| 898 | if (LookForDecls && !CurrentToken->Children.empty()) { |
| 899 | AnnotatedToken &Prev = *CurrentToken->Parent; |
| 900 | AnnotatedToken &Next = CurrentToken->Children[0]; |
| 901 | if (Prev.Parent->is(tok::identifier) && |
| 902 | (Prev.is(tok::star) || Prev.is(tok::amp)) && |
| 903 | CurrentToken->is(tok::identifier) && Next.isNot(tok::equal)) { |
| 904 | Prev.Type = TT_BinaryOperator; |
| 905 | LookForDecls = false; |
| 906 | } |
| 907 | } |
| 908 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 909 | if (CurrentToken->is(tok::r_paren)) { |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 910 | Left->MatchingParen = CurrentToken; |
| 911 | CurrentToken->MatchingParen = Left; |
Nico Weber | 6a21a55 | 2013-01-18 02:43:57 +0000 | [diff] [blame] | 912 | |
| 913 | if (StartsObjCMethodExpr) |
| 914 | objCSelector.markEnd(*CurrentToken); |
| 915 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 916 | next(); |
| 917 | return true; |
| 918 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 919 | if (CurrentToken->is(tok::r_square) || CurrentToken->is(tok::r_brace)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 920 | return false; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 921 | if (!consumeToken()) |
| 922 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 923 | } |
| 924 | return false; |
| 925 | } |
| 926 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 927 | bool parseSquare() { |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 928 | if (!CurrentToken) |
| 929 | return false; |
| 930 | |
| 931 | // A '[' could be an index subscript (after an indentifier or after |
| 932 | // ')' or ']'), or it could be the start of an Objective-C method |
| 933 | // expression. |
| 934 | AnnotatedToken *LSquare = CurrentToken->Parent; |
| 935 | bool StartsObjCMethodExpr = |
| 936 | !LSquare->Parent || LSquare->Parent->is(tok::colon) || |
| 937 | LSquare->Parent->is(tok::l_square) || |
| 938 | LSquare->Parent->is(tok::l_paren) || |
| 939 | LSquare->Parent->is(tok::kw_return) || |
| 940 | LSquare->Parent->is(tok::kw_throw) || |
| 941 | getBinOpPrecedence(LSquare->Parent->FormatTok.Tok.getKind(), |
| 942 | true, true) > prec::Unknown; |
| 943 | |
Nico Weber | 6a21a55 | 2013-01-18 02:43:57 +0000 | [diff] [blame] | 944 | ObjCSelectorRAII objCSelector(*this); |
| 945 | if (StartsObjCMethodExpr) |
| 946 | objCSelector.markStart(*LSquare); |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 947 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 948 | while (CurrentToken != NULL) { |
| 949 | if (CurrentToken->is(tok::r_square)) { |
Nico Weber | 6a21a55 | 2013-01-18 02:43:57 +0000 | [diff] [blame] | 950 | if (StartsObjCMethodExpr) |
| 951 | objCSelector.markEnd(*CurrentToken); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 952 | next(); |
| 953 | return true; |
| 954 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 955 | if (CurrentToken->is(tok::r_paren) || CurrentToken->is(tok::r_brace)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 956 | return false; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 957 | if (!consumeToken()) |
| 958 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 959 | } |
| 960 | return false; |
| 961 | } |
| 962 | |
Daniel Jasper | 700e710 | 2013-01-10 09:26:47 +0000 | [diff] [blame] | 963 | bool parseBrace() { |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 964 | // Lines are fine to end with '{'. |
| 965 | if (CurrentToken == NULL) |
| 966 | return true; |
| 967 | AnnotatedToken *Left = CurrentToken->Parent; |
Daniel Jasper | 700e710 | 2013-01-10 09:26:47 +0000 | [diff] [blame] | 968 | while (CurrentToken != NULL) { |
| 969 | if (CurrentToken->is(tok::r_brace)) { |
Daniel Jasper | 0df6acd | 2013-01-16 14:59:02 +0000 | [diff] [blame] | 970 | Left->MatchingParen = CurrentToken; |
| 971 | CurrentToken->MatchingParen = Left; |
Daniel Jasper | 700e710 | 2013-01-10 09:26:47 +0000 | [diff] [blame] | 972 | next(); |
| 973 | return true; |
| 974 | } |
| 975 | if (CurrentToken->is(tok::r_paren) || CurrentToken->is(tok::r_square)) |
| 976 | return false; |
| 977 | if (!consumeToken()) |
| 978 | return false; |
| 979 | } |
Daniel Jasper | 700e710 | 2013-01-10 09:26:47 +0000 | [diff] [blame] | 980 | return true; |
| 981 | } |
| 982 | |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 983 | bool parseConditional() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 984 | while (CurrentToken != NULL) { |
| 985 | if (CurrentToken->is(tok::colon)) { |
| 986 | CurrentToken->Type = TT_ConditionalExpr; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 987 | next(); |
| 988 | return true; |
| 989 | } |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 990 | if (!consumeToken()) |
| 991 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 992 | } |
| 993 | return false; |
| 994 | } |
| 995 | |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 996 | bool parseTemplateDeclaration() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 997 | if (CurrentToken != NULL && CurrentToken->is(tok::less)) { |
| 998 | CurrentToken->Type = TT_TemplateOpener; |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 999 | next(); |
| 1000 | if (!parseAngle()) |
| 1001 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1002 | CurrentToken->Parent->ClosesTemplateDeclaration = true; |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 1003 | parseLine(); |
| 1004 | return true; |
| 1005 | } |
| 1006 | return false; |
| 1007 | } |
| 1008 | |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 1009 | bool consumeToken() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1010 | AnnotatedToken *Tok = CurrentToken; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1011 | next(); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1012 | switch (Tok->FormatTok.Tok.getKind()) { |
Nico Weber | cd52bda | 2013-01-10 23:11:41 +0000 | [diff] [blame] | 1013 | case tok::plus: |
| 1014 | case tok::minus: |
| 1015 | // At the start of the line, +/- specific ObjectiveC method |
| 1016 | // declarations. |
| 1017 | if (Tok->Parent == NULL) |
| 1018 | Tok->Type = TT_ObjCMethodSpecifier; |
| 1019 | break; |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 1020 | case tok::colon: |
| 1021 | // Colons from ?: are handled in parseConditional(). |
Daniel Jasper | 1f2b078 | 2013-01-16 16:23:19 +0000 | [diff] [blame] | 1022 | if (Tok->Parent->is(tok::r_paren)) |
| 1023 | Tok->Type = TT_CtorInitializerColon; |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 1024 | if (ColonIsObjCMethodExpr) |
| 1025 | Tok->Type = TT_ObjCMethodExpr; |
| 1026 | break; |
Nico Weber | 5096a44 | 2013-01-17 17:17:19 +0000 | [diff] [blame] | 1027 | case tok::kw_if: |
| 1028 | case tok::kw_while: |
| 1029 | if (CurrentToken->is(tok::l_paren)) { |
| 1030 | next(); |
| 1031 | if (!parseParens(/*LookForDecls=*/true)) |
| 1032 | return false; |
| 1033 | } |
| 1034 | break; |
Nico Weber | 94fb729 | 2013-01-18 05:50:57 +0000 | [diff] [blame] | 1035 | case tok::l_paren: |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 1036 | if (!parseParens()) |
| 1037 | return false; |
Nico Weber | 94fb729 | 2013-01-18 05:50:57 +0000 | [diff] [blame] | 1038 | break; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1039 | case tok::l_square: |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 1040 | if (!parseSquare()) |
| 1041 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1042 | break; |
Daniel Jasper | 700e710 | 2013-01-10 09:26:47 +0000 | [diff] [blame] | 1043 | case tok::l_brace: |
| 1044 | if (!parseBrace()) |
| 1045 | return false; |
| 1046 | break; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1047 | case tok::less: |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 1048 | if (parseAngle()) |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1049 | Tok->Type = TT_TemplateOpener; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1050 | else { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1051 | Tok->Type = TT_BinaryOperator; |
| 1052 | CurrentToken = Tok; |
| 1053 | next(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1054 | } |
| 1055 | break; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 1056 | case tok::r_paren: |
| 1057 | case tok::r_square: |
| 1058 | return false; |
Daniel Jasper | 700e710 | 2013-01-10 09:26:47 +0000 | [diff] [blame] | 1059 | case tok::r_brace: |
| 1060 | // Lines can start with '}'. |
| 1061 | if (Tok->Parent != NULL) |
| 1062 | return false; |
| 1063 | break; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1064 | case tok::greater: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1065 | Tok->Type = TT_BinaryOperator; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1066 | break; |
| 1067 | case tok::kw_operator: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1068 | if (CurrentToken->is(tok::l_paren)) { |
| 1069 | CurrentToken->Type = TT_OverloadedOperator; |
Daniel Jasper | f6aef6a | 2012-12-24 10:56:04 +0000 | [diff] [blame] | 1070 | next(); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1071 | if (CurrentToken != NULL && CurrentToken->is(tok::r_paren)) { |
| 1072 | CurrentToken->Type = TT_OverloadedOperator; |
Daniel Jasper | f6aef6a | 2012-12-24 10:56:04 +0000 | [diff] [blame] | 1073 | next(); |
| 1074 | } |
| 1075 | } else { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1076 | while (CurrentToken != NULL && CurrentToken->isNot(tok::l_paren)) { |
| 1077 | CurrentToken->Type = TT_OverloadedOperator; |
Daniel Jasper | f6aef6a | 2012-12-24 10:56:04 +0000 | [diff] [blame] | 1078 | next(); |
| 1079 | } |
| 1080 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1081 | break; |
| 1082 | case tok::question: |
Daniel Jasper | 2040915 | 2012-12-04 14:54:30 +0000 | [diff] [blame] | 1083 | parseConditional(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1084 | break; |
Daniel Jasper | 9a64fb5 | 2013-01-02 15:08:56 +0000 | [diff] [blame] | 1085 | case tok::kw_template: |
| 1086 | parseTemplateDeclaration(); |
| 1087 | break; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1088 | default: |
| 1089 | break; |
| 1090 | } |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 1091 | return true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1092 | } |
| 1093 | |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1094 | void parseIncludeDirective() { |
Manuel Klimek | 407a31a | 2013-01-15 15:50:27 +0000 | [diff] [blame] | 1095 | next(); |
| 1096 | if (CurrentToken != NULL && CurrentToken->is(tok::less)) { |
| 1097 | next(); |
| 1098 | while (CurrentToken != NULL) { |
| 1099 | CurrentToken->Type = TT_ImplicitStringLiteral; |
| 1100 | next(); |
| 1101 | } |
| 1102 | } else { |
| 1103 | while (CurrentToken != NULL) { |
| 1104 | next(); |
| 1105 | } |
| 1106 | } |
| 1107 | } |
| 1108 | |
| 1109 | void parseWarningOrError() { |
| 1110 | next(); |
| 1111 | // We still want to format the whitespace left of the first token of the |
| 1112 | // warning or error. |
| 1113 | next(); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1114 | while (CurrentToken != NULL) { |
Manuel Klimek | 407a31a | 2013-01-15 15:50:27 +0000 | [diff] [blame] | 1115 | CurrentToken->Type = TT_ImplicitStringLiteral; |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1116 | next(); |
| 1117 | } |
| 1118 | } |
| 1119 | |
| 1120 | void parsePreprocessorDirective() { |
| 1121 | next(); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1122 | if (CurrentToken == NULL) |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1123 | return; |
Manuel Klimek | f6fd00b | 2013-01-05 22:56:06 +0000 | [diff] [blame] | 1124 | // Hashes in the middle of a line can lead to any strange token |
| 1125 | // sequence. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1126 | if (CurrentToken->FormatTok.Tok.getIdentifierInfo() == NULL) |
Manuel Klimek | f6fd00b | 2013-01-05 22:56:06 +0000 | [diff] [blame] | 1127 | return; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1128 | switch ( |
| 1129 | CurrentToken->FormatTok.Tok.getIdentifierInfo()->getPPKeywordID()) { |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1130 | case tok::pp_include: |
Nico Weber | b23ae0c | 2012-12-21 18:21:56 +0000 | [diff] [blame] | 1131 | case tok::pp_import: |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1132 | parseIncludeDirective(); |
| 1133 | break; |
Manuel Klimek | 407a31a | 2013-01-15 15:50:27 +0000 | [diff] [blame] | 1134 | case tok::pp_error: |
| 1135 | case tok::pp_warning: |
| 1136 | parseWarningOrError(); |
| 1137 | break; |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1138 | default: |
| 1139 | break; |
| 1140 | } |
| 1141 | } |
| 1142 | |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1143 | LineType parseLine() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1144 | if (CurrentToken->is(tok::hash)) { |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1145 | parsePreprocessorDirective(); |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1146 | return LT_PreprocessorDirective; |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1147 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1148 | while (CurrentToken != NULL) { |
| 1149 | if (CurrentToken->is(tok::kw_virtual)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1150 | KeywordVirtualFound = true; |
Daniel Jasper | 1f42f11 | 2013-01-04 18:52:56 +0000 | [diff] [blame] | 1151 | if (!consumeToken()) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1152 | return LT_Invalid; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1153 | } |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1154 | if (KeywordVirtualFound) |
| 1155 | return LT_VirtualFunctionDecl; |
| 1156 | return LT_Other; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1157 | } |
| 1158 | |
| 1159 | void next() { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1160 | if (CurrentToken != NULL && !CurrentToken->Children.empty()) |
| 1161 | CurrentToken = &CurrentToken->Children[0]; |
| 1162 | else |
| 1163 | CurrentToken = NULL; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1164 | } |
| 1165 | |
| 1166 | private: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1167 | AnnotatedToken *CurrentToken; |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1168 | bool KeywordVirtualFound; |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 1169 | bool ColonIsObjCMethodExpr; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1170 | }; |
| 1171 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1172 | void calculateExtraInformation(AnnotatedToken &Current) { |
| 1173 | Current.SpaceRequiredBefore = spaceRequiredBefore(Current); |
| 1174 | |
Manuel Klimek | 526ed11 | 2013-01-09 15:25:02 +0000 | [diff] [blame] | 1175 | if (Current.FormatTok.MustBreakBefore) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1176 | Current.MustBreakBefore = true; |
| 1177 | } else { |
Daniel Jasper | 487f64b | 2013-01-13 16:10:20 +0000 | [diff] [blame] | 1178 | if (Current.Type == TT_LineComment) { |
| 1179 | Current.MustBreakBefore = Current.FormatTok.NewlinesBefore > 0; |
Daniel Jasper | 2c6cc48 | 2013-01-17 12:53:34 +0000 | [diff] [blame] | 1180 | } else if ((Current.Parent->is(tok::comment) && |
| 1181 | Current.FormatTok.NewlinesBefore > 0) || |
Daniel Jasper | 487f64b | 2013-01-13 16:10:20 +0000 | [diff] [blame] | 1182 | (Current.is(tok::string_literal) && |
| 1183 | Current.Parent->is(tok::string_literal))) { |
Manuel Klimek | 526ed11 | 2013-01-09 15:25:02 +0000 | [diff] [blame] | 1184 | Current.MustBreakBefore = true; |
Manuel Klimek | 526ed11 | 2013-01-09 15:25:02 +0000 | [diff] [blame] | 1185 | } else { |
| 1186 | Current.MustBreakBefore = false; |
| 1187 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1188 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1189 | Current.CanBreakBefore = Current.MustBreakBefore || canBreakBefore(Current); |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1190 | if (Current.MustBreakBefore) |
| 1191 | Current.TotalLength = Current.Parent->TotalLength + Style.ColumnLimit; |
| 1192 | else |
| 1193 | Current.TotalLength = Current.Parent->TotalLength + |
| 1194 | Current.FormatTok.TokenLength + |
| 1195 | (Current.SpaceRequiredBefore ? 1 : 0); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1196 | if (!Current.Children.empty()) |
| 1197 | calculateExtraInformation(Current.Children[0]); |
| 1198 | } |
| 1199 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1200 | void annotate() { |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1201 | AnnotatingParser Parser(Line.First); |
| 1202 | Line.Type = Parser.parseLine(); |
| 1203 | if (Line.Type == LT_Invalid) |
| 1204 | return; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1205 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1206 | determineTokenTypes(Line.First, /*IsRHS=*/false); |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1207 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1208 | if (Line.First.Type == TT_ObjCMethodSpecifier) |
| 1209 | Line.Type = LT_ObjCMethodDecl; |
| 1210 | else if (Line.First.Type == TT_ObjCDecl) |
| 1211 | Line.Type = LT_ObjCDecl; |
| 1212 | else if (Line.First.Type == TT_ObjCProperty) |
| 1213 | Line.Type = LT_ObjCProperty; |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1214 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1215 | Line.First.SpaceRequiredBefore = true; |
| 1216 | Line.First.MustBreakBefore = Line.First.FormatTok.MustBreakBefore; |
| 1217 | Line.First.CanBreakBefore = Line.First.MustBreakBefore; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1218 | |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1219 | Line.First.TotalLength = Line.First.FormatTok.TokenLength; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1220 | if (!Line.First.Children.empty()) |
| 1221 | calculateExtraInformation(Line.First.Children[0]); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1222 | } |
| 1223 | |
| 1224 | private: |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1225 | void determineTokenTypes(AnnotatedToken &Current, bool IsRHS) { |
| 1226 | if (getPrecedence(Current) == prec::Assignment || |
| 1227 | Current.is(tok::kw_return) || Current.is(tok::kw_throw)) |
| 1228 | IsRHS = true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1229 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1230 | if (Current.Type == TT_Unknown) { |
| 1231 | if (Current.is(tok::star) || Current.is(tok::amp)) { |
| 1232 | Current.Type = determineStarAmpUsage(Current, IsRHS); |
Daniel Jasper | 886568d | 2013-01-09 08:36:49 +0000 | [diff] [blame] | 1233 | } else if (Current.is(tok::minus) || Current.is(tok::plus) || |
| 1234 | Current.is(tok::caret)) { |
| 1235 | Current.Type = determinePlusMinusCaretUsage(Current); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1236 | } else if (Current.is(tok::minusminus) || Current.is(tok::plusplus)) { |
| 1237 | Current.Type = determineIncrementUsage(Current); |
| 1238 | } else if (Current.is(tok::exclaim)) { |
| 1239 | Current.Type = TT_UnaryOperator; |
| 1240 | } else if (isBinaryOperator(Current)) { |
| 1241 | Current.Type = TT_BinaryOperator; |
| 1242 | } else if (Current.is(tok::comment)) { |
| 1243 | std::string Data(Lexer::getSpelling(Current.FormatTok.Tok, SourceMgr, |
| 1244 | Lex.getLangOpts())); |
Manuel Klimek | 6cf5814 | 2013-01-07 08:54:53 +0000 | [diff] [blame] | 1245 | if (StringRef(Data).startswith("//")) |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1246 | Current.Type = TT_LineComment; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1247 | else |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1248 | Current.Type = TT_BlockComment; |
Daniel Jasper | 5cf7cf3 | 2013-01-10 11:14:08 +0000 | [diff] [blame] | 1249 | } else if (Current.is(tok::r_paren) && |
| 1250 | (Current.Parent->Type == TT_PointerOrReference || |
Daniel Jasper | 4981bd0 | 2013-01-13 08:01:36 +0000 | [diff] [blame] | 1251 | Current.Parent->Type == TT_TemplateCloser) && |
| 1252 | (Current.Children.empty() || |
| 1253 | (Current.Children[0].isNot(tok::equal) && |
| 1254 | Current.Children[0].isNot(tok::semi) && |
| 1255 | Current.Children[0].isNot(tok::l_brace)))) { |
Daniel Jasper | 5cf7cf3 | 2013-01-10 11:14:08 +0000 | [diff] [blame] | 1256 | // FIXME: We need to get smarter and understand more cases of casts. |
| 1257 | Current.Type = TT_CastRParen; |
Nico Weber | ed91bba | 2013-01-10 19:19:14 +0000 | [diff] [blame] | 1258 | } else if (Current.is(tok::at) && Current.Children.size()) { |
| 1259 | switch (Current.Children[0].FormatTok.Tok.getObjCKeywordID()) { |
| 1260 | case tok::objc_interface: |
| 1261 | case tok::objc_implementation: |
| 1262 | case tok::objc_protocol: |
| 1263 | Current.Type = TT_ObjCDecl; |
Nico Weber | 7084823 | 2013-01-10 21:30:42 +0000 | [diff] [blame] | 1264 | break; |
| 1265 | case tok::objc_property: |
| 1266 | Current.Type = TT_ObjCProperty; |
| 1267 | break; |
Nico Weber | ed91bba | 2013-01-10 19:19:14 +0000 | [diff] [blame] | 1268 | default: |
| 1269 | break; |
| 1270 | } |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1271 | } |
| 1272 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1273 | |
| 1274 | if (!Current.Children.empty()) |
| 1275 | determineTokenTypes(Current.Children[0], IsRHS); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1276 | } |
| 1277 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1278 | bool isBinaryOperator(const AnnotatedToken &Tok) { |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1279 | // Comma is a binary operator, but does not behave as such wrt. formatting. |
Daniel Jasper | cf225b6 | 2012-12-24 13:43:52 +0000 | [diff] [blame] | 1280 | return getPrecedence(Tok) > prec::Comma; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1281 | } |
| 1282 | |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1283 | /// \brief Returns the previous token ignoring comments. |
| 1284 | const AnnotatedToken *getPreviousToken(const AnnotatedToken &Tok) { |
| 1285 | const AnnotatedToken *PrevToken = Tok.Parent; |
| 1286 | while (PrevToken != NULL && PrevToken->is(tok::comment)) |
| 1287 | PrevToken = PrevToken->Parent; |
| 1288 | return PrevToken; |
| 1289 | } |
| 1290 | |
| 1291 | /// \brief Returns the next token ignoring comments. |
| 1292 | const AnnotatedToken *getNextToken(const AnnotatedToken &Tok) { |
| 1293 | if (Tok.Children.empty()) |
| 1294 | return NULL; |
| 1295 | const AnnotatedToken *NextToken = &Tok.Children[0]; |
| 1296 | while (NextToken->is(tok::comment)) { |
| 1297 | if (NextToken->Children.empty()) |
| 1298 | return NULL; |
| 1299 | NextToken = &NextToken->Children[0]; |
| 1300 | } |
| 1301 | return NextToken; |
| 1302 | } |
| 1303 | |
| 1304 | /// \brief Return the type of the given token assuming it is * or &. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1305 | TokenType determineStarAmpUsage(const AnnotatedToken &Tok, bool IsRHS) { |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1306 | const AnnotatedToken *PrevToken = getPreviousToken(Tok); |
| 1307 | if (PrevToken == NULL) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1308 | return TT_UnaryOperator; |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1309 | |
| 1310 | const AnnotatedToken *NextToken = getNextToken(Tok); |
| 1311 | if (NextToken == NULL) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1312 | return TT_Unknown; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1313 | |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1314 | if (PrevToken->is(tok::l_paren) || PrevToken->is(tok::l_square) || |
| 1315 | PrevToken->is(tok::l_brace) || PrevToken->is(tok::comma) || |
| 1316 | PrevToken->is(tok::kw_return) || PrevToken->is(tok::colon) || |
| 1317 | PrevToken->Type == TT_BinaryOperator || |
Daniel Jasper | 48bd7b7 | 2013-01-16 16:04:06 +0000 | [diff] [blame] | 1318 | PrevToken->Type == TT_UnaryOperator || PrevToken->Type == TT_CastRParen) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1319 | return TT_UnaryOperator; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1320 | |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1321 | if (PrevToken->FormatTok.Tok.isLiteral() || PrevToken->is(tok::r_paren) || |
| 1322 | PrevToken->is(tok::r_square) || NextToken->FormatTok.Tok.isLiteral() || |
| 1323 | NextToken->is(tok::plus) || NextToken->is(tok::minus) || |
| 1324 | NextToken->is(tok::plusplus) || NextToken->is(tok::minusminus) || |
| 1325 | NextToken->is(tok::tilde) || NextToken->is(tok::exclaim) || |
| 1326 | NextToken->is(tok::l_paren) || NextToken->is(tok::l_square) || |
| 1327 | NextToken->is(tok::kw_alignof) || NextToken->is(tok::kw_sizeof)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1328 | return TT_BinaryOperator; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1329 | |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1330 | if (NextToken->is(tok::comma) || NextToken->is(tok::r_paren) || |
| 1331 | NextToken->is(tok::greater)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1332 | return TT_PointerOrReference; |
Daniel Jasper | ef5b9c3 | 2013-01-02 15:46:59 +0000 | [diff] [blame] | 1333 | |
Daniel Jasper | 112fb27 | 2012-12-05 07:51:39 +0000 | [diff] [blame] | 1334 | // It is very unlikely that we are going to find a pointer or reference type |
| 1335 | // definition on the RHS of an assignment. |
Nico Weber | 00d5a04 | 2012-12-23 01:07:46 +0000 | [diff] [blame] | 1336 | if (IsRHS) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1337 | return TT_BinaryOperator; |
Daniel Jasper | 112fb27 | 2012-12-05 07:51:39 +0000 | [diff] [blame] | 1338 | |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1339 | return TT_PointerOrReference; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1340 | } |
| 1341 | |
Daniel Jasper | 886568d | 2013-01-09 08:36:49 +0000 | [diff] [blame] | 1342 | TokenType determinePlusMinusCaretUsage(const AnnotatedToken &Tok) { |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1343 | const AnnotatedToken *PrevToken = getPreviousToken(Tok); |
| 1344 | if (PrevToken == NULL) |
| 1345 | return TT_UnaryOperator; |
| 1346 | |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 1347 | // Use heuristics to recognize unary operators. |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1348 | if (PrevToken->is(tok::equal) || PrevToken->is(tok::l_paren) || |
| 1349 | PrevToken->is(tok::comma) || PrevToken->is(tok::l_square) || |
| 1350 | PrevToken->is(tok::question) || PrevToken->is(tok::colon) || |
| 1351 | PrevToken->is(tok::kw_return) || PrevToken->is(tok::kw_case) || |
| 1352 | PrevToken->is(tok::at) || PrevToken->is(tok::l_brace)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1353 | return TT_UnaryOperator; |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 1354 | |
| 1355 | // There can't be to consecutive binary operators. |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1356 | if (PrevToken->Type == TT_BinaryOperator) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1357 | return TT_UnaryOperator; |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 1358 | |
| 1359 | // Fall back to marking the token as binary operator. |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1360 | return TT_BinaryOperator; |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 1361 | } |
| 1362 | |
| 1363 | /// \brief Determine whether ++/-- are pre- or post-increments/-decrements. |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1364 | TokenType determineIncrementUsage(const AnnotatedToken &Tok) { |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1365 | const AnnotatedToken *PrevToken = getPreviousToken(Tok); |
| 1366 | if (PrevToken == NULL) |
Daniel Jasper | 4abbb53 | 2013-01-14 12:18:19 +0000 | [diff] [blame] | 1367 | return TT_UnaryOperator; |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1368 | if (PrevToken->is(tok::r_paren) || PrevToken->is(tok::r_square) || |
| 1369 | PrevToken->is(tok::identifier)) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1370 | return TT_TrailingUnaryOperator; |
Daniel Jasper | 98e6b4a | 2012-12-21 09:41:31 +0000 | [diff] [blame] | 1371 | |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1372 | return TT_UnaryOperator; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1373 | } |
| 1374 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1375 | bool spaceRequiredBetween(const AnnotatedToken &Left, |
| 1376 | const AnnotatedToken &Right) { |
Daniel Jasper | 765561f | 2013-01-08 16:17:54 +0000 | [diff] [blame] | 1377 | if (Right.is(tok::hashhash)) |
| 1378 | return Left.is(tok::hash); |
| 1379 | if (Left.is(tok::hashhash) || Left.is(tok::hash)) |
| 1380 | return Right.is(tok::hash); |
Daniel Jasper | 8b39c66 | 2012-12-10 18:59:13 +0000 | [diff] [blame] | 1381 | if (Right.is(tok::r_paren) || Right.is(tok::semi) || Right.is(tok::comma)) |
| 1382 | return false; |
Nico Weber | 5f500df | 2013-01-10 20:12:55 +0000 | [diff] [blame] | 1383 | if (Right.is(tok::less) && |
| 1384 | (Left.is(tok::kw_template) || |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1385 | (Line.Type == LT_ObjCDecl && Style.ObjCSpaceBeforeProtocolList))) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1386 | return true; |
| 1387 | if (Left.is(tok::arrow) || Right.is(tok::arrow)) |
| 1388 | return false; |
| 1389 | if (Left.is(tok::exclaim) || Left.is(tok::tilde)) |
| 1390 | return false; |
Nico Weber | cb4d690 | 2013-01-08 19:40:21 +0000 | [diff] [blame] | 1391 | if (Left.is(tok::at) && |
| 1392 | (Right.is(tok::identifier) || Right.is(tok::string_literal) || |
| 1393 | Right.is(tok::char_constant) || Right.is(tok::numeric_constant) || |
Daniel Jasper | 46ef852 | 2013-01-10 13:08:12 +0000 | [diff] [blame] | 1394 | Right.is(tok::l_paren) || Right.is(tok::l_brace) || |
| 1395 | Right.is(tok::kw_true) || Right.is(tok::kw_false))) |
Fariborz Jahanian | 154120c | 2012-12-20 19:54:13 +0000 | [diff] [blame] | 1396 | return false; |
Daniel Jasper | 6b825c2 | 2013-01-16 07:19:28 +0000 | [diff] [blame] | 1397 | if (Left.is(tok::coloncolon)) |
| 1398 | return false; |
| 1399 | if (Right.is(tok::coloncolon)) |
| 1400 | return Left.isNot(tok::identifier) && Left.isNot(tok::greater); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1401 | if (Left.is(tok::less) || Right.is(tok::greater) || Right.is(tok::less)) |
| 1402 | return false; |
Daniel Jasper | c74e279 | 2012-12-07 09:52:15 +0000 | [diff] [blame] | 1403 | if (Right.is(tok::amp) || Right.is(tok::star)) |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1404 | return Left.FormatTok.Tok.isLiteral() || |
Daniel Jasper | d7610b8 | 2012-12-24 16:51:15 +0000 | [diff] [blame] | 1405 | (Left.isNot(tok::star) && Left.isNot(tok::amp) && |
| 1406 | !Style.PointerAndReferenceBindToType); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1407 | if (Left.is(tok::amp) || Left.is(tok::star)) |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1408 | return Right.FormatTok.Tok.isLiteral() || |
| 1409 | Style.PointerAndReferenceBindToType; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1410 | if (Right.is(tok::star) && Left.is(tok::l_paren)) |
| 1411 | return false; |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 1412 | if (Left.is(tok::l_square) || Right.is(tok::r_square)) |
| 1413 | return false; |
| 1414 | if (Right.is(tok::l_square) && Right.Type != TT_ObjCMethodExpr) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1415 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1416 | if (Left.is(tok::period) || Right.is(tok::period)) |
| 1417 | return false; |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 1418 | if (Left.is(tok::colon)) |
| 1419 | return Left.Type != TT_ObjCMethodExpr; |
| 1420 | if (Right.is(tok::colon)) |
| 1421 | return Right.Type != TT_ObjCMethodExpr; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1422 | if (Left.is(tok::l_paren)) |
| 1423 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1424 | if (Right.is(tok::l_paren)) { |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1425 | return Line.Type == LT_ObjCDecl || Left.is(tok::kw_if) || |
Nico Weber | ed91bba | 2013-01-10 19:19:14 +0000 | [diff] [blame] | 1426 | Left.is(tok::kw_for) || Left.is(tok::kw_while) || |
Daniel Jasper | 7d19bc2 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 1427 | Left.is(tok::kw_switch) || Left.is(tok::kw_return) || |
Daniel Jasper | 088dab5 | 2013-01-11 16:09:04 +0000 | [diff] [blame] | 1428 | Left.is(tok::kw_catch) || Left.is(tok::kw_new) || |
| 1429 | Left.is(tok::kw_delete); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1430 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1431 | if (Left.is(tok::at) && |
| 1432 | Right.FormatTok.Tok.getObjCKeywordID() != tok::objc_not_keyword) |
Nico Weber | d0af4b4 | 2013-01-07 16:14:28 +0000 | [diff] [blame] | 1433 | return false; |
Manuel Klimek | 36fab8d | 2013-01-10 13:24:24 +0000 | [diff] [blame] | 1434 | if (Left.is(tok::l_brace) && Right.is(tok::r_brace)) |
| 1435 | return false; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1436 | return true; |
| 1437 | } |
| 1438 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1439 | bool spaceRequiredBefore(const AnnotatedToken &Tok) { |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1440 | if (Line.Type == LT_ObjCMethodDecl) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1441 | if (Tok.is(tok::identifier) && !Tok.Children.empty() && |
| 1442 | Tok.Children[0].is(tok::colon) && Tok.Parent->is(tok::identifier)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1443 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1444 | if (Tok.is(tok::colon)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1445 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1446 | if (Tok.Parent->Type == TT_ObjCMethodSpecifier) |
Nico Weber | aab6005 | 2013-01-17 06:14:50 +0000 | [diff] [blame] | 1447 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1448 | if (Tok.Parent->is(tok::r_paren) && Tok.is(tok::identifier)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1449 | // Don't space between ')' and <id> |
| 1450 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1451 | if (Tok.Parent->is(tok::colon) && Tok.is(tok::l_paren)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1452 | // Don't space between ':' and '(' |
| 1453 | return false; |
| 1454 | } |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1455 | if (Line.Type == LT_ObjCProperty && |
Nico Weber | 7084823 | 2013-01-10 21:30:42 +0000 | [diff] [blame] | 1456 | (Tok.is(tok::equal) || Tok.Parent->is(tok::equal))) |
| 1457 | return false; |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1458 | |
Daniel Jasper | 4e9008a | 2013-01-13 08:19:51 +0000 | [diff] [blame] | 1459 | if (Tok.Parent->is(tok::comma)) |
| 1460 | return true; |
Daniel Jasper | 46ef852 | 2013-01-10 13:08:12 +0000 | [diff] [blame] | 1461 | if (Tok.Type == TT_CtorInitializerColon || Tok.Type == TT_ObjCBlockLParen) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1462 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1463 | if (Tok.Type == TT_OverloadedOperator) |
| 1464 | return Tok.is(tok::identifier) || Tok.is(tok::kw_new) || |
Daniel Jasper | 46ef852 | 2013-01-10 13:08:12 +0000 | [diff] [blame] | 1465 | Tok.is(tok::kw_delete) || Tok.is(tok::kw_bool); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1466 | if (Tok.Parent->Type == TT_OverloadedOperator) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1467 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1468 | if (Tok.is(tok::colon)) |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1469 | return Line.First.isNot(tok::kw_case) && !Tok.Children.empty() && |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 1470 | Tok.Type != TT_ObjCMethodExpr; |
Daniel Jasper | 5cf7cf3 | 2013-01-10 11:14:08 +0000 | [diff] [blame] | 1471 | if (Tok.Parent->Type == TT_UnaryOperator || |
| 1472 | Tok.Parent->Type == TT_CastRParen) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1473 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1474 | if (Tok.Type == TT_UnaryOperator) |
| 1475 | return Tok.Parent->isNot(tok::l_paren) && |
Nico Weber | cd45833 | 2013-01-12 23:48:49 +0000 | [diff] [blame] | 1476 | Tok.Parent->isNot(tok::l_square) && Tok.Parent->isNot(tok::at) && |
| 1477 | (Tok.Parent->isNot(tok::colon) || |
| 1478 | Tok.Parent->Type != TT_ObjCMethodExpr); |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1479 | if (Tok.Parent->is(tok::greater) && Tok.is(tok::greater)) { |
| 1480 | return Tok.Type == TT_TemplateCloser && Tok.Parent->Type == |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1481 | TT_TemplateCloser && Style.SplitTemplateClosingGreater; |
| 1482 | } |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1483 | if (Tok.Type == TT_BinaryOperator || Tok.Parent->Type == TT_BinaryOperator) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1484 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1485 | if (Tok.Parent->Type == TT_TemplateCloser && Tok.is(tok::l_paren)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1486 | return false; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1487 | if (Tok.is(tok::less) && Line.First.is(tok::hash)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1488 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1489 | if (Tok.Type == TT_TrailingUnaryOperator) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1490 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1491 | return spaceRequiredBetween(*Tok.Parent, Tok); |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1492 | } |
| 1493 | |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1494 | bool canBreakBefore(const AnnotatedToken &Right) { |
| 1495 | const AnnotatedToken &Left = *Right.Parent; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1496 | if (Line.Type == LT_ObjCMethodDecl) { |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1497 | if (Right.is(tok::identifier) && !Right.Children.empty() && |
| 1498 | Right.Children[0].is(tok::colon) && Left.is(tok::identifier)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1499 | return true; |
Nico Weber | 774b973 | 2013-01-12 07:00:16 +0000 | [diff] [blame] | 1500 | if (Right.is(tok::identifier) && Left.is(tok::l_paren) && |
| 1501 | Left.Parent->is(tok::colon)) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1502 | // Don't break this identifier as ':' or identifier |
| 1503 | // before it will break. |
| 1504 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1505 | if (Right.is(tok::colon) && Left.is(tok::identifier) && |
| 1506 | Left.CanBreakBefore) |
Daniel Jasper | da92771 | 2013-01-07 15:36:15 +0000 | [diff] [blame] | 1507 | // Don't break at ':' if identifier before it can beak. |
| 1508 | return false; |
| 1509 | } |
Nico Weber | bcfdd26 | 2013-01-12 06:18:40 +0000 | [diff] [blame] | 1510 | if (Right.is(tok::colon) && Right.Type == TT_ObjCMethodExpr) |
| 1511 | return false; |
| 1512 | if (Left.is(tok::colon) && Left.Type == TT_ObjCMethodExpr) |
| 1513 | return true; |
Nico Weber | e8ccc81 | 2013-01-12 22:48:47 +0000 | [diff] [blame] | 1514 | if (isObjCSelectorName(Right)) |
| 1515 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1516 | if (Left.ClosesTemplateDeclaration) |
Daniel Jasper | 5eda31e | 2013-01-02 18:30:06 +0000 | [diff] [blame] | 1517 | return true; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1518 | if (Left.Type == TT_PointerOrReference || Left.Type == TT_TemplateCloser || |
Daniel Jasper | 2db356d | 2013-01-08 20:03:18 +0000 | [diff] [blame] | 1519 | Left.Type == TT_UnaryOperator || Right.Type == TT_ConditionalExpr) |
Daniel Jasper | 4dc41de | 2013-01-02 08:44:14 +0000 | [diff] [blame] | 1520 | return false; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1521 | if (Left.is(tok::equal) && Line.Type == LT_VirtualFunctionDecl) |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1522 | return false; |
| 1523 | |
Daniel Jasper | 2c6cc48 | 2013-01-17 12:53:34 +0000 | [diff] [blame] | 1524 | if (Right.Type == TT_LineComment) |
Daniel Jasper | 487f64b | 2013-01-13 16:10:20 +0000 | [diff] [blame] | 1525 | // We rely on MustBreakBefore being set correctly here as we should not |
| 1526 | // change the "binding" behavior of a comment. |
| 1527 | return false; |
| 1528 | |
Daniel Jasper | 60ca75d | 2013-01-17 13:31:52 +0000 | [diff] [blame] | 1529 | // Allow breaking after a trailing 'const', e.g. after a method declaration, |
| 1530 | // unless it is follow by ';', '{' or '='. |
| 1531 | if (Left.is(tok::kw_const) && Left.Parent != NULL && |
| 1532 | Left.Parent->is(tok::r_paren)) |
| 1533 | return Right.isNot(tok::l_brace) && Right.isNot(tok::semi) && |
| 1534 | Right.isNot(tok::equal); |
| 1535 | |
Manuel Klimek | 2c7739e | 2013-01-14 16:41:43 +0000 | [diff] [blame] | 1536 | // We only break before r_brace if there was a corresponding break before |
| 1537 | // the l_brace, which is tracked by BreakBeforeClosingBrace. |
| 1538 | if (Right.is(tok::r_brace)) |
| 1539 | return false; |
| 1540 | |
Daniel Jasper | b369c2c | 2013-01-15 14:27:39 +0000 | [diff] [blame] | 1541 | if (Right.is(tok::r_paren) || Right.is(tok::greater)) |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1542 | return false; |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1543 | return (isBinaryOperator(Left) && Left.isNot(tok::lessless)) || |
| 1544 | Left.is(tok::comma) || Right.is(tok::lessless) || |
| 1545 | Right.is(tok::arrow) || Right.is(tok::period) || |
| 1546 | Right.is(tok::colon) || Left.is(tok::semi) || |
Manuel Klimek | 2c7739e | 2013-01-14 16:41:43 +0000 | [diff] [blame] | 1547 | Left.is(tok::l_brace) || Left.is(tok::question) || Left.Type == |
| 1548 | TT_ConditionalExpr || (Left.is(tok::r_paren) && Left.Type != |
| 1549 | TT_CastRParen && Right.is(tok::identifier)) || |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1550 | (Left.is(tok::l_paren) && !Right.is(tok::r_paren)); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1551 | } |
| 1552 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1553 | FormatStyle Style; |
| 1554 | SourceManager &SourceMgr; |
Manuel Klimek | 6cf5814 | 2013-01-07 08:54:53 +0000 | [diff] [blame] | 1555 | Lexer &Lex; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1556 | AnnotatedLine &Line; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1557 | }; |
| 1558 | |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1559 | class LexerBasedFormatTokenSource : public FormatTokenSource { |
| 1560 | public: |
| 1561 | LexerBasedFormatTokenSource(Lexer &Lex, SourceManager &SourceMgr) |
Daniel Jasper | 1321eb5 | 2012-12-18 21:05:13 +0000 | [diff] [blame] | 1562 | : GreaterStashed(false), Lex(Lex), SourceMgr(SourceMgr), |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1563 | IdentTable(Lex.getLangOpts()) { |
| 1564 | Lex.SetKeepWhitespaceMode(true); |
| 1565 | } |
| 1566 | |
| 1567 | virtual FormatToken getNextToken() { |
| 1568 | if (GreaterStashed) { |
| 1569 | FormatTok.NewlinesBefore = 0; |
| 1570 | FormatTok.WhiteSpaceStart = |
| 1571 | FormatTok.Tok.getLocation().getLocWithOffset(1); |
| 1572 | FormatTok.WhiteSpaceLength = 0; |
| 1573 | GreaterStashed = false; |
| 1574 | return FormatTok; |
| 1575 | } |
| 1576 | |
| 1577 | FormatTok = FormatToken(); |
| 1578 | Lex.LexFromRawLexer(FormatTok.Tok); |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1579 | StringRef Text = rawTokenText(FormatTok.Tok); |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1580 | FormatTok.WhiteSpaceStart = FormatTok.Tok.getLocation(); |
Manuel Klimek | f6fd00b | 2013-01-05 22:56:06 +0000 | [diff] [blame] | 1581 | if (SourceMgr.getFileOffset(FormatTok.WhiteSpaceStart) == 0) |
| 1582 | FormatTok.IsFirst = true; |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1583 | |
| 1584 | // Consume and record whitespace until we find a significant token. |
| 1585 | while (FormatTok.Tok.is(tok::unknown)) { |
Manuel Klimek | a080a18 | 2013-01-02 16:30:12 +0000 | [diff] [blame] | 1586 | FormatTok.NewlinesBefore += Text.count('\n'); |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1587 | FormatTok.HasUnescapedNewline = Text.count("\\\n") != |
| 1588 | FormatTok.NewlinesBefore; |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1589 | FormatTok.WhiteSpaceLength += FormatTok.Tok.getLength(); |
| 1590 | |
| 1591 | if (FormatTok.Tok.is(tok::eof)) |
| 1592 | return FormatTok; |
| 1593 | Lex.LexFromRawLexer(FormatTok.Tok); |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1594 | Text = rawTokenText(FormatTok.Tok); |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1595 | } |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1596 | |
| 1597 | // Now FormatTok is the next non-whitespace token. |
| 1598 | FormatTok.TokenLength = Text.size(); |
| 1599 | |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1600 | // In case the token starts with escaped newlines, we want to |
| 1601 | // take them into account as whitespace - this pattern is quite frequent |
| 1602 | // in macro definitions. |
| 1603 | // FIXME: What do we want to do with other escaped spaces, and escaped |
| 1604 | // spaces or newlines in the middle of tokens? |
| 1605 | // FIXME: Add a more explicit test. |
| 1606 | unsigned i = 0; |
Daniel Jasper | 7160751 | 2013-01-07 10:48:50 +0000 | [diff] [blame] | 1607 | while (i + 1 < Text.size() && Text[i] == '\\' && Text[i + 1] == '\n') { |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1608 | FormatTok.WhiteSpaceLength += 2; |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1609 | FormatTok.TokenLength -= 2; |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1610 | i += 2; |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1611 | } |
| 1612 | |
| 1613 | if (FormatTok.Tok.is(tok::raw_identifier)) { |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1614 | IdentifierInfo &Info = IdentTable.get(Text); |
Daniel Jasper | cd1a32b | 2012-12-21 17:58:39 +0000 | [diff] [blame] | 1615 | FormatTok.Tok.setIdentifierInfo(&Info); |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1616 | FormatTok.Tok.setKind(Info.getTokenID()); |
| 1617 | } |
| 1618 | |
| 1619 | if (FormatTok.Tok.is(tok::greatergreater)) { |
| 1620 | FormatTok.Tok.setKind(tok::greater); |
| 1621 | GreaterStashed = true; |
| 1622 | } |
| 1623 | |
| 1624 | return FormatTok; |
| 1625 | } |
| 1626 | |
| 1627 | private: |
| 1628 | FormatToken FormatTok; |
| 1629 | bool GreaterStashed; |
| 1630 | Lexer &Lex; |
| 1631 | SourceManager &SourceMgr; |
| 1632 | IdentifierTable IdentTable; |
| 1633 | |
| 1634 | /// Returns the text of \c FormatTok. |
Manuel Klimek | 9541938 | 2013-01-07 07:56:50 +0000 | [diff] [blame] | 1635 | StringRef rawTokenText(Token &Tok) { |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1636 | return StringRef(SourceMgr.getCharacterData(Tok.getLocation()), |
| 1637 | Tok.getLength()); |
| 1638 | } |
| 1639 | }; |
| 1640 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1641 | class Formatter : public UnwrappedLineConsumer { |
| 1642 | public: |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1643 | Formatter(DiagnosticsEngine &Diag, const FormatStyle &Style, Lexer &Lex, |
| 1644 | SourceManager &SourceMgr, |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1645 | const std::vector<CharSourceRange> &Ranges) |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1646 | : Diag(Diag), Style(Style), Lex(Lex), SourceMgr(SourceMgr), |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 1647 | Whitespaces(SourceMgr), Ranges(Ranges) {} |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1648 | |
Daniel Jasper | 7d19bc2 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 1649 | virtual ~Formatter() {} |
Daniel Jasper | accb0b0 | 2012-12-04 21:05:31 +0000 | [diff] [blame] | 1650 | |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1651 | tooling::Replacements format() { |
Alexander Kornienko | 469a21b | 2012-12-07 16:15:44 +0000 | [diff] [blame] | 1652 | LexerBasedFormatTokenSource Tokens(Lex, SourceMgr); |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1653 | UnwrappedLineParser Parser(Diag, Style, Tokens, *this); |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1654 | StructuralError = Parser.parse(); |
Manuel Klimek | d4397b9 | 2013-01-04 23:34:14 +0000 | [diff] [blame] | 1655 | unsigned PreviousEndOfLineColumn = 0; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1656 | for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) { |
| 1657 | TokenAnnotator Annotator(Style, SourceMgr, Lex, AnnotatedLines[i]); |
| 1658 | Annotator.annotate(); |
| 1659 | } |
| 1660 | for (std::vector<AnnotatedLine>::iterator I = AnnotatedLines.begin(), |
| 1661 | E = AnnotatedLines.end(); |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1662 | I != E; ++I) { |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1663 | const AnnotatedLine &TheLine = *I; |
| 1664 | if (touchesRanges(TheLine) && TheLine.Type != LT_Invalid) { |
| 1665 | unsigned Indent = formatFirstToken(TheLine.First, TheLine.Level, |
| 1666 | TheLine.InPPDirective, |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1667 | PreviousEndOfLineColumn); |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1668 | tryFitMultipleLinesInOne(Indent, I, E); |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1669 | UnwrappedLineFormatter Formatter(Style, SourceMgr, TheLine, Indent, |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 1670 | TheLine.First, Whitespaces, |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1671 | StructuralError); |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1672 | PreviousEndOfLineColumn = Formatter.format(); |
| 1673 | } else { |
| 1674 | // If we did not reformat this unwrapped line, the column at the end of |
| 1675 | // the last token is unchanged - thus, we can calculate the end of the |
| 1676 | // last token, and return the result. |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1677 | PreviousEndOfLineColumn = |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1678 | SourceMgr.getSpellingColumnNumber( |
| 1679 | TheLine.Last->FormatTok.Tok.getLocation()) + |
| 1680 | Lex.MeasureTokenLength(TheLine.Last->FormatTok.Tok.getLocation(), |
| 1681 | SourceMgr, Lex.getLangOpts()) - |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1682 | 1; |
| 1683 | } |
| 1684 | } |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 1685 | return Whitespaces.generateReplacements(); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1686 | } |
| 1687 | |
| 1688 | private: |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1689 | /// \brief Tries to merge lines into one. |
| 1690 | /// |
| 1691 | /// This will change \c Line and \c AnnotatedLine to contain the merged line, |
| 1692 | /// if possible; note that \c I will be incremented when lines are merged. |
| 1693 | /// |
| 1694 | /// Returns whether the resulting \c Line can fit in a single line. |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1695 | void tryFitMultipleLinesInOne(unsigned Indent, |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1696 | std::vector<AnnotatedLine>::iterator &I, |
| 1697 | std::vector<AnnotatedLine>::iterator E) { |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1698 | unsigned Limit = Style.ColumnLimit - (I->InPPDirective ? 1 : 0) - Indent; |
| 1699 | |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1700 | // We can never merge stuff if there are trailing line comments. |
| 1701 | if (I->Last->Type == TT_LineComment) |
| 1702 | return; |
| 1703 | |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1704 | // Check whether the UnwrappedLine can be put onto a single line. If |
| 1705 | // so, this is bound to be the optimal solution (by definition) and we |
| 1706 | // don't need to analyze the entire solution space. |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1707 | if (I->Last->TotalLength >= Limit) |
| 1708 | return; |
| 1709 | Limit -= I->Last->TotalLength + 1; // One space. |
Daniel Jasper | 55b08e7 | 2013-01-16 07:02:34 +0000 | [diff] [blame] | 1710 | |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1711 | if (I + 1 == E) |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1712 | return; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1713 | |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1714 | if (I->Last->is(tok::l_brace)) { |
| 1715 | tryMergeSimpleBlock(I, E, Limit); |
| 1716 | } else if (I->First.is(tok::kw_if)) { |
| 1717 | tryMergeSimpleIf(I, E, Limit); |
Daniel Jasper | e0b15ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1718 | } else if (I->InPPDirective && (I->First.FormatTok.HasUnescapedNewline || |
| 1719 | I->First.FormatTok.IsFirst)) { |
| 1720 | tryMergeSimplePPDirective(I, E, Limit); |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1721 | } |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1722 | return; |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1723 | } |
| 1724 | |
Daniel Jasper | e0b15ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1725 | void tryMergeSimplePPDirective(std::vector<AnnotatedLine>::iterator &I, |
| 1726 | std::vector<AnnotatedLine>::iterator E, |
| 1727 | unsigned Limit) { |
| 1728 | AnnotatedLine &Line = *I; |
Daniel Jasper | 2b9c10b | 2013-01-14 15:52:06 +0000 | [diff] [blame] | 1729 | if (!(I + 1)->InPPDirective || (I + 1)->First.FormatTok.HasUnescapedNewline) |
| 1730 | return; |
Daniel Jasper | e0b15ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1731 | if (I + 2 != E && (I + 2)->InPPDirective && |
| 1732 | !(I + 2)->First.FormatTok.HasUnescapedNewline) |
| 1733 | return; |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1734 | if ((I + 1)->Last->TotalLength > Limit) |
| 1735 | return; |
Daniel Jasper | e0b15ea | 2013-01-14 15:40:57 +0000 | [diff] [blame] | 1736 | join(Line, *(++I)); |
| 1737 | } |
| 1738 | |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1739 | void tryMergeSimpleIf(std::vector<AnnotatedLine>::iterator &I, |
| 1740 | std::vector<AnnotatedLine>::iterator E, |
| 1741 | unsigned Limit) { |
Daniel Jasper | 6f5bb2c | 2013-01-14 16:24:39 +0000 | [diff] [blame] | 1742 | if (!Style.AllowShortIfStatementsOnASingleLine) |
| 1743 | return; |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1744 | AnnotatedLine &Line = *I; |
Daniel Jasper | 55b08e7 | 2013-01-16 07:02:34 +0000 | [diff] [blame] | 1745 | if (Line.Last->isNot(tok::r_paren)) |
| 1746 | return; |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1747 | if ((I + 1)->Last->TotalLength > Limit) |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1748 | return; |
| 1749 | if ((I + 1)->First.is(tok::kw_if) || (I + 1)->First.Type == TT_LineComment) |
| 1750 | return; |
| 1751 | // Only inline simple if's (no nested if or else). |
| 1752 | if (I + 2 != E && (I + 2)->First.is(tok::kw_else)) |
| 1753 | return; |
| 1754 | join(Line, *(++I)); |
| 1755 | } |
| 1756 | |
| 1757 | void tryMergeSimpleBlock(std::vector<AnnotatedLine>::iterator &I, |
| 1758 | std::vector<AnnotatedLine>::iterator E, |
| 1759 | unsigned Limit){ |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1760 | // Check that we still have three lines and they fit into the limit. |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1761 | if (I + 2 == E || !nextTwoLinesFitInto(I, Limit)) |
| 1762 | return; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1763 | |
| 1764 | // First, check that the current line allows merging. This is the case if |
| 1765 | // we're not in a control flow statement and the last token is an opening |
| 1766 | // brace. |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1767 | AnnotatedLine &Line = *I; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1768 | bool AllowedTokens = |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1769 | Line.First.isNot(tok::kw_if) && Line.First.isNot(tok::kw_while) && |
| 1770 | Line.First.isNot(tok::kw_do) && Line.First.isNot(tok::r_brace) && |
| 1771 | Line.First.isNot(tok::kw_else) && Line.First.isNot(tok::kw_try) && |
| 1772 | Line.First.isNot(tok::kw_catch) && Line.First.isNot(tok::kw_for) && |
Nico Weber | 67015ed | 2013-01-11 21:14:08 +0000 | [diff] [blame] | 1773 | // This gets rid of all ObjC @ keywords and methods. |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1774 | Line.First.isNot(tok::at) && Line.First.isNot(tok::minus) && |
| 1775 | Line.First.isNot(tok::plus); |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1776 | if (!AllowedTokens) |
| 1777 | return; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1778 | |
| 1779 | // Second, check that the next line does not contain any braces - if it |
| 1780 | // does, readability declines when putting it into a single line. |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1781 | const AnnotatedToken *Tok = &(I + 1)->First; |
| 1782 | if ((I + 1)->Last->Type == TT_LineComment || Tok->MustBreakBefore) |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1783 | return; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1784 | do { |
| 1785 | if (Tok->is(tok::l_brace) || Tok->is(tok::r_brace)) |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1786 | return; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1787 | Tok = Tok->Children.empty() ? NULL : &Tok->Children.back(); |
| 1788 | } while (Tok != NULL); |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1789 | |
| 1790 | // Last, check that the third line contains a single closing brace. |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1791 | Tok = &(I + 2)->First; |
| 1792 | if (!Tok->Children.empty() || Tok->isNot(tok::r_brace) || |
| 1793 | Tok->MustBreakBefore) |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1794 | return; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1795 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1796 | // If the merged line fits, we use that instead and skip the next two lines. |
| 1797 | Line.Last->Children.push_back((I + 1)->First); |
| 1798 | while (!Line.Last->Children.empty()) { |
| 1799 | Line.Last->Children[0].Parent = Line.Last; |
| 1800 | Line.Last = &Line.Last->Children[0]; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1801 | } |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1802 | |
| 1803 | join(Line, *(I + 1)); |
| 1804 | join(Line, *(I + 2)); |
| 1805 | I += 2; |
Daniel Jasper | feb18f5 | 2013-01-14 14:14:23 +0000 | [diff] [blame] | 1806 | } |
| 1807 | |
| 1808 | bool nextTwoLinesFitInto(std::vector<AnnotatedLine>::iterator I, |
| 1809 | unsigned Limit) { |
Daniel Jasper | 3f8cdbf | 2013-01-16 10:41:46 +0000 | [diff] [blame] | 1810 | return (I + 1)->Last->TotalLength + 1 + (I + 2)->Last->TotalLength <= Limit; |
Manuel Klimek | 517e894 | 2013-01-11 17:54:10 +0000 | [diff] [blame] | 1811 | } |
| 1812 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1813 | void join(AnnotatedLine &A, const AnnotatedLine &B) { |
| 1814 | A.Last->Children.push_back(B.First); |
| 1815 | while (!A.Last->Children.empty()) { |
| 1816 | A.Last->Children[0].Parent = A.Last; |
| 1817 | A.Last = &A.Last->Children[0]; |
| 1818 | } |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1819 | } |
| 1820 | |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1821 | bool touchesRanges(const AnnotatedLine &TheLine) { |
| 1822 | const FormatToken *First = &TheLine.First.FormatTok; |
| 1823 | const FormatToken *Last = &TheLine.Last->FormatTok; |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1824 | CharSourceRange LineRange = CharSourceRange::getTokenRange( |
Daniel Jasper | 26f7e78 | 2013-01-08 14:56:18 +0000 | [diff] [blame] | 1825 | First->Tok.getLocation(), |
| 1826 | Last->Tok.getLocation()); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1827 | for (unsigned i = 0, e = Ranges.size(); i != e; ++i) { |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1828 | if (!SourceMgr.isBeforeInTranslationUnit(LineRange.getEnd(), |
| 1829 | Ranges[i].getBegin()) && |
| 1830 | !SourceMgr.isBeforeInTranslationUnit(Ranges[i].getEnd(), |
| 1831 | LineRange.getBegin())) |
| 1832 | return true; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1833 | } |
Manuel Klimek | f9ea2ed | 2013-01-10 19:49:59 +0000 | [diff] [blame] | 1834 | return false; |
| 1835 | } |
| 1836 | |
| 1837 | virtual void consumeUnwrappedLine(const UnwrappedLine &TheLine) { |
Daniel Jasper | cbb6c41 | 2013-01-16 09:10:19 +0000 | [diff] [blame] | 1838 | AnnotatedLines.push_back(AnnotatedLine(TheLine)); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1839 | } |
| 1840 | |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1841 | /// \brief Add a new line and the required indent before the first Token |
| 1842 | /// of the \c UnwrappedLine if there was no structural parsing error. |
| 1843 | /// Returns the indent level of the \c UnwrappedLine. |
| 1844 | unsigned formatFirstToken(const AnnotatedToken &RootToken, unsigned Level, |
| 1845 | bool InPPDirective, |
| 1846 | unsigned PreviousEndOfLineColumn) { |
Daniel Jasper | 7d19bc2 | 2013-01-11 14:23:32 +0000 | [diff] [blame] | 1847 | const FormatToken &Tok = RootToken.FormatTok; |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1848 | if (!Tok.WhiteSpaceStart.isValid() || StructuralError) |
| 1849 | return SourceMgr.getSpellingColumnNumber(Tok.Tok.getLocation()) - 1; |
| 1850 | |
| 1851 | unsigned Newlines = std::min(Tok.NewlinesBefore, |
| 1852 | Style.MaxEmptyLinesToKeep + 1); |
| 1853 | if (Newlines == 0 && !Tok.IsFirst) |
| 1854 | Newlines = 1; |
| 1855 | unsigned Indent = Level * 2; |
| 1856 | |
| 1857 | bool IsAccessModifier = false; |
| 1858 | if (RootToken.is(tok::kw_public) || RootToken.is(tok::kw_protected) || |
| 1859 | RootToken.is(tok::kw_private)) |
| 1860 | IsAccessModifier = true; |
| 1861 | else if (RootToken.is(tok::at) && !RootToken.Children.empty() && |
| 1862 | (RootToken.Children[0].isObjCAtKeyword(tok::objc_public) || |
| 1863 | RootToken.Children[0].isObjCAtKeyword(tok::objc_protected) || |
| 1864 | RootToken.Children[0].isObjCAtKeyword(tok::objc_package) || |
| 1865 | RootToken.Children[0].isObjCAtKeyword(tok::objc_private))) |
| 1866 | IsAccessModifier = true; |
| 1867 | |
| 1868 | if (IsAccessModifier && |
| 1869 | static_cast<int>(Indent) + Style.AccessModifierOffset >= 0) |
| 1870 | Indent += Style.AccessModifierOffset; |
| 1871 | if (!InPPDirective || Tok.HasUnescapedNewline) { |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 1872 | Whitespaces.replaceWhitespace(RootToken, Newlines, Indent, 0, Style); |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1873 | } else { |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 1874 | Whitespaces.replacePPWhitespace(RootToken, Newlines, Indent, |
| 1875 | PreviousEndOfLineColumn, Style); |
Manuel Klimek | 3f8c7f3 | 2013-01-10 18:45:26 +0000 | [diff] [blame] | 1876 | } |
| 1877 | return Indent; |
| 1878 | } |
| 1879 | |
Alexander Kornienko | a4ae9f3 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1880 | DiagnosticsEngine &Diag; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1881 | FormatStyle Style; |
| 1882 | Lexer &Lex; |
| 1883 | SourceManager &SourceMgr; |
Daniel Jasper | dcc2a62 | 2013-01-18 08:44:07 +0000 | [diff] [blame^] | 1884 | WhitespaceManager Whitespaces; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1885 | std::vector<CharSourceRange> Ranges; |
Daniel Jasper | 995e820 | 2013-01-14 13:08:07 +0000 | [diff] [blame] | 1886 | std::vector<AnnotatedLine> AnnotatedLines; |
Alexander Kornienko | cff563c | 2012-12-04 17:27:50 +0000 | [diff] [blame] | 1887 | bool StructuralError; |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1888 | }; |
| 1889 | |
| 1890 | tooling::Replacements reformat(const FormatStyle &Style, Lexer &Lex, |
| 1891 | SourceManager &SourceMgr, |
Alexander Kornienko | a4ae9f3 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1892 | std::vector<CharSourceRange> Ranges, |
| 1893 | DiagnosticConsumer *DiagClient) { |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1894 | IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions(); |
Alexander Kornienko | a4ae9f3 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1895 | OwningPtr<DiagnosticConsumer> DiagPrinter; |
| 1896 | if (DiagClient == 0) { |
| 1897 | DiagPrinter.reset(new TextDiagnosticPrinter(llvm::errs(), &*DiagOpts)); |
| 1898 | DiagPrinter->BeginSourceFile(Lex.getLangOpts(), Lex.getPP()); |
| 1899 | DiagClient = DiagPrinter.get(); |
| 1900 | } |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1901 | DiagnosticsEngine Diagnostics( |
Dmitri Gribenko | cfa88f8 | 2013-01-12 19:30:44 +0000 | [diff] [blame] | 1902 | IntrusiveRefCntPtr<DiagnosticIDs>(new DiagnosticIDs()), &*DiagOpts, |
Alexander Kornienko | a4ae9f3 | 2013-01-14 11:34:14 +0000 | [diff] [blame] | 1903 | DiagClient, false); |
Alexander Kornienko | 3048aea | 2013-01-10 15:05:09 +0000 | [diff] [blame] | 1904 | Diagnostics.setSourceManager(&SourceMgr); |
| 1905 | Formatter formatter(Diagnostics, Style, Lex, SourceMgr, Ranges); |
Daniel Jasper | bac016b | 2012-12-03 18:12:45 +0000 | [diff] [blame] | 1906 | return formatter.format(); |
| 1907 | } |
| 1908 | |
Daniel Jasper | 46ef852 | 2013-01-10 13:08:12 +0000 | [diff] [blame] | 1909 | LangOptions getFormattingLangOpts() { |
| 1910 | LangOptions LangOpts; |
| 1911 | LangOpts.CPlusPlus = 1; |
| 1912 | LangOpts.CPlusPlus11 = 1; |
| 1913 | LangOpts.Bool = 1; |
| 1914 | LangOpts.ObjC1 = 1; |
| 1915 | LangOpts.ObjC2 = 1; |
| 1916 | return LangOpts; |
| 1917 | } |
| 1918 | |
Daniel Jasper | cd16238 | 2013-01-07 13:26:07 +0000 | [diff] [blame] | 1919 | } // namespace format |
| 1920 | } // namespace clang |