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